opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-16 06:37:58 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: give every table header cell text and fail lint on empty ones

Browse Source 
Screen readers announce a table header cell with no text as an unnamed
column, and axe reports it as empty-table-header.

- clidocgen writes "Property | Value" over each option's metadata table
  instead of an empty header row; the CLI reference is regenerated.
- The port-forwarding CORS matrix labels its corner cells (From user,
  From workspace, To user, To workspace, To app).
- Four Markdown matrices get a corner label, byte-identical to #30873.
- docshtmlcheck (make lint/docs-html) now fails on empty header cells in
  Markdown pipe tables and raw HTML tables, naming the file, line, and
  the table's first header.

Assisted-by: AI
This commit is contained in:
Nick Vigilante
2026-10-15 16:48:16 -04:00
parent fa926fcc77
commit 2ee96f82f9
126 changed files with 1897 additions and 1539 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/.style/style-guide/README.md
+1
View File
@@ -40,6 +40,7 @@ The linters catch a narrow band of mechanical errors; they can't tell you that a
| `Coder.UnitSpacing` | Vale | `warning` | `docs/**` except `docs/.style/style-guide/**` and `docs/admin/integrations/prometheus.md` and `docs/admin/setup/configuration-reference.md` and `docs/reference/{api,cli}/*.md` | A regular space, or no space, between a number and its unit |
| `MD001`, `MD025`, `MD040`, `MD045` | markdownlint | `error` | All Markdown | Heading increments, single H1, fence language, missing alt text |
| `scripts/check_emdash.sh` | `make lint/emdash` | `error` | Repository | Em-dash, en-dash, and ` -- ` as punctuation |
| `empty-table-header` | `docshtmlcheck` | `error` | `docs/**`, including generated pages | Table header cells with no text, in Markdown and HTML tables |
The markdownlint row lists only the rules that map to a rule in this guide.
markdownlint runs its full default set minus the rules `.markdownlint.jsonc` disables, so it catches more than these 4.
docs/admin/networking/port-forwarding.md
+5 -5
View File
@@ -245,20 +245,20 @@ configurable by either admins or users.
<table class="tg">
<thead>
<tr>
<th class="tg-0pky" rowspan="2"></th>
<th class="tg-0pky" rowspan="3"></th>
<th class="tg-0pky">From</th>
<th class="tg-0pky" colspan="3">From user</th>
<th class="tg-0pky" colspan="3">Alice</th>
<th class="tg-0pky">Bob</th>
</tr>
<tr>
<th class="tg-0pky" rowspan="2"></th>
<th class="tg-0pky" colspan="3">From workspace</th>
<th class="tg-0pky">Workspace 1</th>
<th class="tg-0pky" colspan="2">Workspace 2</th>
<th class="tg-0pky">Workspace 3</th>
</tr>
<tr>
<th class="tg-0pky">To</th>
<th class="tg-0pky">To user</th>
<th class="tg-0pky">To workspace</th>
<th class="tg-0pky">To app</th>
<th class="tg-0pky">App A</th>
<th class="tg-0pky">App B</th>
<th class="tg-0pky">App C</th>
docs/admin/templates/extending-templates/workspace-tags.md
+1 -1
View File
@@ -98,7 +98,7 @@ as immutable and set only once, during workspace creation.
You may only specify the following as inputs for `coder_workspace_tags`:
| | Example |
| Input | Example |
|:-------------------|:----------------------------------------------|
| Static values | `"developers"` |
| Template variables | `var.az` |
docs/admin/users/groups-roles.md
+1 -1
View File
@@ -26,7 +26,7 @@ The roles in the following table apply across the whole deployment.
Organizations have their own roles.
Refer to [Organization roles](#organization-roles) for more information.
| | Auditor | User Admin | Template Admin | Owner |
| Permission | Auditor | User Admin | Template Admin | Owner |
|--------------------------------------------------------------------------|---------|------------|----------------|-------|
| Add and remove Users | | ✅ | | ✅ |
| Manage groups (premium) | | ✅ | | ✅ |
docs/install/prepare/airgap.md
+1 -1
View File
@@ -6,7 +6,7 @@ All Coder features are supported in air-gapped / behind firewalls / disconnected
This is a general comparison.
Keep reading for a full tutorial running Coder air-gapped with Kubernetes or Docker.
| | Public deployments | Air-gapped deployments |
| Component | Public deployments | Air-gapped deployments |
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Terraform binary | By default, Coder downloads Terraform binary from [releases.hashicorp.com](https://releases.hashicorp.com) | Terraform binary must be included in `PATH` for the VM or container image. [Supported versions](../../../provisioner/terraform/install.go#L27-L28) |
| Terraform registry | Coder templates will attempt to download providers from [registry.terraform.io](https://registry.terraform.io) or [custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) specified in each template | [Custom source addresses](https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses) can be specified in each Coder template, or a custom registry/mirror can be used. More details below |
docs/install/validate/scale-testing.md
+1 -1
View File
@@ -33,7 +33,7 @@ Our scale tests include the following stages:
The scale tests runner can distribute the workload to overlap single scenarios based on the workflow configuration:
| | T0 | T1 | T2 | T3 | T4 | T5 | T6 |
| Scenario | T0 | T1 | T2 | T3 | T4 | T5 | T6 |
|----------------------|----|----|----|----|----|----|----|
| SSH connections | X | X | X | X | | | |
| Web Terminal (PTY) | | X | X | X | X | | |
docs/reference/cli/agent-firewall.md
Generated
+17 -17
View File
@@ -24,7 +24,7 @@ boundary creates an isolated network environment for target processes, intercept
### --config
| | |
| Property | Value |
|-------------|-------------------------------|
| Type | <code>yaml-config-path</code> |
| Environment | <code>$BOUNDARY_CONFIG</code> |
@@ -33,7 +33,7 @@ Path to YAML config file.
### --allow
| | |
| Property | Value |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$BOUNDARY_ALLOW</code> |
@@ -42,7 +42,7 @@ Allow rule (repeatable). These are merged with allowlist from config file. Forma
### --log-level
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$BOUNDARY_LOG_LEVEL</code> |
@@ -53,7 +53,7 @@ Set log level (error, warn, info, debug).
### --log-dir
| | |
| Property | Value |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$BOUNDARY_LOG_DIR</code> |
@@ -63,7 +63,7 @@ Set a directory to write logs to rather than stderr.
### --proxy-port
| | |
| Property | Value |
|-------------|--------------------------|
| Type | <code>int</code> |
| Environment | <code>$PROXY_PORT</code> |
@@ -74,7 +74,7 @@ Set a port for HTTP proxy.
### --pprof
| | |
| Property | Value |
|-------------|------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$BOUNDARY_PPROF</code> |
@@ -84,7 +84,7 @@ Enable pprof profiling server.
### --pprof-port
| | |
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>int</code> |
| Environment | <code>$BOUNDARY_PPROF_PORT</code> |
@@ -95,7 +95,7 @@ Set port for pprof profiling server.
### --jail-type
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$BOUNDARY_JAIL_TYPE</code> |
@@ -106,7 +106,7 @@ Jail type to use for network isolation. Options: nsjail (default), landjail.
### --use-real-dns
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$BOUNDARY_USE_REAL_DNS</code> |
@@ -116,7 +116,7 @@ Use real DNS in the jail instead of the dummy DNS (allows DNS exfiltration). Def
### --no-user-namespace
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$BOUNDARY_NO_USER_NAMESPACE</code> |
@@ -126,7 +126,7 @@ Do not create a user namespace. Use in restricted environments that disallow use
### --disable-audit-logs
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$DISABLE_AUDIT_LOGS</code> |
@@ -136,7 +136,7 @@ Disable sending of audit logs to the workspace agent when set to true.
### --log-proxy-socket-path
| | |
| Property | Value |
|-------------|----------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_BOUNDARY_LOG_PROXY_SOCKET_PATH</code> |
@@ -146,15 +146,15 @@ Path to the socket where the boundary log proxy server listens for audit logs.
### --version
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Print version information and exit.
### --enable-session-correlation
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$BOUNDARY_SESSION_CORRELATION_ENABLED</code> |
@@ -164,7 +164,7 @@ Enable session correlation header injection. When no inject targets are configur
### --session-id-inject-target
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$BOUNDARY_SESSION_ID_INJECT_TARGET</code> |
docs/reference/cli/ai-gateway/keys/delete.md
Generated
+3 -3
View File
@@ -22,8 +22,8 @@ coder ai-gateway keys delete [flags] <name|id>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/ai-gateway/keys/list.md
Generated
+8 -8
View File
@@ -22,18 +22,18 @@ coder ai-gateway keys list [flags]
### -c, --column
| | |
|---------|--------------------------------------------------------------------|
| Type | <code>[id\|name\|key prefix\|created at\|last heartbeat at]</code> |
| Default | <code>id,name,key prefix,last heartbeat at,created at</code> |
| Property | Value |
|----------|--------------------------------------------------------------------|
| Type | <code>[id\|name\|key prefix\|created at\|last heartbeat at]</code> |
| Default | <code>id,name,key prefix,last heartbeat at,created at</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/ai-gateway/start.md
Generated
+28 -28
View File
@@ -26,7 +26,7 @@ Set --url or CODER_URL to the Coder deployment address, and set --key (CODER_AI_
### --key
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_KEY</code> |
@@ -35,7 +35,7 @@ The AI Gateway key used to authenticate to coderd.
### --key-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_KEY_FILE</code> |
@@ -44,7 +44,7 @@ Path to a file containing the AI Gateway key used to authenticate to coderd.
### --http-address
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_HTTP_ADDRESS</code> |
@@ -54,7 +54,7 @@ The bind address to serve incoming AI Gateway client traffic.
### --tls-cert-file
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_TLS_CERT_FILE</code> |
@@ -63,7 +63,7 @@ Path to a PEM-encoded TLS certificate. Enables TLS termination when set together
### --tls-key-file
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_TLS_KEY_FILE</code> |
@@ -72,7 +72,7 @@ Path to a PEM-encoded TLS private key. Enables TLS termination when set together
### --prometheus-enable
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
@@ -82,7 +82,7 @@ Serve prometheus metrics on the address defined by prometheus address.
### --prometheus-address
| | |
| Property | Value |
|-------------|-----------------------------------------------|
| Type | <code>host:port</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
@@ -93,7 +93,7 @@ The bind address to serve prometheus metrics.
### --trace
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_ENABLE</code> |
@@ -103,7 +103,7 @@ Whether application tracing data is collected. It exports to a backend configure
### --trace-honeycomb-api-key
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TRACE_HONEYCOMB_API_KEY</code> |
@@ -112,7 +112,7 @@ Enables trace exporting to Honeycomb.io using the provided API Key.
### --trace-logs
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_LOGS</code> |
@@ -122,7 +122,7 @@ Enables capturing of logs as events in traces. This is useful for debugging, but
### -l, --log-filter
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_LOG_FILTER</code> |
@@ -132,7 +132,7 @@ Filter debug logs by matching against a given regex. Use .* to match all debug l
### --log-human
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_HUMAN</code> |
@@ -143,7 +143,7 @@ Output human-readable logs to a given file.
### --log-json
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_JSON</code> |
@@ -153,7 +153,7 @@ Output JSON logs to a given file.
### --log-stackdriver
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_STACKDRIVER</code> |
@@ -163,7 +163,7 @@ Output Stackdriver compatible logs to a given file.
### --experiments
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXPERIMENTS</code> |
@@ -173,7 +173,7 @@ Enable one or more experiments. These are not ready for production. Separate mul
### -c, --config
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>yaml-config-path</code> |
| Environment | <code>$CODER_CONFIG_PATH</code> |
@@ -182,7 +182,7 @@ Specify a YAML file to load configuration from.
### --ai-gateway-max-concurrency
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_AI_GATEWAY_MAX_CONCURRENCY</code> |
@@ -193,7 +193,7 @@ Maximum number of concurrent AI Gateway requests per replica. Set to 0 to disabl
### --ai-gateway-rate-limit
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_AI_GATEWAY_RATE_LIMIT</code> |
@@ -204,7 +204,7 @@ Maximum number of AI Gateway requests per second per replica. Set to 0 to disabl
### --ai-gateway-structured-logging
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_STRUCTURED_LOGGING</code> |
@@ -215,7 +215,7 @@ Emit structured logs for AI Gateway interception records. Use this for exporting
### --ai-gateway-structured-logging-source
| | |
| Property | Value |
|-------------|----------------------------------------------------------|
| Type | <code>coderd\|gateway\|both</code> |
| Environment | <code>$CODER_AI_GATEWAY_STRUCTURED_LOGGING_SOURCE</code> |
@@ -226,7 +226,7 @@ Which process emits AI Gateway interception records when structured logging is e
### --ai-gateway-disable-content-recording
| | |
| Property | Value |
|-------------|----------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_DISABLE_CONTENT_RECORDING</code> |
@@ -237,7 +237,7 @@ Stop recording the content of intercepted conversations. No user prompt, tool ca
### --ai-gateway-send-actor-headers
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_SEND_ACTOR_HEADERS</code> |
@@ -248,7 +248,7 @@ Add configured headers identifying the authenticated user to intercepted upstrea
### --ai-gateway-actor-header-id
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_ID</code> |
@@ -259,7 +259,7 @@ Header name for the authenticated user's ID. Empty disables this header. Require
### --ai-gateway-actor-header-username
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_USERNAME</code> |
@@ -270,7 +270,7 @@ Header name for the authenticated user's username. Empty disables this header. R
### --ai-gateway-actor-header-email
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_ACTOR_HEADER_EMAIL</code> |
@@ -280,7 +280,7 @@ Header name for the authenticated user's email address. Empty disables this head
### --ai-gateway-dump-dir
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AI_GATEWAY_DUMP_DIR</code> |
@@ -290,7 +290,7 @@ Base directory for dumping AI Gateway request/response pairs to disk for debuggi
### --ai-gateway-allow-byok
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_ALLOW_BYOK</code> |
@@ -301,7 +301,7 @@ Allow users to provide their own LLM API keys or subscriptions. When disabled, o
### --ai-gateway-circuit-breaker-enabled
| | |
| Property | Value |
|-------------|--------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_AI_GATEWAY_CIRCUIT_BREAKER_ENABLED</code> |
docs/reference/cli/completion.md
Generated
+6 -6
View File
@@ -18,16 +18,16 @@ coder completion [flags]
### -s, --shell
| | |
|------|------------------------------------------|
| Type | <code>bash\|fish\|zsh\|powershell</code> |
| Property | Value |
|----------|------------------------------------------|
| Type | <code>bash\|fish\|zsh\|powershell</code> |
The shell to install completion for.
### -p, --print
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Print the completion script instead of installing it.
docs/reference/cli/config-ssh.md
Generated
+14 -14
View File
@@ -31,7 +31,7 @@ workspaces:
### --ssh-config-file
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
@@ -41,7 +41,7 @@ Specifies the path to an SSH config.
### --coder-binary-path
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
@@ -50,7 +50,7 @@ Optionally specify the absolute path to the coder binary used in ProxyCommand. B
### -o, --ssh-option
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
@@ -59,7 +59,7 @@ Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
@@ -68,7 +68,7 @@ Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
@@ -77,7 +77,7 @@ Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix
| | |
| Property | Value |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
@@ -86,7 +86,7 @@ Override the default host prefix.
### --hostname-suffix
| | |
| Property | Value |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_HOSTNAME_SUFFIX</code> |
@@ -95,7 +95,7 @@ Override the default hostname suffix.
### --wait
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
@@ -105,7 +105,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --disable-autostart
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
@@ -115,7 +115,7 @@ Disable starting the workspace automatically when connecting via SSH.
### --no-wildcard
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_NO_WILDCARD</code> |
@@ -125,7 +125,7 @@ Generate an individual host entry for each workspace instead of a wildcard host
### --force-unix-filepaths
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_UNIX_FILEPATHS</code> |
@@ -134,8 +134,8 @@ By default, 'config-ssh' uses the os path separator when writing the ssh config.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/create.md
Generated
+25 -25
View File
@@ -26,7 +26,7 @@ coder create [flags] [workspace]
### -t, --template
| | |
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
@@ -35,7 +35,7 @@ Specify a template name.
### --template-version
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
@@ -44,7 +44,7 @@ Specify a template version name or ID.
### --preset
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PRESET_NAME</code> |
@@ -53,7 +53,7 @@ Specify the name of a template version preset. Use 'none' to explicitly indicate
### --start-at
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
@@ -62,7 +62,7 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
### --stop-after
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
@@ -71,7 +71,7 @@ Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
@@ -81,7 +81,7 @@ Specify automatic updates setting for the workspace (accepts 'always' or 'never'
### --copy-parameters-from
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
@@ -90,7 +90,7 @@ Specify the source workspace name to copy parameters from.
### --no-wait
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CREATE_NO_WAIT</code> |
@@ -99,15 +99,15 @@ Return immediately after creating the workspace. The build will run in the backg
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --build-option
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -116,15 +116,15 @@ Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -133,7 +133,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -142,7 +142,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -151,7 +151,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -160,7 +160,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -169,7 +169,7 @@ Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
@@ -178,15 +178,15 @@ Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/delete.md
Generated
+6 -6
View File
@@ -30,16 +30,16 @@ coder delete [flags] <workspace>
### --orphan
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/dotfiles.md
Generated
+8 -8
View File
@@ -26,7 +26,7 @@ coder dotfiles [flags] <git_repo_url>
### --symlink-dir
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
@@ -35,15 +35,15 @@ Specifies the directory for the dotfiles symlink destinations. If empty, will us
### -b, --branch
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk.
### --repo-dir
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DOTFILES_REPO_DIR</code> |
@@ -53,8 +53,8 @@ Specifies the directory for the dotfiles repository, relative to global config d
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/external-auth/access-token.md
Generated
+12 -12
View File
@@ -44,24 +44,24 @@ fi
### --extra
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Extract a field from the "extra" properties of the OAuth token.
### --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format. Available formats: text, json.
### --agent-token
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_TOKEN</code> |
@@ -70,7 +70,7 @@ An agent authentication token.
### --agent-token-file
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_TOKEN_FILE</code> |
@@ -79,7 +79,7 @@ A file containing an agent authentication token.
### --agent-url
| | |
| Property | Value |
|-------------|-------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_AGENT_URL</code> |
@@ -88,7 +88,7 @@ URL for an agent to access your deployment.
### --auth
| | |
| Property | Value |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_AUTH</code> |
@@ -98,7 +98,7 @@ Specify the authentication type to use for the agent.
### --agent-name
| | |
| Property | Value |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_NAME</code> |
docs/reference/cli/external-workspaces/agent-instructions.md
Generated
+4 -4
View File
@@ -18,9 +18,9 @@ coder external-workspaces agent-instructions [flags] [user/]workspace[.agent]
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/external-workspaces/create.md
Generated
+25 -25
View File
@@ -26,7 +26,7 @@ coder external-workspaces create [flags] [workspace]
### -t, --template
| | |
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
@@ -35,7 +35,7 @@ Specify a template name.
### --template-version
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
@@ -44,7 +44,7 @@ Specify a template version name or ID.
### --preset
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PRESET_NAME</code> |
@@ -53,7 +53,7 @@ Specify the name of a template version preset. Use 'none' to explicitly indicate
### --start-at
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
@@ -62,7 +62,7 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
### --stop-after
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
@@ -71,7 +71,7 @@ Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
@@ -81,7 +81,7 @@ Specify automatic updates setting for the workspace (accepts 'always' or 'never'
### --copy-parameters-from
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
@@ -90,7 +90,7 @@ Specify the source workspace name to copy parameters from.
### --no-wait
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CREATE_NO_WAIT</code> |
@@ -99,15 +99,15 @@ Return immediately after creating the workspace. The build will run in the backg
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --build-option
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -116,15 +116,15 @@ Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -133,7 +133,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -142,7 +142,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -151,7 +151,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -160,7 +160,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -169,7 +169,7 @@ Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
@@ -178,15 +178,15 @@ Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/external-workspaces/index.md
Generated
+1 -1
View File
@@ -26,7 +26,7 @@ coder external-workspaces [flags] [subcommand]
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/external-workspaces/list.md
Generated
+15 -15
View File
@@ -22,35 +22,35 @@ coder external-workspaces list [flags]
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
| Property | Value |
|----------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated</code> |
| Property | Value |
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/features/list.md
Generated
+8 -8
View File
@@ -19,18 +19,18 @@ coder features list [flags]
### -c, --column
| | |
|---------|----------------------------------------------------------|
| Type | <code>[name\|entitlement\|enabled\|limit\|actual]</code> |
| Default | <code>name,entitlement,enabled,limit,actual</code> |
| Property | Value |
|----------|----------------------------------------------------------|
| Type | <code>[name\|entitlement\|enabled\|limit\|actual]</code> |
| Default | <code>name,entitlement,enabled,limit,actual</code> |
Specify columns to filter in the table.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/groups/create.md
Generated
+3 -3
View File
@@ -18,7 +18,7 @@ coder groups create [flags] <name>
### -u, --avatar-url
| | |
| Property | Value |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AVATAR_URL</code> |
@@ -27,7 +27,7 @@ Set an avatar for a group.
### --display-name
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
@@ -36,7 +36,7 @@ Optional human friendly name for the group.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups/delete.md
Generated
+1 -1
View File
@@ -22,7 +22,7 @@ coder groups delete [flags] <name>
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups/edit.md
Generated
+14 -14
View File
@@ -18,23 +18,23 @@ coder groups edit [flags] <name>
### -n, --name
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Update the group name.
### -u, --avatar-url
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Update the group avatar.
### --display-name
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
@@ -43,23 +43,23 @@ Optional human friendly name for the group.
### -a, --add-users
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Add users to the group. Accepts emails or IDs.
### -r, --rm-users
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Remove users to the group. Accepts emails or IDs.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups/list.md
Generated
+9 -9
View File
@@ -18,25 +18,25 @@ coder groups list [flags]
### -c, --column
| | |
|---------|-------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|members\|avatar url]</code> |
| Default | <code>name,display name,organization id,members,avatar url</code> |
| Property | Value |
|----------|-------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|members\|avatar url]</code> |
| Default | <code>name,display name,organization id,members,avatar url</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/index.md
Generated
+20 -20
View File
@@ -86,7 +86,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
### --url
| | |
| Property | Value |
|-------------|-------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_URL</code> |
@@ -95,15 +95,15 @@ URL to a deployment.
### --debug-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Print all options, how they're set, then exit.
### --token
| | |
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SESSION_TOKEN</code> |
@@ -112,7 +112,7 @@ Specify an authentication token. For security reasons setting CODER_SESSION_TOKE
### --no-version-warning
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_NO_VERSION_WARNING</code> |
@@ -121,7 +121,7 @@ Suppress warning when client and server versions do not match.
### --no-feature-warning
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_NO_FEATURE_WARNING</code> |
@@ -130,7 +130,7 @@ Suppress warnings about unlicensed features.
### --allow-redirects
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_ALLOW_REDIRECTS</code> |
@@ -139,7 +139,7 @@ Follow HTTP redirects from the server instead of returning an error. Following r
### --header
| | |
| Property | Value |
|-------------|----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_HEADER</code> |
@@ -148,7 +148,7 @@ Additional HTTP headers added to all requests. Provide as key=value. Can be spec
### --header-command
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_HEADER_COMMAND</code> |
@@ -157,7 +157,7 @@ An external command that outputs additional HTTP headers added to all requests.
### --force-tty
| | |
| Property | Value |
|-------------|-------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_FORCE_TTY</code> |
@@ -166,7 +166,7 @@ Force the use of a TTY.
### -v, --verbose
| | |
| Property | Value |
|-------------|-----------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_VERBOSE</code> |
@@ -175,7 +175,7 @@ Enable verbose output.
### --flight-recorder-size
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_FLIGHT_RECORDER_SIZE</code> |
@@ -185,7 +185,7 @@ Number of log entries below the current log level to keep in memory and emit on
### --disable-direct-connections
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_DIRECT_CONNECTIONS</code> |
@@ -194,7 +194,7 @@ Disable direct (P2P) connections to workspaces.
### --disable-network-telemetry
| | |
| Property | Value |
|-------------|-----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_NETWORK_TELEMETRY</code> |
@@ -203,7 +203,7 @@ Disable network telemetry. Network telemetry is collected when connecting to wor
### --client-tls-ca-file
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CLIENT_TLS_CA_FILE</code> |
@@ -212,7 +212,7 @@ Path to a CA certificate file to trust for API and DERP connections.
### --client-tls-cert-file
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CLIENT_TLS_CERT_FILE</code> |
@@ -221,7 +221,7 @@ Path to a client certificate file for mTLS authentication with API and DERP. Req
### --client-tls-key-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CLIENT_TLS_KEY_FILE</code> |
@@ -230,7 +230,7 @@ Path to a client private key file for mTLS authentication with API and DERP. Req
### --use-keyring
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_USE_KEYRING</code> |
@@ -240,7 +240,7 @@ Store and retrieve session tokens using the operating system keyring. This flag
### --global-config
| | |
| Property | Value |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIG_DIR</code> |
docs/reference/cli/licenses/add.md
Generated
+13 -13
View File
@@ -18,33 +18,33 @@ coder licenses add [flags] [-f file | -l license]
### -f, --file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Load license from file.
### -l, --license
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
License string.
### --debug
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output license claims for debugging.
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/licenses/delete.md
Generated
+4 -4
View File
@@ -23,9 +23,9 @@ coder licenses delete [flags] <id>
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/licenses/list.md
Generated
+8 -8
View File
@@ -22,18 +22,18 @@ coder licenses list [flags]
### -c, --column
| | |
|---------|-------------------------------------------------------------------|
| Type | <code>[id\|uuid\|uploaded at\|features\|expires at\|trial]</code> |
| Default | <code>ID,UUID,Expires At,Uploaded At,Features</code> |
| Property | Value |
|----------|-------------------------------------------------------------------|
| Type | <code>[id\|uuid\|uploaded at\|features\|expires at\|trial]</code> |
| Default | <code>ID,UUID,Expires At,Uploaded At,Features</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/list.md
Generated
+15 -15
View File
@@ -22,35 +22,35 @@ coder list [flags]
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
| Property | Value |
|----------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated,starts at,stops after</code> |
| Property | Value |
|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated,starts at,stops after</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/login/index.md
Generated
+15 -15
View File
@@ -30,7 +30,7 @@ By default, the session token is stored in the operating system keyring on macOS
### --first-user-email
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_EMAIL</code> |
@@ -39,7 +39,7 @@ Specifies an email address to use if creating the first user for the deployment.
### --first-user-username
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
@@ -48,7 +48,7 @@ Specifies a username to use if creating the first user for the deployment.
### --first-user-full-name
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_FULL_NAME</code> |
@@ -57,7 +57,7 @@ Specifies a human-readable name for the first user of the deployment.
### --first-user-password
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_PASSWORD</code> |
@@ -66,7 +66,7 @@ Specifies a password to use if creating the first user for the deployment.
### --first-user-trial
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL</code> |
@@ -75,7 +75,7 @@ Specifies whether a trial license should be provisioned for the Coder deployment
### --first-user-trial-first-name
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_FIRST_NAME</code> |
@@ -84,7 +84,7 @@ Specifies the first name of the first user for the deployment. Only used if --fi
### --first-user-trial-last-name
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_LAST_NAME</code> |
@@ -93,7 +93,7 @@ Specifies the last name of the first user for the deployment. Only used if --fir
### --first-user-trial-phone-number
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_PHONE_NUMBER</code> |
@@ -102,7 +102,7 @@ Specifies the phone number of the first user for the deployment. Only used if --
### --first-user-trial-job-title
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_JOB_TITLE</code> |
@@ -111,7 +111,7 @@ Specifies the job title of the first user for the deployment. Only used if --fir
### --first-user-trial-company-name
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_COMPANY_NAME</code> |
@@ -120,7 +120,7 @@ Specifies the company name of the first user for the deployment. Only used if --
### --first-user-trial-country
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_COUNTRY</code> |
@@ -129,7 +129,7 @@ Specifies the country of the first user for the deployment. Only used if --first
### --first-user-trial-developers
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL_DEVELOPERS</code> |
@@ -138,8 +138,8 @@ Specifies the number of developers using the deployment. Only used if --first-us
### --use-token-as-session
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
By default, the CLI will generate a new session token when logging in. This flag will instead use the provided token as the session token.
docs/reference/cli/logout.md
Generated
+3 -3
View File
@@ -18,8 +18,8 @@ coder logout [flags]
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/logs.md
Generated
+8 -8
View File
@@ -24,18 +24,18 @@ View logs for a workspace
### -n, --build-number
| | |
|---------|------------------|
| Type | <code>int</code> |
| Default | <code>0</code> |
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
| Default | <code>0</code> |
Only show logs for a specific build number. Defaults to 0, which maps to the most recent build (build numbers start at 1). Negative values are treated as offsets—for example, -1 refers to the previous build.
### -f, --follow
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Follow logs as they are emitted.
docs/reference/cli/open/app.md
Generated
+1 -1
View File
@@ -18,7 +18,7 @@ coder open app [flags] <workspace> <app slug>
### --region
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_OPEN_APP_REGION</code> |
docs/reference/cli/open/vscode.md
Generated
+1 -1
View File
@@ -18,7 +18,7 @@ coder open vscode [flags] <workspace> [<directory in workspace>]
### --generate-token
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OPEN_VSCODE_GENERATE_TOKEN</code> |
docs/reference/cli/organizations/delete.md
Generated
+3 -3
View File
@@ -22,8 +22,8 @@ coder organizations delete [flags] <organization_name_or_id>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/organizations/edit.md
Generated
+7 -7
View File
@@ -34,23 +34,23 @@ coder organizations edit [flags]
### --default-org-member-roles
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Replaces the roles every member of the organization holds. Accepts a comma-separated list and may be repeated. An empty value removes every role. New organizations start with organization-workspace-access, which grants members access to their own workspaces, and agents-access, which grants members access to Coder Agents.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/organizations/index.md
Generated
+1 -1
View File
@@ -37,7 +37,7 @@ coder organizations [flags] [subcommand]
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/organizations/list.md
Generated
+8 -8
View File
@@ -28,18 +28,18 @@ List all organizations. Requires a role which grants ResourceOrganization: read.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default\|default org member roles]</code> |
| Default | <code>name,display name,id,default</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default\|default org member roles]</code> |
| Default | <code>name,display name,id,default</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/organizations/members/list.md
Generated
+8 -8
View File
@@ -18,18 +18,18 @@ coder organizations members list [flags]
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[username\|name\|last seen at\|user created at\|user updated at\|user id\|organization id\|created at\|updated at\|organization roles]</code> |
| Default | <code>username,organization roles</code> |
| Property | Value |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[username\|name\|last seen at\|user created at\|user updated at\|user id\|organization id\|created at\|updated at\|organization roles]</code> |
| Default | <code>username,organization roles</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/organizations/roles/create.md
Generated
+9 -9
View File
@@ -26,24 +26,24 @@ coder organizations roles create [flags] <role_name>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --dry-run
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Does all the work, but does not submit the final updated role.
### --stdin
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Reads stdin for the json role definition to upload.
docs/reference/cli/organizations/roles/show.md
Generated
+8 -8
View File
@@ -18,18 +18,18 @@ coder organizations roles show [flags] [role_names ...]
### -c, --column
| | |
|---------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
| Property | Value |
|----------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/organizations/roles/update.md
Generated
+17 -17
View File
@@ -26,42 +26,42 @@ coder organizations roles update [flags] <role_name>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --dry-run
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Does all the work, but does not submit the final updated role.
### --stdin
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Reads stdin for the json role definition to upload.
### -c, --column
| | |
|---------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
| Property | Value |
|----------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/organizations/show.md
Generated
+11 -11
View File
@@ -38,26 +38,26 @@ coder organizations show [flags] ["selected"|"me"|uuid|org_name]
### --only-id
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Only print the organization ID.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default\|default org member roles]</code> |
| Default | <code>id,name,default</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default\|default org member roles]</code> |
| Default | <code>id,name,default</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------------|
| Type | <code>text\|table\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|--------------------------------|
| Type | <code>text\|table\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/ping.md
Generated
+17 -17
View File
@@ -18,42 +18,42 @@ coder ping [flags] <workspace>
### --wait
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies how long to wait between pings.
### -t, --timeout
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies how long to wait for a ping to complete.
### -n, --num
| | |
|------|------------------|
| Type | <code>int</code> |
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
Specifies the number of pings to perform. By default, pings will continue until interrupted.
### --time
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in local time.
### --utc
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in UTC (implies --time).
docs/reference/cli/port-forward.md
Generated
+3 -3
View File
@@ -48,7 +48,7 @@ machine:
### -p, --tcp
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_TCP</code> |
@@ -57,7 +57,7 @@ Forward TCP port(s) from the workspace to the local machine.
### --udp
| | |
| Property | Value |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_UDP</code> |
@@ -66,7 +66,7 @@ Forward UDP port(s) from the workspace to the local machine. The UDP connection
### --disable-autostart
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
docs/reference/cli/provisioner/jobs/cancel.md
Generated
+1 -1
View File
@@ -18,7 +18,7 @@ coder provisioner jobs cancel [flags] <job_id>
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner/jobs/list.md
Generated
+12 -12
View File
@@ -22,7 +22,7 @@ coder provisioner jobs list [flags]
### -s, --status
| | |
| Property | Value |
|-------------|----------------------------------------------------------------------------------|
| Type | <code>[pending\|running\|succeeded\|canceling\|canceled\|failed\|unknown]</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_STATUS</code> |
@@ -31,7 +31,7 @@ Filter by job status.
### -l, --limit
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_LIMIT</code> |
@@ -41,7 +41,7 @@ Limit the number of jobs returned.
### -i, --initiator
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_INITIATOR</code> |
@@ -50,7 +50,7 @@ Filter by initiator (user ID or username).
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -59,18 +59,18 @@ Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|initiator id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|workspace build transition\|logs overflowed\|organization\|queue]</code> |
| Default | <code>created at,id,type,template display name,status,queue,tags</code> |
| Property | Value |
|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|initiator id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|workspace build transition\|logs overflowed\|organization\|queue]</code> |
| Default | <code>created at,id,type,template display name,status,queue,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/provisioner/keys/create.md
Generated
+2 -2
View File
@@ -18,7 +18,7 @@ coder provisioner keys create [flags] <name>
### -t, --tag
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
@@ -27,7 +27,7 @@ Tags to filter provisioner jobs by.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner/keys/delete.md
Generated
+4 -4
View File
@@ -22,15 +22,15 @@ coder provisioner keys delete [flags] <name>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner/keys/list.md
Generated
+9 -9
View File
@@ -22,7 +22,7 @@ coder provisioner keys list [flags]
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -31,18 +31,18 @@ Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|---------------------------------------|
| Type | <code>[created at\|name\|tags]</code> |
| Default | <code>created at,name,tags</code> |
| Property | Value |
|----------|---------------------------------------|
| Type | <code>[created at\|name\|tags]</code> |
| Default | <code>created at,name,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/provisioner/list.md
Generated
+13 -13
View File
@@ -22,7 +22,7 @@ coder provisioner list [flags]
### -l, --limit
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_LIMIT</code> |
@@ -32,7 +32,7 @@ Limit the number of provisioners returned.
### -f, --show-offline
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_SHOW_OFFLINE</code> |
@@ -41,7 +41,7 @@ Show offline provisioners.
### -s, --status
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>[offline\|idle\|busy]</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_STATUS</code> |
@@ -50,7 +50,7 @@ Filter by provisioner status.
### -m, --max-age
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_MAX_AGE</code> |
@@ -59,7 +59,7 @@ Filter provisioners by maximum age.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -68,18 +68,18 @@ Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]</code> |
| Default | <code>created at,last seen at,key name,name,version,status,tags</code> |
| Property | Value |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]</code> |
| Default | <code>created at,last seen at,key name,name,version,status,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/provisioner/start.md
Generated
+16 -16
View File
@@ -18,7 +18,7 @@ coder provisioner start [flags]
### -c, --cache-dir
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
@@ -28,7 +28,7 @@ Directory to store cached data.
### -t, --tag
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
@@ -37,7 +37,7 @@ Tags to filter provisioner jobs by.
### --poll-interval
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
@@ -47,7 +47,7 @@ Deprecated and ignored.
### --poll-jitter
| | |
| Property | Value |
|-------------|----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
@@ -57,7 +57,7 @@ Deprecated and ignored.
### --psk
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
@@ -66,7 +66,7 @@ Pre-shared key to authenticate with Coder server.
### --key
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_KEY</code> |
@@ -75,7 +75,7 @@ Provisioner key to authenticate with Coder server.
### --name
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
@@ -84,7 +84,7 @@ Name of this provisioner daemon. Defaults to the current hostname without FQDN.
### --verbose
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
@@ -94,7 +94,7 @@ Output debug-level logs.
### --log-human
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_HUMAN</code> |
@@ -104,7 +104,7 @@ Output human-readable logs to a given file.
### --log-json
| | |
| Property | Value |
|-------------|-----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_JSON</code> |
@@ -113,7 +113,7 @@ Output JSON logs to a given file.
### --log-stackdriver
| | |
| Property | Value |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_STACKDRIVER</code> |
@@ -122,7 +122,7 @@ Output Stackdriver compatible logs to a given file.
### --log-filter
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
@@ -131,7 +131,7 @@ Filter debug logs by matching against a given regex. Use .* to match all debug l
### --prometheus-enable
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
@@ -141,7 +141,7 @@ Serve prometheus metrics on the address defined by prometheus address.
### --prometheus-address
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
@@ -151,7 +151,7 @@ The bind address to serve prometheus metrics.
### --experiments
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXPERIMENTS</code> |
@@ -161,7 +161,7 @@ Enable one or more experiments. These are not ready for production. Separate mul
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/publickey.md
Generated
+6 -6
View File
@@ -22,16 +22,16 @@ coder publickey [flags]
### --reset
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Regenerate your public key. This will require updating the key on any services it's registered with.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/rename.md
Generated
+3 -3
View File
@@ -26,8 +26,8 @@ coder rename [flags] <workspace> <new name>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/reset-password.md
Generated
+2 -2
View File
@@ -18,7 +18,7 @@ coder reset-password [flags] <username>
### --postgres-url
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -27,7 +27,7 @@ URL of a PostgreSQL database to connect to.
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
docs/reference/cli/restart.md
Generated
+16 -16
View File
@@ -18,15 +18,15 @@ coder restart [flags] <workspace>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --build-option
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -35,15 +35,15 @@ Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -52,7 +52,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -61,7 +61,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -70,7 +70,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -79,7 +79,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -88,7 +88,7 @@ Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
@@ -97,8 +97,8 @@ Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/reference/cli/schedule/extend.md
Generated
+8 -8
View File
@@ -33,18 +33,18 @@ Extends the workspace deadline.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/schedule/show.md
Generated
+15 -15
View File
@@ -29,35 +29,35 @@ Shows the following information for the given workspace(s):
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
| Property | Value |
|----------|----------------------|
| Type | <code>string</code> |
| Default | <code>user:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/schedule/start.md
Generated
+8 -8
View File
@@ -36,18 +36,18 @@ Schedule format: <start-time> [day-of-week] [location].
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/schedule/stop.md
Generated
+8 -8
View File
@@ -37,18 +37,18 @@ When enabling scheduled stop, enter a duration in one of the following formats:
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/secret/create.md
Generated
+16 -16
View File
@@ -24,41 +24,41 @@ Provide the secret value with --value or non-interactive stdin (pipe or redirect
### --value
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Set the secret value. For security reasons, prefer non-interactive stdin (pipe or redirect).
### --description
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Set the secret description.
### --env
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Name of the workspace environment variable that this secret will set.
### --file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Workspace file path where this secret will be written. Must start with ~/ or /.
### --enabled
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Whether the secret is injected into workspaces. An enabled secret must set --env or --file; pass --enabled=false to store a secret without injecting it.
docs/reference/cli/secret/delete.md
Generated
+3 -3
View File
@@ -23,8 +23,8 @@ coder secret delete [flags] <name>
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/secret/import.md
Generated
+3 -3
View File
@@ -24,8 +24,8 @@ Every key in the file becomes a secret. Keys allowed as environment variable nam
### --input-format
| | |
|------|------------------------------|
| Type | <code>env\|json\|yaml</code> |
| Property | Value |
|----------|------------------------------|
| Type | <code>env\|json\|yaml</code> |
Format of the secrets file. Inferred from the file extension when unset, and required when reading from stdin.
docs/reference/cli/secret/list.md
Generated
+8 -8
View File
@@ -28,18 +28,18 @@ Secret values are omitted from the output.
### -c, --column
| | |
|---------|------------------------------------------------------------------------|
| Type | <code>[created\|name\|updated\|env\|file\|enabled\|description]</code> |
| Default | <code>name,created,updated,env,file,enabled,description</code> |
| Property | Value |
|----------|------------------------------------------------------------------------|
| Type | <code>[created\|name\|updated\|env\|file\|enabled\|description]</code> |
| Default | <code>name,created,updated,env,file,enabled,description</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/secret/update.md
Generated
+15 -15
View File
@@ -24,40 +24,40 @@ At least one of --value, --description, --env, --file, or --enabled must be spec
### --value
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Update the secret value. For security reasons, prefer non-interactive stdin (pipe or redirect).
### --description
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Update the secret description. Pass an empty string to clear it.
### --env
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Name of the workspace environment variable that this secret will set. Pass an empty string to clear it.
### --file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Workspace file path where this secret will be written. Must start with ~/ or /. Pass an empty string to clear it.
### --enabled
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Whether the secret is injected into workspaces. An enabled secret must keep at least one of --env or --file; pass --enabled=false to stop injecting it without deleting it.
docs/reference/cli/server/create-admin-user.md
Generated
+13 -13
View File
@@ -18,7 +18,7 @@ coder server create-admin-user [flags]
### --postgres-url
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -27,7 +27,7 @@ URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
@@ -37,7 +37,7 @@ Type of auth to use when connecting to postgres.
### --ssh-keygen-algorithm
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
@@ -47,7 +47,7 @@ The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ec
### --username
| | |
| Property | Value |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_USERNAME</code> |
@@ -56,7 +56,7 @@ The username of the new user. If not specified, you will be prompted via stdin.
### --email
| | |
| Property | Value |
|-------------|---------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL</code> |
@@ -65,7 +65,7 @@ The email of the new user. If not specified, you will be prompted via stdin.
### --password
| | |
| Property | Value |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PASSWORD</code> |
@@ -74,17 +74,17 @@ The password of the new user. If not specified, you will be prompted via stdin.
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/server/dbcrypt/decrypt.md
Generated
+6 -6
View File
@@ -18,7 +18,7 @@ coder server dbcrypt decrypt [flags]
### --postgres-url
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -27,7 +27,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
@@ -37,7 +37,7 @@ Type of auth to use when connecting to postgres.
### --keys
| | |
| Property | Value |
|-------------|------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
@@ -46,8 +46,8 @@ Keys required to decrypt existing data. Must be a comma-separated list of base64
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/server/dbcrypt/delete.md
Generated
+5 -5
View File
@@ -22,7 +22,7 @@ coder server dbcrypt delete [flags]
### --postgres-url
| | |
| Property | Value |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL</code> |
@@ -31,7 +31,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
@@ -41,8 +41,8 @@ Type of auth to use when connecting to postgres.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/server/dbcrypt/rotate.md
Generated
+7 -7
View File
@@ -18,7 +18,7 @@ coder server dbcrypt rotate [flags]
### --postgres-url
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -27,7 +27,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
@@ -37,7 +37,7 @@ Type of auth to use when connecting to postgres.
### --new-key
| | |
| Property | Value |
|-------------|---------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_NEW_KEY</code> |
@@ -46,7 +46,7 @@ The new external token encryption key. Must be base64-encoded.
### --old-keys
| | |
| Property | Value |
|-------------|----------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_OLD_KEYS</code> |
@@ -55,8 +55,8 @@ The old external token encryption keys. Must be a comma-separated list of base64
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/server/fix-oidc-links.md
Generated
+8 -8
View File
@@ -18,15 +18,15 @@ coder server fix-oidc-links [flags]
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --postgres-url
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -35,7 +35,7 @@ URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will
### --postgres-connection-auth
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
@@ -45,7 +45,7 @@ Type of auth to use when connecting to postgres.
### --issuer-url
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_ISSUER_URL</code> |
@@ -54,7 +54,7 @@ The OIDC issuer URL. The canonical issuer is resolved via OIDC discovery.
### -n, --dry-run
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_FIX_OIDC_LINKS_DRY_RUN</code> |
@@ -63,7 +63,7 @@ Print analysis only, do not modify the database.
### --force-reset-all
| | |
| Property | Value |
|-------------|----------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_FIX_OIDC_LINKS_FORCE_RESET_ALL</code> |
docs/reference/cli/server/index.md
Generated
+215 -215
View File
File diff suppressed because it is too large Load Diff
docs/reference/cli/server/postgres-builtin-serve.md
Generated
+3 -3
View File
@@ -18,8 +18,8 @@ coder server postgres-builtin-serve [flags]
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/server/postgres-builtin-url.md
Generated
+3 -3
View File
@@ -18,8 +18,8 @@ coder server postgres-builtin-url [flags]
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/sharing/add.md
Generated
+6 -6
View File
@@ -28,16 +28,16 @@ This command fails if workspace sharing is disabled for the deployment, or if th
### --user
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
A comma separated list of users to share the workspace with.
### --group
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
A comma separated list of groups to share the workspace with.
docs/reference/cli/sharing/remove.md
Generated
+6 -6
View File
@@ -29,16 +29,16 @@ This command fails if workspace sharing is disabled for the deployment, or if th
### --user
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
A comma separated list of users to remove from the workspace.
### --group
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
A comma separated list of groups to remove from the workspace.
docs/reference/cli/show.md
Generated
+4 -4
View File
@@ -18,9 +18,9 @@ coder show [flags] <workspace>
### --details
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Show full error messages and additional details.
docs/reference/cli/speedtest.md
Generated
+22 -22
View File
@@ -18,52 +18,52 @@ coder speedtest [flags] <workspace>
### -d, --direct
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Specifies whether to wait for a direct connection before testing speed.
### --direction
| | |
|---------|-----------------------|
| Type | <code>up\|down</code> |
| Default | <code>down</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>up\|down</code> |
| Default | <code>down</code> |
Specifies whether to run in reverse mode where the client receives and the server sends.
### -t, --time
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies the duration to monitor traffic.
### --pcap-file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specifies a file to write a network capture to.
### -c, --column
| | |
|---------|-------------------------------------|
| Type | <code>[Interval\|Throughput]</code> |
| Default | <code>Interval,Throughput</code> |
| Property | Value |
|----------|-------------------------------------|
| Type | <code>[Interval\|Throughput]</code> |
| Default | <code>Interval,Throughput</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/ssh.md
Generated
+21 -21
View File
@@ -28,7 +28,7 @@ This command does not have full parity with the standard SSH command. For users
### --stdio
| | |
| Property | Value |
|-------------|-------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
@@ -37,7 +37,7 @@ Specifies whether to emit SSH output over stdin/stdout.
### -t, --tty
| | |
| Property | Value |
|-------------|-----------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_TTY</code> |
@@ -46,7 +46,7 @@ Request a pseudo-terminal for the SSH session. Interactive shell sessions reques
### --ssh-host-prefix
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_SSH_HOST_PREFIX</code> |
@@ -55,7 +55,7 @@ Strip this prefix from the provided hostname to determine the workspace name. Th
### --hostname-suffix
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_HOSTNAME_SUFFIX</code> |
@@ -64,7 +64,7 @@ Strip this suffix from the provided hostname to determine the workspace name. Th
### -A, --forward-agent
| | |
| Property | Value |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_AGENT</code> |
@@ -73,7 +73,7 @@ Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
### -G, --forward-gpg
| | |
| Property | Value |
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_GPG</code> |
@@ -82,7 +82,7 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
### --identity-agent
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_IDENTITY_AGENT</code> |
@@ -91,7 +91,7 @@ Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent
### --workspace-poll-interval
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
@@ -101,7 +101,7 @@ Specifies how often to poll for workspace automated shutdown.
### --wait
| | |
| Property | Value |
|-------------|------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
@@ -111,7 +111,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --no-wait
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
@@ -120,7 +120,7 @@ Enter workspace immediately after the agent has connected. This is the default i
### -l, --log-dir
| | |
| Property | Value |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
@@ -129,7 +129,7 @@ Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
| Property | Value |
|-------------|----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
@@ -138,7 +138,7 @@ Enable remote port forwarding (remote_port:local_address:local_port).
### -e, --env
| | |
| Property | Value |
|-------------|-----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_ENV</code> |
@@ -147,24 +147,24 @@ Set environment variable(s) for session (key1=value1,key2=value2,...).
### --network-info-dir
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specifies a directory to write network information periodically.
### --network-info-interval
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies the interval to update network information.
### --disable-autostart
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
docs/reference/cli/start.md
Generated
+22 -22
View File
@@ -18,31 +18,31 @@ coder start [flags] <workspace>
### --no-wait
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Return immediately after starting the workspace.
### --template-version
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Start with a version of the workspace template, by name or ID.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --build-option
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -51,15 +51,15 @@ Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -68,7 +68,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -77,7 +77,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| Property | Value |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -86,7 +86,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| Property | Value |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -95,7 +95,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| Property | Value |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -104,7 +104,7 @@ Rich parameter default values in the format "name=value".
### --use-parameter-defaults
| | |
| Property | Value |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
@@ -113,8 +113,8 @@ Automatically accept parameter defaults when no value is provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/reference/cli/stat/cpu.md
Generated
+7 -7
View File
@@ -18,17 +18,17 @@ coder stat cpu [flags]
### --host
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Force host CPU measurement.
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/stat/disk.md
Generated
+12 -12
View File
@@ -18,27 +18,27 @@ coder stat disk [flags]
### --path
| | |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>/</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
| Default | <code>/</code> |
Path for which to check disk usage.
### --prefix
| | |
|---------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
| Property | Value |
|----------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
SI Prefix for disk measurement.
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/stat/index.md
Generated
+8 -8
View File
@@ -26,18 +26,18 @@ coder stat [flags]
### -c, --column
| | |
|---------|----------------------------------------------------------------------------------|
| Type | <code>[host cpu\|host memory\|home disk\|container cpu\|container memory]</code> |
| Default | <code>host cpu,host memory,home disk,container cpu,container memory</code> |
| Property | Value |
|----------|----------------------------------------------------------------------------------|
| Type | <code>[host cpu\|host memory\|home disk\|container cpu\|container memory]</code> |
| Default | <code>host cpu,host memory,home disk,container cpu,container memory</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/stat/mem.md
Generated
+11 -11
View File
@@ -18,26 +18,26 @@ coder stat mem [flags]
### --host
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Force host memory measurement.
### --prefix
| | |
|---------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
| Property | Value |
|----------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
SI Prefix for memory measurement.
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
| Property | Value |
|----------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
docs/reference/cli/state/pull.md
Generated
+3 -3
View File
@@ -18,8 +18,8 @@ coder state pull [flags] <workspace> [file]
### -b, --build
| | |
|------|------------------|
| Type | <code>int</code> |
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.
docs/reference/cli/state/push.md
Generated
+6 -6
View File
@@ -18,16 +18,16 @@ coder state push [flags] <workspace> <file>
### -b, --build
| | |
|------|------------------|
| Type | <code>int</code> |
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.
### -n, --no-build
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Update the state without triggering a workspace build. Useful for state-only migrations.
docs/reference/cli/stop.md
Generated
+6 -6
View File
@@ -18,16 +18,16 @@ coder stop [flags] <workspace>
### --template-version
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Stop with a version of the workspace template, by name or ID. Defaults to the workspace's current version.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
docs/reference/cli/support/bundle.md
Generated
+9 -9
View File
@@ -24,15 +24,15 @@ This command generates a file containing detailed troubleshooting information ab
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --output-file
| | |
| Property | Value |
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_OUTPUT_FILE</code> |
@@ -41,7 +41,7 @@ File path for writing the generated support bundle. Defaults to coder-support-$(
### --url-override
| | |
| Property | Value |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_URL_OVERRIDE</code> |
@@ -50,7 +50,7 @@ Override the URL to your Coder deployment. This may be useful, for example, if y
### --workspaces-total-cap
| | |
| Property | Value |
|-------------|---------------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACES_TOTAL_CAP</code> |
@@ -59,7 +59,7 @@ Maximum number of workspaces to include in the support bundle. Set to 0 or negat
### --template
| | |
| Property | Value |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_TEMPLATE</code> |
@@ -68,7 +68,7 @@ Template name to include in the support bundle. Use org_name/template_name if te
### --workspace-file
| | |
| Property | Value |
|-------------|---------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_WORKSPACE_FILE</code> |
@@ -77,7 +77,7 @@ File path or glob to collect from inside the remote workspace. Environment varia
### --pprof
| | |
| Property | Value |
|-------------|------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_PPROF</code> |
docs/reference/cli/templates/archive.md
Generated
+7 -7
View File
@@ -18,23 +18,23 @@ coder templates archive [flags] [template-name...]
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Include all unused template versions. By default, only failed template versions are archived.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/create.md
Generated
+54 -54
View File
@@ -18,109 +18,109 @@ coder templates create [flags] [name]
### --agents-allowed
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow Coder Agents to create workspaces using this template.
### --private
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
### --variables-file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### --variable
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --var
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Alias of --variable.
### --provisioner-tag
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --default-ttl
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>24h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>24h</code> |
Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### --failure-ttl
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
### --dormancy-threshold
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --dormancy-auto-deletion
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --require-active-version
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -129,26 +129,26 @@ Select which organization (uuid or name) to use.
### -d, --directory
| | |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
Specify the directory to create from, use '-' to read tar from stdin.
### --ignore-lockfile
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
### -m, --message
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
docs/reference/cli/templates/delete.md
Generated
+4 -4
View File
@@ -22,15 +22,15 @@ coder templates delete [flags] [name...]
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/edit.md
Generated
+73 -73
View File
@@ -18,184 +18,184 @@ coder templates edit [flags] <template>
### --name
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Edit the template name.
### --display-name
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Edit the template display name.
### --description
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Edit the template description.
### --deprecated
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
### --icon
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Edit the template icon path.
### --default-ttl
| | |
|------|-----------------------|
| Type | <code>duration</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### --activity-bump
| | |
|------|-----------------------|
| Type | <code>duration</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to "Activity bump" in the UI.
### --autostop-reminder
| | |
|------|-----------------------|
| Type | <code>duration</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
Edit how long before the autostop deadline a reminder notification is sent for workspaces created from this template, in Go duration format (e.g. 1h, 30m). Set to 0 to disable.
### --autostart-requirement-weekdays
| | |
|------|------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|all]</code> |
| Property | Value |
|----------|------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|all]</code> |
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
### --autostop-requirement-weekdays
| | |
|------|-------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|none]</code> |
| Property | Value |
|----------|-------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|none]</code> |
Edit the template autostop requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the autostop requirement for the template), pass 'none'.
### --autostop-requirement-weeks
| | |
|------|------------------|
| Type | <code>int</code> |
| Property | Value |
|----------|------------------|
| Type | <code>int</code> |
Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.
### --failure-ttl
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
### --dormancy-threshold
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --dormancy-auto-deletion
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
| Property | Value |
|----------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --agents-allowed
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow Coder Agents to create workspaces using this template.
### --allow-user-cancel-workspace-jobs
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to cancel in-progress workspace jobs.
### --allow-user-autostart
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to configure autostart for workspaces on this template. This can only be disabled with a Premium license.
### --allow-user-autostop
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled with a Premium license.
### --require-active-version
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is a Premium feature. See https://coder.com/docs/admin/templates/managing-templates#template-update-policies for more details.
### --private
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/init.md
Generated
+3 -3
View File
@@ -18,8 +18,8 @@ coder templates init [flags] [directory]
### --id
| | |
|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>aws-devcontainer\|aws-linux\|aws-windows\|azure-linux\|digitalocean-linux\|docker\|docker-devcontainer\|docker-envbuilder\|gcp-devcontainer\|gcp-linux\|gcp-vm-container\|gcp-windows\|incus\|kubernetes\|kubernetes-devcontainer\|nomad-docker\|quickstart\|scratch</code> |
| Property | Value |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>aws-devcontainer\|aws-linux\|aws-windows\|azure-linux\|digitalocean-linux\|docker\|docker-devcontainer\|docker-envbuilder\|gcp-devcontainer\|gcp-linux\|gcp-vm-container\|gcp-windows\|incus\|kubernetes\|kubernetes-devcontainer\|nomad-docker\|quickstart\|scratch</code> |
Specify a given example template by ID.
docs/reference/cli/templates/list.md
Generated
+8 -8
View File
@@ -22,18 +22,18 @@ coder templates list [flags]
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|created at\|last updated\|organization id\|organization name\|provisioner\|active version id\|used by\|default ttl]</code> |
| Default | <code>name,organization name,last updated,used by</code> |
| Property | Value |
|----------|-----------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|created at\|last updated\|organization id\|organization name\|provisioner\|active version id\|used by\|default ttl]</code> |
| Default | <code>name,organization name,last updated,used by</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/templates/presets/list.md
Generated
+12 -12
View File
@@ -18,15 +18,15 @@ coder templates presets list [flags] <template>
### --template-version
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a template version to list presets for. Defaults to the active version.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -35,18 +35,18 @@ Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------|
| Type | <code>[name\|description\|parameters\|default\|desired prebuild instances]</code> |
| Default | <code>name,description,parameters,default,desired prebuild instances</code> |
| Property | Value |
|----------|-----------------------------------------------------------------------------------|
| Type | <code>[name\|description\|parameters\|default\|desired prebuild instances]</code> |
| Default | <code>name,description,parameters,default,desired prebuild instances</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/templates/pull.md
Generated
+13 -13
View File
@@ -18,39 +18,39 @@ coder templates pull [flags] <name> [destination]
### --tar
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output the template as a tar archive to stdout.
### --zip
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Output the template as a zip archive to stdout.
### --version
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
The name of the template version to pull. Use 'active' to pull the active version, 'latest' to pull the latest version, or the name of the template version to pull.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/push.md
Generated
+43 -43
View File
@@ -18,114 +18,114 @@ coder templates push [flags] [template]
### --variables-file
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### --variable
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --var
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Alias of --variable.
### --provisioner-tag
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
| Property | Value |
|----------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons. If you do not specify any tags, the tags from the active template version will be reused, if available. To remove existing tags, use --provisioner-tag="-".
### --name
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a name for the new template version. It will be automatically generated if not provided.
### --always-prompt
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from active template version.
### --activate
| | |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
Whether the new template will be marked active.
### --display-name
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a display name for the template. Takes precedence over display_name in README.md front matter, if present.
### --icon
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify an icon path or external URL for the template. Takes precedence over icon in README.md front matter, if present.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -d, --directory
| | |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
Specify the directory to create from, use '-' to read tar from stdin.
### --ignore-lockfile
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
| Property | Value |
|----------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
### -m, --message
| | |
|------|---------------------|
| Type | <code>string</code> |
| Property | Value |
|----------|---------------------|
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/versions/archive.md
Generated
+4 -4
View File
@@ -18,15 +18,15 @@ coder templates versions archive [flags] <template-name> [template-version-names
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates/versions/list.md
Generated
+12 -12
View File
@@ -18,15 +18,15 @@ coder templates versions list [flags] <template>
### --include-archived
| | |
|------|-------------------|
| Type | <code>bool</code> |
| Property | Value |
|----------|-------------------|
| Type | <code>bool</code> |
Include archived versions in the result list.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -35,18 +35,18 @@ Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[id\|name\|created at\|created by\|status\|active\|archived]</code> |
| Default | <code>name,created at,created by,status,active</code> |
| Property | Value |
|----------|---------------------------------------------------------------------------|
| Type | <code>[id\|name\|created at\|created by\|status\|active\|archived]</code> |
| Default | <code>name,created at,created by,status,active</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
| Property | Value |
|----------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
docs/reference/cli/templates/versions/promote.md
Generated
+3 -3
View File
@@ -24,7 +24,7 @@ Promote an existing template version to be the active version for the specified
### -t, --template
| | |
| Property | Value |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
@@ -33,7 +33,7 @@ Specify the template name.
### --template-version
| | |
| Property | Value |
|-------------|-------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION_NAME</code> |
@@ -42,7 +42,7 @@ Specify the template version name to promote.
### -O, --org
| | |
| Property | Value |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |

Some files were not shown because too many files have changed in this diff Show More