-
Notifications
You must be signed in to change notification settings - Fork 109
docs/cli: Add missing doc pages for src-cli commands #1889
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
marcleblanc2
merged 2 commits into
main
from
cli-refs/search-jobs-debug-snapshot-subcommand-pages
Sep 11, 2026
+684
−340
Merged
Changes from all commits
Commits
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 was deleted.
Oops, something went wrong.
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,37 @@ | ||
| # `src debug compose` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| | Name | Description | Default Value | | ||
| |------|-------------|---------------| | ||
| | `-no-configs` | If true, exclude Sourcegraph configuration files. Defaults to false. | `false` | | ||
| | `-o` | The name of the output zip archive | `debug.zip` | | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
|
|
||
| 'src debug compose' invokes docker cli diagnostic commands targeting a set of containers that are members of a docker-compose network, | ||
| writing an archive file from their returns. | ||
|
|
||
| Usage: | ||
|
|
||
| src debug compose [command options] | ||
|
|
||
| Flags: | ||
|
|
||
| -o Specify the name of the output zip archive. | ||
| --no-configs Don't include Sourcegraph configuration json. | ||
|
|
||
| Examples: | ||
|
|
||
| $ src debug compose -o debug.zip | ||
|
|
||
| $ src -v debug compose -no-configs -o foo.zip | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
|
|
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,9 @@ | ||
| # `src debug` | ||
|
|
||
| ## Subcommands | ||
|
|
||
|
|
||
| * [`compose`](debug/compose) | ||
| * [`kube`](debug/kube) | ||
| * [`server`](debug/server) | ||
|
|
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,40 @@ | ||
| # `src debug kube` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| | Name | Description | Default Value | | ||
| |------|-------------|---------------| | ||
| | `-n` | The namespace passed to kubectl commands, if not specified the 'default' namespace is used | `default` | | ||
| | `-no-configs` | If true, exclude Sourcegraph configuration files. Defaults to false. | `false` | | ||
| | `-o` | The name of the output zip archive | `debug.zip` | | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
|
|
||
| 'src debug kube' invokes kubectl diagnostic commands targeting kubectl's current-context, writing returns to an archive. | ||
|
|
||
| Usage: | ||
|
|
||
| src debug kube [command options] | ||
|
|
||
| Flags: | ||
|
|
||
| -o Specify the name of the output zip archive. | ||
| -n Specify the namespace passed to kubectl commands. If not specified the 'default' namespace is used. | ||
| --no-config Don't include Sourcegraph configuration json. | ||
|
|
||
| Examples: | ||
|
|
||
| $ src debug kube -o debug.zip | ||
|
|
||
| $ src -v debug kube -n ns-sourcegraph -o foo | ||
|
|
||
| $ src debug kube -no-configs -o bar.zip | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
|
|
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,38 @@ | ||
| # `src debug server` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| | Name | Description | Default Value | | ||
| |------|-------------|---------------| | ||
| | `-c` | The container to target | | | ||
| | `-no-configs` | If true, exclude Sourcegraph configuration files. Defaults to false. | `false` | | ||
| | `-o` | The name of the output zip archive | `debug.zip` | | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| ``` | ||
|
|
||
| 'src debug server' invokes docker cli diagnostic commands targeting a Sourcegraph server container, | ||
| and writes an archive file from their returns. | ||
|
|
||
| Usage: | ||
|
|
||
| src debug server [command options] | ||
|
|
||
| Flags: | ||
|
|
||
| -o Specify the name of the output zip archive. | ||
| -no-config Don't include Sourcegraph configuration json. | ||
|
|
||
| Examples: | ||
|
|
||
| $ src debug server -c foo -o debug.zip | ||
|
|
||
| $ src -v debug server --no-configs -c ViktorVaughn -o foo.zip | ||
|
|
||
|
|
||
|
|
||
| ``` | ||
|
|
||
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 was deleted.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -1,37 +1,49 @@ | ||
| # src search-jobs cancel | ||
| # `src search-jobs cancel` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| | Name | Description | Default Value | | ||
| |------|-------------|---------------| | ||
| | `-c` | Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress | `id,username,state,query` | | ||
| | `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | | ||
| | `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` | | ||
| | `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` | | ||
| | `-json` | Output results as JSON for programmatic access | `false` | | ||
| | `-trace` | Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing | `false` | | ||
| | `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | | ||
|
|
||
| <p className="subtitle"> | ||
| `src search-jobs cancel` is a tool that cancels a search job on a | ||
| Sourcegraph instance. | ||
| </p> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| ``` | ||
| Usage of 'src search-jobs cancel': | ||
| -c string | ||
| Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress (default "id,username,state,query") | ||
| Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress (default "id,username,state,query") | ||
| -dump-requests | ||
| Log GraphQL requests and responses to stdout | ||
| Log GraphQL requests and responses to stdout | ||
| -get-curl | ||
| Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | ||
| Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | ||
| -insecure-skip-verify | ||
| Skip validation of TLS certificates against trusted chains | ||
| Skip validation of TLS certificates against trusted chains | ||
| -json | ||
| Output results as JSON for programmatic access | ||
| Output results as JSON for programmatic access | ||
| -trace | ||
| Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | ||
| Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing | ||
| -user-agent-telemetry | ||
| Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) | ||
|
|
||
| Examples: | ||
|
|
||
| Cancel a search job by ID: | ||
|
|
||
| $ src search-jobs cancel U2VhcmNoSm9iOjY5 | ||
|
|
||
| Arguments: | ||
| The ID of the search job to cancel. | ||
| Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) | ||
|
|
||
| Examples: | ||
|
|
||
| Cancel a search job by ID: | ||
|
|
||
| $ src search-jobs cancel U2VhcmNoSm9iOjY5 | ||
|
|
||
| Arguments: | ||
| The ID of the search job to cancel. | ||
|
|
||
| The cancel command stops a running search job and outputs a confirmation message. | ||
|
|
||
|
|
||
| The cancel command stops a running search job and outputs a confirmation message. | ||
| ``` | ||
|
|
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 |
|---|---|---|
| @@ -1,43 +1,55 @@ | ||
| # src search-jobs create | ||
| # `src search-jobs create` | ||
|
|
||
|
|
||
| ## Flags | ||
|
|
||
| | Name | Description | Default Value | | ||
| |------|-------------|---------------| | ||
| | `-c` | Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress | `id,username,state,query` | | ||
| | `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | | ||
| | `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` | | ||
| | `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` | | ||
| | `-json` | Output results as JSON for programmatic access | `false` | | ||
| | `-trace` | Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing | `false` | | ||
| | `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | | ||
|
|
||
| <p className="subtitle"> | ||
| `src search-jobs create` is a tool that creates a search job on a | ||
| Sourcegraph instance. | ||
| </p> | ||
|
|
||
| ## Usage | ||
|
|
||
| ```bash | ||
| ``` | ||
| Usage of 'src search-jobs create': | ||
| -c string | ||
| Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress (default "id,username,state,query") | ||
| Comma-separated list of columns to display. Available: id,query,state,username,createdat,startedat,finishedat,url,logurl,total,completed,failed,inprogress (default "id,username,state,query") | ||
| -dump-requests | ||
| Log GraphQL requests and responses to stdout | ||
| Log GraphQL requests and responses to stdout | ||
| -get-curl | ||
| Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | ||
| Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | ||
| -insecure-skip-verify | ||
| Skip validation of TLS certificates against trusted chains | ||
| Skip validation of TLS certificates against trusted chains | ||
| -json | ||
| Output results as JSON for programmatic access | ||
| Output results as JSON for programmatic access | ||
| -trace | ||
| Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | ||
| Log the trace ID for requests. See https://sourcegraph.com/docs/admin/observability/tracing | ||
| -user-agent-telemetry | ||
| Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) | ||
|
|
||
| Examples: | ||
|
|
||
| Create a search job: | ||
|
|
||
| $ src search-jobs create "repo:^github\.com/sourcegraph/sourcegraph$ sort:indexed-desc" | ||
|
|
||
| Create a search job and display specific columns: | ||
|
|
||
| $ src search-jobs create "repo:sourcegraph" -c id,state,username | ||
|
|
||
| Create a search job and output in JSON format: | ||
|
|
||
| $ src search-jobs create "repo:sourcegraph" -json | ||
| Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) | ||
|
|
||
| Examples: | ||
|
|
||
| Create a search job: | ||
|
|
||
| $ src search-jobs create "repo:^github\.com/sourcegraph/sourcegraph$ sort:indexed-desc" | ||
|
|
||
| Create a search job and display specific columns: | ||
|
|
||
| $ src search-jobs create "repo:sourcegraph" -c id,state,username | ||
|
|
||
| Create a search job and output in JSON format: | ||
|
|
||
| $ src search-jobs create "repo:sourcegraph" -json | ||
|
|
||
| Available columns are: id, query, state, username, createdat, startedat, finishedat, | ||
| url, logurl, total, completed, failed, inprogress | ||
|
|
||
|
|
||
| Available columns are: id, query, state, username, createdat, startedat, finishedat, | ||
| url, logurl, total, completed, failed, inprogress | ||
| ``` | ||
|
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Viktoris not in the dictionary.Did you mean
Victor?Please correct the spelling, or add the word to
cspell-allow-list.txtif it is correct.