diff --git a/docs/cli/references/admin.mdx b/docs/cli/references/admin.mdx deleted file mode 100644 index 54d7a2ee9..000000000 --- a/docs/cli/references/admin.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# `src admin` - - - -## Usage - -``` -'src admin' is a tool that manages an initial admin user on a new Sourcegraph instance. - -Usage: - - src admin create [command options] - -The commands are: - - create create an initial admin user - -Use "src admin [command] -h" for more information about a command. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/auth.mdx b/docs/cli/references/auth.mdx deleted file mode 100644 index eb5d3834e..000000000 --- a/docs/cli/references/auth.mdx +++ /dev/null @@ -1,22 +0,0 @@ -# `src auth` - - - -## Usage - -``` -'src auth' provides authentication-related helper commands. - -Usage: - - src auth command [command options] - -The commands are: - - token prints the current authentication token - -Use "src auth [command] -h" for more information about a command. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/codeowners.mdx b/docs/cli/references/codeowners.mdx deleted file mode 100644 index 2ef49362e..000000000 --- a/docs/cli/references/codeowners.mdx +++ /dev/null @@ -1,25 +0,0 @@ -# `src codeowners` - - - -## Usage - -``` -'src codeowners' is a tool that manages ingested code ownership data in a Sourcegraph instance. - -Usage: - - src codeowners command [command options] - -The commands are: - - get returns the codeowners file for a repository, if exists - create create a codeowners file - update update a codeowners file - delete delete a codeowners file - -Use "src codeowners [command] -h" for more information about a command. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/extensions/copy.mdx b/docs/cli/references/extensions/copy.mdx deleted file mode 100644 index 069d8d042..000000000 --- a/docs/cli/references/extensions/copy.mdx +++ /dev/null @@ -1,40 +0,0 @@ -# `src extensions copy` - - -## Flags - -| Name | Description | Default Value | -|------|-------------|---------------| -| `-current-user` | The current user | | -| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | -| `-extension-id` | The <extID> in https://sourcegraph.com/extensions/<extID> (e.g. sourcegraph/java) | | -| `-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` | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | - - -## Usage - -``` -Usage of 'src extensions copy': - -current-user string - The current user - -dump-requests - Log GraphQL requests and responses to stdout - -extension-id string - The in https://sourcegraph.com/extensions/ (e.g. sourcegraph/java) - -get-curl - 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 - -trace - Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing - -user-agent-telemetry - Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) - -Copy an extension from Sourcegraph.com to your private registry. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/extensions/delete.mdx b/docs/cli/references/extensions/delete.mdx deleted file mode 100644 index 2222034c8..000000000 --- a/docs/cli/references/extensions/delete.mdx +++ /dev/null @@ -1,46 +0,0 @@ -# `src extensions delete` - - -## Flags - -| Name | Description | Default Value | -|------|-------------|---------------| -| `-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` | -| `-id` | The ID (GraphQL API ID, not extension ID) of the extension to delete. | | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | - - -## Usage - -``` -Usage of 'src extensions delete': - -dump-requests - 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!) - -id string - The ID (GraphQL API ID, not extension ID) of the extension to delete. - -insecure-skip-verify - Skip validation of TLS certificates against trusted chains - -trace - Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing - -user-agent-telemetry - Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) - -Examples: - - Delete the extension by ID (GraphQL API ID, not extension ID): - - $ src extensions delete -id=UmVnaXN0cnlFeHRlbnNpb246... - - Delete the extension with extension ID "alice/myextension": - - $ src extensions delete -id=$(src extensions get -f '{{.ID}}' -extension-id=alice/myextension) - - - -``` - \ No newline at end of file diff --git a/docs/cli/references/extensions/get.mdx b/docs/cli/references/extensions/get.mdx deleted file mode 100644 index 935ce9ffd..000000000 --- a/docs/cli/references/extensions/get.mdx +++ /dev/null @@ -1,46 +0,0 @@ -# `src extensions get` - - -## Flags - -| Name | Description | Default Value | -|------|-------------|---------------| -| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | -| `-extension-id` | Look up extension by extension ID. (e.g. "alice/myextension") | | -| `-f` | Format for the output, using the syntax of Go package text/template. (e.g. "\{\{.ExtensionID\}\}: \{\{.Manifest.Title\}\} (\{\{.RemoteURL\}\})" or "\{\{.\|json\}\}") | `{{.\|json}}` | -| `-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` | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | - - -## Usage - -``` -Usage of 'src extensions get': - -dump-requests - Log GraphQL requests and responses to stdout - -extension-id string - Look up extension by extension ID. (e.g. "alice/myextension") - -f string - Format for the output, using the syntax of Go package text/template. (e.g. "{{.ExtensionID}}: {{.Manifest.Title}} ({{.RemoteURL}})" or "{{.|json}}") (default "{{.|json}}") - -get-curl - 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 - -trace - Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing - -user-agent-telemetry - Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) - -Examples: - - Get extension with extension ID "alice/myextension": - - $ src extensions get alice/myextension - $ src extensions get -extension-id=alice/myextension - - - -``` - \ No newline at end of file diff --git a/docs/cli/references/extensions/index.mdx b/docs/cli/references/extensions/index.mdx deleted file mode 100644 index ff9d8ff68..000000000 --- a/docs/cli/references/extensions/index.mdx +++ /dev/null @@ -1,11 +0,0 @@ -# `src extensions` - -## Subcommands - - -* [`copy`](extensions/copy) -* [`delete`](extensions/delete) -* [`get`](extensions/get) -* [`list`](extensions/list) -* [`publish`](extensions/publish) - \ No newline at end of file diff --git a/docs/cli/references/extensions/list.mdx b/docs/cli/references/extensions/list.mdx deleted file mode 100644 index 093295a01..000000000 --- a/docs/cli/references/extensions/list.mdx +++ /dev/null @@ -1,56 +0,0 @@ -# `src extensions list` - - -## Flags - -| Name | Description | Default Value | -|------|-------------|---------------| -| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | -| `-f` | Format for the output, using the syntax of Go package text/template. (e.g. "\{\{.ExtensionID\}\}: \{\{.Manifest.Description\}\} (\{\{.RemoteURL\}\})" or "\{\{.\|json\}\}") | `{{.ExtensionID}}` | -| `-first` | Returns the first n extensions from the list. (use -1 for unlimited) | `1000` | -| `-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` | -| `-query` | Returns extensions whose extension IDs match the query. (e.g. "myextension") | | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | - - -## Usage - -``` -Usage of 'src extensions list': - -dump-requests - Log GraphQL requests and responses to stdout - -f string - Format for the output, using the syntax of Go package text/template. (e.g. "{{.ExtensionID}}: {{.Manifest.Description}} ({{.RemoteURL}})" or "{{.|json}}") (default "{{.ExtensionID}}") - -first int - Returns the first n extensions from the list. (use -1 for unlimited) (default 1000) - -get-curl - 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 - -query string - Returns extensions whose extension IDs match the query. (e.g. "myextension") - -trace - Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing - -user-agent-telemetry - Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) - -Examples: - - List extensions: - - $ src extensions list - - List extensions whose names match the query: - - $ src extensions list -query='myquery' - - List *all* extensions (may be slow!): - - $ src extensions list -first='-1' - - - -``` - \ No newline at end of file diff --git a/docs/cli/references/extensions/publish.mdx b/docs/cli/references/extensions/publish.mdx deleted file mode 100644 index 938695278..000000000 --- a/docs/cli/references/extensions/publish.mdx +++ /dev/null @@ -1,69 +0,0 @@ -# `src extensions publish` - - -## Flags - -| Name | Description | Default Value | -|------|-------------|---------------| -| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` | -| `-extension-id` | Override the extension ID in the manifest. (default: read from -manifest file) | | -| `-force` | Force publish the extension, even if there are validation problems or other warnings. | `false` | -| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` | -| `-git-head` | Override the current git commit for the bundle. (default: uses `git rev-parse head`) | | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` | -| `-manifest` | The extension manifest file. | `package.json` | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` | -| `-url` | Override the URL for the bundle. (example: set to http://localhost:1234/myext.js for local dev with parcel) | | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` | - - -## Usage - -``` -Usage of 'src extensions publish': - -dump-requests - Log GraphQL requests and responses to stdout - -extension-id string - Override the extension ID in the manifest. (default: read from -manifest file) - -force - Force publish the extension, even if there are validation problems or other warnings. - -get-curl - Print the curl command for executing this query and exit (WARNING: includes printing your access token!) - -git-head git rev-parse head - Override the current git commit for the bundle. (default: uses git rev-parse head) - -insecure-skip-verify - Skip validation of TLS certificates against trusted chains - -manifest string - The extension manifest file. (default "package.json") - -trace - Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing - -url string - Override the URL for the bundle. (example: set to http://localhost:1234/myext.js for local dev with parcel) - -user-agent-telemetry - Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default true) - -Publish an extension to Sourcegraph, creating it (if necessary). - -Examples: - - Publish the "alice/myextension" extension described by package.json in the current directory: - - $ cat package.json - { - "name": "myextension", - "publisher": "alice", - "title": "My Extension", - "main": "dist/myext.js", - "scripts": {"sourcegraph:prepublish": "parcel build --out-file dist/myext.js src/myext.ts"} - } - $ src extensions publish - -Notes: - - Source maps are supported (for easier debugging of extensions). If the main JavaScript bundle is "dist/myext.js", - it looks for a source map in "dist/myext.map". - - - -``` - \ No newline at end of file diff --git a/docs/cli/references/lsif.mdx b/docs/cli/references/lsif.mdx deleted file mode 100644 index 4a49de9c2..000000000 --- a/docs/cli/references/lsif.mdx +++ /dev/null @@ -1,14 +0,0 @@ -# `src lsif` - - - -## Usage - -``` -[DEPRECATED] 'src lsif' is a tool that manages LSIF data on a Sourcegraph instance. - -Use 'src code-intel' instead. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/prompts.mdx b/docs/cli/references/prompts.mdx deleted file mode 100644 index 0dbcd27c0..000000000 --- a/docs/cli/references/prompts.mdx +++ /dev/null @@ -1,40 +0,0 @@ -# src prompts - -

