-
-
Notifications
You must be signed in to change notification settings - Fork 31
Feat(docs): Improved docs #1082
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
9f2b512
new dooocs
betegon 935590a
fix spotlight run commands
betegon 25cfb4f
fix tail command
betegon e5dd2db
api reference fix
betegon bdf4da4
fix spotlight command
betegon 8187eb8
fix mcp command
betegon 9b24de7
remove attachments event type
betegon 3bbc648
add format references
betegon 43a2ac4
add format references
betegon 5a7d9b4
ndjson
betegon 0b12eff
version for spotlight
betegon b62c910
dynamic port assignment
betegon 8d033a3
run command description
betegon dd44356
small fixes
betegon 27814b7
port dynamically assigned
betegon f7c5c9f
add spotlight dsn
betegon c34409d
http server
betegon 4e6eb5d
remove section
betegon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| --- | ||
| title: Spotlight CLI | ||
| description: Command-line interface for running applications with Spotlight or streaming events in real-time | ||
| sidebar: | ||
| order: 0 | ||
| --- | ||
|
|
||
| import { LinkCard, CardGrid } from '@astrojs/starlight/components'; | ||
|
|
||
| The Spotlight CLI (`spotlight-sidecar`) provides two modes for working with Spotlight in your terminal: | ||
|
|
||
| ## Two Modes of Operation | ||
|
|
||
| <CardGrid> | ||
| <LinkCard | ||
| title="Run Command" | ||
| href="/docs/cli/run/" | ||
| description="Wrap your application to automatically capture telemetry data with Spotlight" | ||
| /> | ||
| <LinkCard | ||
| title="Tail Command" | ||
| href="/docs/cli/tail/" | ||
| description="Stream and filter Spotlight events in real-time from your terminal" | ||
| /> | ||
| </CardGrid> | ||
|
|
||
| ## Quick Reference | ||
|
|
||
| - [Complete CLI Reference](/docs/cli/reference/) - All commands and options | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.