Skip to content

🤖 Sync generated docs from sourcegraph/sourcegraph (2025-11-25/13-35-46) #1444

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.

Sign up for GitHub

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
burmudar merged 1 commit into from
Nov 25, 2025
Merged

🤖 Sync generated docs from sourcegraph/sourcegraph (2025-11-25/13-35-46) #1444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4,220 changes: 1,529 additions & 2,691 deletions docs/admin/observability/alerts.mdx
View file
Open in desktop

Large diffs are not rendered by default.

10,455 changes: 2,019 additions & 8,436 deletions docs/admin/observability/dashboards.mdx
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 4 additions & 1 deletion docs/cli/references/admin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# `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:
Expand All @@ -17,3 +19,4 @@ Use "src admin [command] -h" for more information about a command.


```

21 changes: 12 additions & 9 deletions docs/cli/references/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# `src api`


## 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` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
| `-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` |
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |
| 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` |
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
| `-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` |
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |


## Usage

Expand Down Expand Up @@ -58,3 +60,4 @@ Examples:


```

55 changes: 29 additions & 26 deletions docs/cli/references/batch/apply.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,35 @@
# `src batch apply`


## Flags

| Name | Description | Default Value |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| `-allow-unsupported` | Allow unsupported code hosts. | `false` |
| `-apply` | Ignored. | `false` |
| `-cache` | Directory for caching results and repository archives. | `~/.cache/sourcegraph/batch` |
| `-clean-archives` | If true, deletes downloaded repository archives after executing batch spec steps. Note that only the archives related to the actual repositories matched by the batch spec will be cleaned up, and clean up will not occur if src exits unexpectedly. | `true` |
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The batch spec file to read, or - to read from standard input. | |
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `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` |
| `-j` | The maximum number of parallel jobs. Default (or 0) is the number of CPU cores available to Docker. | `0` |
| `-keep-logs` | Retain logs after executing steps. | `false` |
| `-n` | Alias for -namespace. | |
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
| `-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` |
| `-v` | print verbose output | `false` |
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
| Name | Description | Default Value |
|------|-------------|---------------|
| `-allow-unsupported` | Allow unsupported code hosts. | `false` |
| `-apply` | Ignored. | `false` |
| `-cache` | Directory for caching results and repository archives. | `~/.cache/sourcegraph/batch` |
| `-clean-archives` | If true, deletes downloaded repository archives after executing batch spec steps. Note that only the archives related to the actual repositories matched by the batch spec will be cleaned up, and clean up will not occur if src exits unexpectedly. | `true` |
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The batch spec file to read, or - to read from standard input. | |
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `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` |
| `-j` | The maximum number of parallel jobs. Default (or 0) is the number of CPU cores available to Docker. | `0` |
| `-keep-logs` | Retain logs after executing steps. | `false` |
| `-n` | Alias for -namespace. | |
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data, such as log files. Default is /tmp. Can also be set with environment variable SRC_BATCH_TMP_DIR; if both are set, this flag will be used and not the environment variable. | `/tmp` |
| `-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` |
| `-v` | print verbose output | `false` |
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |


## Usage

Expand Down Expand Up @@ -100,3 +102,4 @@ Examples:


```

21 changes: 12 additions & 9 deletions docs/cli/references/batch/exec.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# `src batch exec`


## Flags

| Name | Description | Default Value |
| -------------------- | -------------------------------------------------------------------------------------------------------------- | ------------- |
| `-binaryDiffs` | Whether to encode diffs as base64. | `false` |
| `-f` | The workspace execution input file to read. | |
| `-repo` | Path of the checked out repo on disk. | |
| `-run-as-image-user` | True to run step containers as the default image user; if false or omitted, containers are always run as root. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data. | |
| `-workspaceFiles` | Path of workspace files on disk. | |
| Name | Description | Default Value |
|------|-------------|---------------|
| `-binaryDiffs` | Whether to encode diffs as base64. | `false` |
| `-f` | The workspace execution input file to read. | |
| `-repo` | Path of the checked out repo on disk. | |
| `-run-as-image-user` | True to run step containers as the default image user; if false or omitted, containers are always run as root. | `false` |
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
| `-tmp` | Directory for storing temporary data. | |
| `-workspaceFiles` | Path of workspace files on disk. | |


## Usage

Expand Down Expand Up @@ -47,3 +49,4 @@ Examples:


```

16 changes: 9 additions & 7 deletions docs/cli/references/batch/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

## Subcommands

- [`apply`](batch/apply)
- [`exec`](batch/exec)
- [`new`](batch/new)
- [`preview`](batch/preview)
- [`remote`](batch/remote)
- [`repositories`](batch/repositories)
- [`validate`](batch/validate)

* [`apply`](batch/apply)
* [`exec`](batch/exec)
* [`new`](batch/new)
* [`preview`](batch/preview)
* [`remote`](batch/remote)
* [`repositories`](batch/repositories)
* [`validate`](batch/validate)

21 changes: 12 additions & 9 deletions docs/cli/references/batch/new.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# `src batch new`


## Flags

| Name | Description | Default Value |
| ----------------------- | -------------------------------------------------------------------------------------------------------- | ------------- |
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
| `-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` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `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` |
| Name | Description | Default Value |
|------|-------------|---------------|
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
| `-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` |
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `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

Expand Down Expand Up @@ -46,3 +48,4 @@ Examples:


```

Loading