Skip to content

Commit 2d929b5

Browse files
sourcegraph-buildkitebuildkite-at-sourcegraph
sourcegraph-buildkite
and
buildkite-at-sourcegraph
authored
🤖 Sync generated docs from sourcegraph/sourcegraph (2025-11-25/13-35-46) (#1444)
This is an automated pull request, created by //doc:generated:push on sourcegraph/sourcegraph Co-authored-by: Buildkite <[email protected]>
1 parent 4e62056 commit 2d929b5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+4240
-11650
lines changed

‎docs/admin/observability/alerts.mdx‎

Lines changed: 1529 additions & 2691 deletions
Large diffs are not rendered by default.

‎docs/admin/observability/dashboards.mdx‎

Lines changed: 2019 additions & 8436 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/cli/references/admin.mdx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# `src admin`
22

3+
4+
35
## Usage
46

57
```
68
'src admin' is a tool that manages an initial admin user on a new Sourcegraph instance.
79
810
Usage:
9-
11+
1012
src admin create [command options]
1113
1214
The commands are:
@@ -17,3 +19,4 @@ Use "src admin [command] -h" for more information about a command.
1719
1820
1921
```
22+

‎docs/cli/references/api.mdx‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# `src api`
22

3+
34
## Flags
45

5-
| Name | Description | Default Value |
6-
| ----------------------- | -------------------------------------------------------------------------------------------------------- | ------------- |
7-
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
8-
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
9-
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
10-
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
11-
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
12-
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
13-
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |
6+
| Name | Description | Default Value |
7+
|------|-------------|---------------|
8+
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
9+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
10+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
11+
| `-query` | GraphQL query to execute, e.g. 'query \{ currentUser \{ username \} \}' (stdin otherwise) | |
12+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
13+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
14+
| `-vars` | GraphQL query variables to include as JSON string, e.g. '\{"var": "val", "var2": "val2"\}' | |
15+
1416

1517
## Usage
1618

@@ -58,3 +60,4 @@ Examples:
5860
5961
6062
```
63+

‎docs/cli/references/batch/apply.mdx‎

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
11
# `src batch apply`
22

3+
34
## Flags
45

5-
| Name | Description | Default Value |
6-
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
7-
| `-allow-unsupported` | Allow unsupported code hosts. | `false` |
8-
| `-apply` | Ignored. | `false` |
9-
| `-cache` | Directory for caching results and repository archives. | `~/.cache/sourcegraph/batch` |
10-
| `-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` |
11-
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
12-
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
13-
| `-f` | The batch spec file to read, or - to read from standard input. | |
14-
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
15-
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
16-
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
17-
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
18-
| `-j` | The maximum number of parallel jobs. Default (or 0) is the number of CPU cores available to Docker. | `0` |
19-
| `-keep-logs` | Retain logs after executing steps. | `false` |
20-
| `-n` | Alias for -namespace. | |
21-
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
22-
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
23-
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
24-
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
25-
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
26-
| `-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` |
27-
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
28-
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
29-
| `-v` | print verbose output | `false` |
30-
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
6+
| Name | Description | Default Value |
7+
|------|-------------|---------------|
8+
| `-allow-unsupported` | Allow unsupported code hosts. | `false` |
9+
| `-apply` | Ignored. | `false` |
10+
| `-cache` | Directory for caching results and repository archives. | `~/.cache/sourcegraph/batch` |
11+
| `-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` |
12+
| `-clear-cache` | If true, clears the execution cache and executes all steps anew. | `false` |
13+
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
14+
| `-f` | The batch spec file to read, or - to read from standard input. | |
15+
| `-fail-fast` | Halts execution immediately upon first error instead of continuing with other tasks. | `false` |
16+
| `-force-override-ignore` | Do not ignore repositories that have a .batchignore file. | `false` |
17+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
18+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
19+
| `-j` | The maximum number of parallel jobs. Default (or 0) is the number of CPU cores available to Docker. | `0` |
20+
| `-keep-logs` | Retain logs after executing steps. | `false` |
21+
| `-n` | Alias for -namespace. | |
22+
| `-namespace` | The user or organization namespace to place the batch change within. Default is the currently authenticated user. | |
23+
| `-run-as-root` | If true, forces all step containers to run as root. | `false` |
24+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
25+
| `-text-only` | INTERNAL USE ONLY. EXPERIMENTAL. Switches off the TUI to only print JSON lines. | `false` |
26+
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
27+
| `-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` |
28+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
29+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
30+
| `-v` | print verbose output | `false` |
31+
| `-workspace` | Workspace mode to use ("auto", "bind", or "volume") | `auto` |
32+
3133

3234
## Usage
3335

@@ -100,3 +102,4 @@ Examples:
100102
101103
102104
```
105+

‎docs/cli/references/batch/exec.mdx‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# `src batch exec`
22

3+
34
## Flags
45

5-
| Name | Description | Default Value |
6-
| -------------------- | -------------------------------------------------------------------------------------------------------------- | ------------- |
7-
| `-binaryDiffs` | Whether to encode diffs as base64. | `false` |
8-
| `-f` | The workspace execution input file to read. | |
9-
| `-repo` | Path of the checked out repo on disk. | |
10-
| `-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` |
11-
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
12-
| `-tmp` | Directory for storing temporary data. | |
13-
| `-workspaceFiles` | Path of workspace files on disk. | |
6+
| Name | Description | Default Value |
7+
|------|-------------|---------------|
8+
| `-binaryDiffs` | Whether to encode diffs as base64. | `false` |
9+
| `-f` | The workspace execution input file to read. | |
10+
| `-repo` | Path of the checked out repo on disk. | |
11+
| `-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` |
12+
| `-timeout` | The maximum duration a single batch spec step can take. | `1h0m0s` |
13+
| `-tmp` | Directory for storing temporary data. | |
14+
| `-workspaceFiles` | Path of workspace files on disk. | |
15+
1416

1517
## Usage
1618

@@ -47,3 +49,4 @@ Examples:
4749
4850
4951
```
52+

‎docs/cli/references/batch/index.mdx‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
## Subcommands
44

5-
- [`apply`](batch/apply)
6-
- [`exec`](batch/exec)
7-
- [`new`](batch/new)
8-
- [`preview`](batch/preview)
9-
- [`remote`](batch/remote)
10-
- [`repositories`](batch/repositories)
11-
- [`validate`](batch/validate)
5+
6+
* [`apply`](batch/apply)
7+
* [`exec`](batch/exec)
8+
* [`new`](batch/new)
9+
* [`preview`](batch/preview)
10+
* [`remote`](batch/remote)
11+
* [`repositories`](batch/repositories)
12+
* [`validate`](batch/validate)
13+

‎docs/cli/references/batch/new.mdx‎

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# `src batch new`
22

3+
34
## Flags
45

5-
| Name | Description | Default Value |
6-
| ----------------------- | -------------------------------------------------------------------------------------------------------- | ------------- |
7-
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
8-
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
9-
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
10-
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
11-
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
12-
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
13-
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
6+
| Name | Description | Default Value |
7+
|------|-------------|---------------|
8+
| `-dump-requests` | Log GraphQL requests and responses to stdout | `false` |
9+
| `-f` | The name of the batch spec file to create. | `batch.yaml` |
10+
| `-get-curl` | Print the curl command for executing this query and exit (WARNING: includes printing your access token!) | `false` |
11+
| `-insecure-skip-verify` | Skip validation of TLS certificates against trusted chains | `false` |
12+
| `-skip-errors` | If true, errors encountered won't stop the program, but only log them. | `false` |
13+
| `-trace` | Log the trace ID for requests. See https://docs.sourcegraph.com/admin/observability/tracing | `false` |
14+
| `-user-agent-telemetry` | Include the operating system and architecture in the User-Agent sent with requests to Sourcegraph | `true` |
15+
1416

1517
## Usage
1618

@@ -46,3 +48,4 @@ Examples:
4648
4749
4850
```
51+

0 commit comments

Comments
 (0)