- `src prompts` is a tool that manages prompt library prompts and tags in a - Sourcegraph instance. -

- -## Usage - -``` -'src prompts' is a tool that manages prompt library prompts and tags in a Sourcegraph instance. - -Usage: - - src prompts command [command options] - -The commands are: - - list lists prompts - get get a prompt by ID - create create a prompt - update update a prompt - delete delete a prompt - export export prompts to a JSON file - import import prompts from a JSON file - tags manage prompt tags (use "src prompts tags [command] -h" for more info) - -Use "src prompts [command] -h" for more information about a command. -``` - -## Sub-commands - -- [list](prompts/list) -- [get](prompts/get) -- [create](prompts/create) -- [update](prompts/update) -- [delete](prompts/delete) -- [export](prompts/export) -- [import](prompts/import) -- [tags](prompts/tags) diff --git a/docs/cli/references/prompts/create.mdx b/docs/cli/references/prompts/create.mdx deleted file mode 100644 index a68d6e23c..000000000 --- a/docs/cli/references/prompts/create.mdx +++ /dev/null @@ -1,81 +0,0 @@ -# src prompts create - -Create a new prompt in your Sourcegraph instance. - -## Usage - -```bash -src prompts create [flags] -``` - -## Examples - -```bash -# Create a basic prompt (uses current user as owner) -src prompts create \ - -name="go-error-handling" \ - -description="Best practices for Go error handling" \ - -content="Write a Go function that properly handles errors..." - -# Create a prompt with tags -src prompts create \ - -name="python-optimization" \ - -description="Python performance optimization tips" \ - -content="Optimize this Python code for better performance..." \ - -tags="UHJvbXB0VGFnOjE=,UHJvbXB0VGFnOjI=" - -# Create a draft prompt -src prompts create \ - -name="draft-prompt" \ - -description="Work in progress prompt" \ - -content="This prompt is still being developed..." \ - -draft - -# Create a recommended prompt with auto-submit -src prompts create \ - -name="recommended-prompt" \ - -description="A recommended prompt for common use" \ - -content="This is a recommended prompt..." \ - -recommended \ - -auto-submit - -# Create a secret prompt for INSERT mode -src prompts create \ - -name="secret-insert-prompt" \ - -description="Secret prompt for code insertion" \ - -content="Insert code here..." \ - -visibility="SECRET" \ - -mode="INSERT" - -# Create a prompt with explicit owner (optional) -src prompts create \ - -name="team-shared-prompt" \ - -description="A prompt shared with a specific owner" \ - -content="This prompt has an explicit owner..." \ - -owner="VXNlcjox" -``` - -## Flags - -| Flag | Description | -| -------------- | --------------------------------------------------------------------------------- | -| `-name` | The prompt name (required) | -| `-description` | Description of the prompt (required) | -| `-content` | The prompt template text content (required) | -| `-owner` | The ID of the owner (user or organization) (optional, defaults to current user) | -| `-tags` | Comma-separated list of tag IDs | -| `-draft` | Whether the prompt is a draft (default: false) | -| `-visibility` | Visibility of the prompt: PUBLIC or SECRET (default: "PUBLIC") | -| `-auto-submit` | Whether the prompt should be automatically executed in one click (default: false) | -| `-mode` | Mode to execute prompt: CHAT, EDIT, or INSERT (default: "CHAT") | -| `-recommended` | Whether the prompt is recommended (default: false) | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/delete.mdx b/docs/cli/references/prompts/delete.mdx deleted file mode 100644 index c7fb02446..000000000 --- a/docs/cli/references/prompts/delete.mdx +++ /dev/null @@ -1,32 +0,0 @@ -# src prompts delete - -Delete a prompt from your Sourcegraph instance. - -## Usage - -```bash -src prompts delete -``` - -## Examples - -```bash -# Delete a prompt by ID -src prompts delete UHJvbXB0OjE= - -# The command will confirm successful deletion -src prompts delete UHJvbXB0OjE= -# Output: Prompt deleted successfully. -``` - -## Flags - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/export.mdx b/docs/cli/references/prompts/export.mdx deleted file mode 100644 index 0d97b69f6..000000000 --- a/docs/cli/references/prompts/export.mdx +++ /dev/null @@ -1,46 +0,0 @@ -# src prompts export - -Export prompts to a JSON file. - -## Usage - -```bash -src prompts export [flags] -``` - -## Examples - -```bash -# Export all prompts to stdout -src prompts export - -# Export all prompts to a file -src prompts export -o prompts-backup.json - -# Export with pretty formatting -src prompts export -o prompts-backup.json -format=pretty - -# Export prompts with specific tags -src prompts export -o go-prompts.json -tags="go,golang" - -# Export prompts with multiple tag filters -src prompts export -o filtered-prompts.json -tags="python,data-science,ml" -``` - -## Flags - -| Flag | Description | -| --------- | ------------------------------------------------------- | -| `-o` | Output file path (defaults to stdout if not specified) | -| `-tags` | Comma-separated list of tag names to filter by | -| `-format` | JSON format: 'pretty' or 'compact' (default: 'compact') | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/get.mdx b/docs/cli/references/prompts/get.mdx deleted file mode 100644 index 0d2a5f1c2..000000000 --- a/docs/cli/references/prompts/get.mdx +++ /dev/null @@ -1,28 +0,0 @@ -# src prompts get - -Get details about a specific prompt by ID. - -## Usage - -```bash -src prompts get -``` - -## Examples - -```bash -# Get prompt by ID -src prompts get UHJvbXB0OjE= -``` - -## Flags - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/import.mdx b/docs/cli/references/prompts/import.mdx deleted file mode 100644 index f6ae4af3e..000000000 --- a/docs/cli/references/prompts/import.mdx +++ /dev/null @@ -1,47 +0,0 @@ -# src prompts import - -Import prompts from a JSON file. - -## Usage - -```bash -src prompts import [flags] -``` - -## Examples - -```bash -# Import prompts from a file (uses current user as owner) -src prompts import -i prompts.json - -# Import prompts with a specific owner -src prompts import -i prompts.json -owner="VXNlcjox" - -# Perform a dry run without creating any prompts -src prompts import -i prompts.json -dry-run - -# Skip existing prompts with the same name -src prompts import -i prompts.json -skip-existing - -# Combine flags for validation and skipping -src prompts import -i prompts.json -dry-run -skip-existing -``` - -## Flags - -| Flag | Description | -| ---------------- | ----------------------------------------------------------------------- | -| `-i` | Input file path (required) | -| `-owner` | The ID of the owner for all imported prompts (defaults to current user) | -| `-dry-run` | Validate without importing | -| `-skip-existing` | Skip prompts that already exist (based on name) | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/list.mdx b/docs/cli/references/prompts/list.mdx deleted file mode 100644 index a8ae516ec..000000000 --- a/docs/cli/references/prompts/list.mdx +++ /dev/null @@ -1,79 +0,0 @@ -# src prompts list - -List all prompts in your Sourcegraph instance. - -## Usage - -```bash -src prompts list [flags] -``` - -## Examples - -```bash -# List all prompts -src prompts list - -# Search prompts by name, description, or content -src prompts list -query="error handling" - -# Filter prompts by tag IDs -src prompts list -tags="UHJvbXB0VGFnOjE=,UHJvbXB0VGFnOjI=" - -# List prompts for a specific owner -src prompts list -owner="VXNlcjox" - -# List only recommended prompts -src prompts list -recommended-only - -# List built-in prompts only -src prompts list -builtin-only - -# Include built-in prompts with user prompts -src prompts list -include-builtin - -# Exclude draft prompts -src prompts list -include-drafts=false - -# List prompts owned by viewer or their organizations -src prompts list -affiliated - -# Paginate through results -src prompts list -limit=10 -after="cursor" - -# Select specific columns to display -src prompts list -c id,name,description,visibility - -# Output results as JSON -src prompts list -json - -# Complex filtering example -src prompts list -query="Go" -recommended-only -include-drafts=false -json -``` - -## Flags - -| Flag | Description | -| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `-query` | Search prompts by name, description, or content | -| `-owner` | Filter by prompt owner (a namespace, either a user or organization) | -| `-tags` | Comma-separated list of tag IDs to filter by | -| `-affiliated` | Filter to only prompts owned by the viewer or viewer's organizations | -| `-recommended-only` | Whether to include only recommended prompts | -| `-builtin-only` | Whether to include only builtin prompts | -| `-include-builtin` | Whether to include builtin prompts | -| `-include-drafts` | Whether to include draft prompts (default: true) | -| `-limit` | Maximum number of prompts to list (default: 100) | -| `-after` | Cursor for pagination (from previous page's endCursor) | -| `-c` | Comma-separated list of columns to display. Available: id,name,description,draft,visibility,mode,tags (default: "id,name,visibility,tags") | -| `-json` | Output results as JSON for programmatic access | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/tags.mdx b/docs/cli/references/prompts/tags.mdx deleted file mode 100644 index b2ce98d7a..000000000 --- a/docs/cli/references/prompts/tags.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# src prompts tags - -`src prompts tags` is a tool that manages prompt tags in a Sourcegraph instance. - -## Usage - -``` -'src prompts tags' is a tool that manages prompt tags in a Sourcegraph instance. - -Usage: - - src prompts tags command [command options] - -The commands are: - - list lists prompt tags - get get a prompt tag by name - create create a prompt tag - update update a prompt tag - delete delete a prompt tag - -Use "src prompts tags [command] -h" for more information about a command. -``` - -## Available Commands - -- [`src prompts tags list`](./tags/list) - lists prompt tags -- [`src prompts tags get`](./tags/get) - get a prompt tag by name -- [`src prompts tags create`](./tags/create) - create a prompt tag -- [`src prompts tags update`](./tags/update) - update a prompt tag -- [`src prompts tags delete`](./tags/delete) - delete a prompt tag diff --git a/docs/cli/references/prompts/tags/create.mdx b/docs/cli/references/prompts/tags/create.mdx deleted file mode 100644 index b6d618ec4..000000000 --- a/docs/cli/references/prompts/tags/create.mdx +++ /dev/null @@ -1,38 +0,0 @@ -# src prompts tags create - -Create a new tag for prompts. - -## Usage - -```bash -src prompts tags create -``` - -## Examples - -```bash -# Create a new tag -src prompts tags create go - -# Create a tag with hyphen -src prompts tags create machine-learning - -# Create a tag for Python -src prompts tags create python -``` - -## Flags - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | - -## Notes - -If a tag with this name already exists, the command will return the existing tag's ID. diff --git a/docs/cli/references/prompts/tags/delete.mdx b/docs/cli/references/prompts/tags/delete.mdx deleted file mode 100644 index 66b1b19b0..000000000 --- a/docs/cli/references/prompts/tags/delete.mdx +++ /dev/null @@ -1,32 +0,0 @@ -# src prompts tags delete - -Delete a tag from your Sourcegraph instance. - -## Usage - -```bash -src prompts tags delete -``` - -## Examples - -```bash -# Delete a tag by ID -src prompts tags delete UHJvbXB0VGFnOjE= - -# The command will confirm successful deletion -src prompts tags delete UHJvbXB0VGFnOjE= -# Output: Prompt tag deleted successfully. -``` - -## Flags - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/tags/get.mdx b/docs/cli/references/prompts/tags/get.mdx deleted file mode 100644 index f6acfdafd..000000000 --- a/docs/cli/references/prompts/tags/get.mdx +++ /dev/null @@ -1,31 +0,0 @@ -# src prompts tags get - -Get details about a specific tag by name. - -## Usage - -```bash -src prompts tags get -``` - -## Examples - -```bash -# Get tag by name -src prompts tags get go - -# Get tag details for machine learning -src prompts tags get machine-learning -``` - -## Flags - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/tags/list.mdx b/docs/cli/references/prompts/tags/list.mdx deleted file mode 100644 index f73fb7467..000000000 --- a/docs/cli/references/prompts/tags/list.mdx +++ /dev/null @@ -1,51 +0,0 @@ -# src prompts tags list - -List all tags in your Sourcegraph instance. - -## Usage - -```bash -src prompts tags list [flags] -``` - -## Examples - -```bash -# List all tags -src prompts tags list - -# Search for tags by name -src prompts tags list -query="go" - -# Paginate through results -src prompts tags list -limit=10 -after="cursor" - -# Select specific columns to display -src prompts tags list -c id,name - -# Output results as JSON -src prompts tags list -json - -# Combine search and pagination -src prompts tags list -query="python" -limit=5 -``` - -## Flags - -| Flag | Description | -| -------- | ----------------------------------------------------------------------------------- | -| `-query` | Search prompt tags by name | -| `-limit` | Maximum number of tags to list (default: 100) | -| `-after` | Cursor for pagination (from previous page's endCursor) | -| `-c` | Comma-separated list of columns to display. Available: id,name (default: "id,name") | -| `-json` | Output results as JSON for programmatic access | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/tags/update.mdx b/docs/cli/references/prompts/tags/update.mdx deleted file mode 100644 index c47ce8c9e..000000000 --- a/docs/cli/references/prompts/tags/update.mdx +++ /dev/null @@ -1,35 +0,0 @@ -# src prompts tags update - -Update an existing tag in your Sourcegraph instance. - -## Usage - -```bash -src prompts tags update [flags] -``` - -## Examples - -```bash -# Update a tag's name -src prompts tags update -name="updated-tag-name" UHJvbXB0VGFnOjE= - -# Update to a different name -src prompts tags update -name="golang-updated" UHJvbXB0VGFnOjE= -``` - -## Flags - -| Flag | Description | -| ------- | ------------------------ | -| `-name` | The new name for the tag | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/prompts/update.mdx b/docs/cli/references/prompts/update.mdx deleted file mode 100644 index fd609bc5f..000000000 --- a/docs/cli/references/prompts/update.mdx +++ /dev/null @@ -1,69 +0,0 @@ -# src prompts update - -Update an existing prompt in your Sourcegraph instance. - -## Usage - -```bash -src prompts update [flags] -``` - -## Examples - -```bash -# Update a prompt's basic information -src prompts update \ - -name="updated-prompt-name" \ - -description="Updated description" \ - -content="Updated prompt content" \ - UHJvbXB0OjE= - -# Update a prompt with new tags -src prompts update \ - -name="prompt-with-new-tags" \ - -description="Updated description" \ - -content="Updated content" \ - -tags="UHJvbXB0VGFnOjE=,UHJvbXB0VGFnOjI=" \ - UHJvbXB0OjE= - -# Update prompt to draft status -src prompts update \ - -name="draft-prompt" \ - -description="Now a draft" \ - -content="Work in progress content" \ - -draft \ - UHJvbXB0OjE= - -# Update prompt settings -src prompts update \ - -name="auto-submit-prompt" \ - -description="Auto-submit enabled" \ - -content="This prompt auto-submits" \ - -auto-submit \ - -recommended \ - -mode="EDIT" \ - UHJvbXB0OjE= -``` - -## Flags - -| Flag | Description | -| -------------- | ---------------------------------------------------------------- | -| `-name` | The updated prompt name | -| `-description` | Updated description of the prompt | -| `-content` | The updated prompt template text content | -| `-tags` | Comma-separated list of tag IDs (replaces existing tags) | -| `-draft` | Whether the prompt is a draft | -| `-auto-submit` | Whether the prompt should be automatically executed in one click | -| `-mode` | Mode to execute prompt: CHAT, EDIT, or INSERT (default: "CHAT") | -| `-recommended` | Whether the prompt is recommended | - -### API flags - -| Flag | Description | -| ----------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `-dump-requests` | 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!) | -| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | -| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | -| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph (default: true) | diff --git a/docs/cli/references/sbom.mdx b/docs/cli/references/sbom.mdx deleted file mode 100644 index 76dd910b3..000000000 --- a/docs/cli/references/sbom.mdx +++ /dev/null @@ -1,20 +0,0 @@ -# `src sbom` - - - -## Usage - -``` -'src sbom' fetches and verifies SBOM (Software Bill of Materials) data for Sourcegraph containers. - -Usage: - - src sbom command [command options] - -The commands are: - - fetch fetch SBOMs for a released version of Sourcegraph - - -``` - \ No newline at end of file diff --git a/docs/cli/references/scout.mdx b/docs/cli/references/scout.mdx deleted file mode 100644 index 3932162c7..000000000 --- a/docs/cli/references/scout.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# `src scout` - - - -## Usage - -``` -'src scout' is a tool that provides monitoring for Sourcegraph resources - - EXPERIMENTAL: 'scout' is an experimental command in the 'src' tool. To use, you must - point your .kube config to your Sourcegraph instance. - - Usage: - - src scout command [command options] - - The commands are: - - resource print all known sourcegraph resources and their allocations - usage get CPU, memory and current disk usage - advise recommend lowering or raising resource allocations based on actual usage - - Use "src scout [command] -h" for more information about a command. - - -``` - \ No newline at end of file diff --git a/docs/cli/references/signature.mdx b/docs/cli/references/signature.mdx deleted file mode 100644 index a335f9ca9..000000000 --- a/docs/cli/references/signature.mdx +++ /dev/null @@ -1,20 +0,0 @@ -# `src signature` - - - -## Usage - -``` -'src signature' verifies published signatures for Sourcegraph containers. - -Usage: - - src signature command [command options] - -The commands are: - - verify verify signatures for a Sourcegraph release - - -``` - \ No newline at end of file diff --git a/docs/cli/references/validate.mdx b/docs/cli/references/validate.mdx deleted file mode 100644 index 47cc1d4f3..000000000 --- a/docs/cli/references/validate.mdx +++ /dev/null @@ -1,27 +0,0 @@ -# `src validate` - - - -## Usage - -``` -'src validate' is a tool that validates a Sourcegraph instance. - -EXPERIMENTAL: 'validate' is an experimental command in the 'src' tool. - -Please visit https://docs.sourcegraph.com/admin/validation for documentation of the validate command. - -Usage: - - src validate command [command options] - -The commands are: - - install validates a Sourcegraph installation - kube validates a Sourcegraph deployment on a Kubernetes cluster - -Use "src validate [command] -h" for more information about a command. - - -``` - \ No newline at end of file