synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): lighten flags on help page (#9606)

Browse Source
This commit is contained in:
Ammar Bandukwala
2023-09-08 13:43:56 -05:00
committed by GitHub
parent e361f1107b
commit f703a5b34e
62 changed files with 413 additions and 413 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
cli/help.go
View File

@ -60,7 +60,7 @@ var usageTemplate = template.Must(
}, },
"keyword": func(s string) string { "keyword": func(s string) string {
return pretty.Sprint( return pretty.Sprint(
pretty.FgColor(cliui.Color("#0173ff")), pretty.FgColor(cliui.Color("#87ceeb")),
s, s,
) )
}, },

20
cli/testdata/coder_--help.golden vendored
View File

@ -53,38 +53,38 @@ coder v0.0.0-devel
Global options are applied to all commands. They can be set using environment Global options are applied to all commands. They can be set using environment
variables or flags. variables or flags.
--debug-options bool --debug-options bool
Print all options, how they're set, then exit. Print all options, how they're set, then exit.
--disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS --disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS
Disable direct (P2P) connections to workspaces. Disable direct (P2P) connections to workspaces.
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2) --global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
Path to the global `coder` config directory. Path to the global `coder` config directory.
--header string-array, $CODER_HEADER --header string-array, $CODER_HEADER
Additional HTTP headers added to all requests. Provide as key=value. Additional HTTP headers added to all requests. Provide as key=value.
Can be specified multiple times. Can be specified multiple times.
--header-command string, $CODER_HEADER_COMMAND --header-command string, $CODER_HEADER_COMMAND
An external command that outputs additional HTTP headers added to all An external command that outputs additional HTTP headers added to all
requests. The command must output each header as `key=value` on its requests. The command must output each header as `key=value` on its
own line. own line.
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING --no-feature-warning bool, $CODER_NO_FEATURE_WARNING
Suppress warnings about unlicensed features. Suppress warnings about unlicensed features.
--no-version-warning bool, $CODER_NO_VERSION_WARNING --no-version-warning bool, $CODER_NO_VERSION_WARNING
Suppress warning when client and server versions do not match. Suppress warning when client and server versions do not match.
--token string, $CODER_SESSION_TOKEN --token string, $CODER_SESSION_TOKEN
Specify an authentication token. For security reasons setting Specify an authentication token. For security reasons setting
CODER_SESSION_TOKEN is preferred. CODER_SESSION_TOKEN is preferred.
--url url, $CODER_URL --url url, $CODER_URL
URL to a deployment. URL to a deployment.
-v, --verbose bool, $CODER_VERBOSE -v, --verbose bool, $CODER_VERBOSE
Enable verbose output. Enable verbose output.
——— ———

22
cli/testdata/coder_agent_--help.golden vendored
View File

@ -6,38 +6,38 @@ coder v0.0.0-devel
Starts the Coder workspace agent. Starts the Coder workspace agent.
OPTIONS: OPTIONS:
--log-human string, $CODER_AGENT_LOGGING_HUMAN (default: /dev/stderr) --log-human string, $CODER_AGENT_LOGGING_HUMAN (default: /dev/stderr)
Output human-readable logs to a given file. Output human-readable logs to a given file.
--log-json string, $CODER_AGENT_LOGGING_JSON --log-json string, $CODER_AGENT_LOGGING_JSON
Output JSON logs to a given file. Output JSON logs to a given file.
--log-stackdriver string, $CODER_AGENT_LOGGING_STACKDRIVER --log-stackdriver string, $CODER_AGENT_LOGGING_STACKDRIVER
Output Stackdriver compatible logs to a given file. Output Stackdriver compatible logs to a given file.
--auth string, $CODER_AGENT_AUTH (default: token) --auth string, $CODER_AGENT_AUTH (default: token)
Specify the authentication type to use for the agent. Specify the authentication type to use for the agent.
--debug-address string, $CODER_AGENT_DEBUG_ADDRESS (default: 127.0.0.1:2113) --debug-address string, $CODER_AGENT_DEBUG_ADDRESS (default: 127.0.0.1:2113)
The bind address to serve a debug HTTP server. The bind address to serve a debug HTTP server.
--log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp) --log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp)
Specify the location for the agent log files. Specify the location for the agent log files.
--no-reap bool --no-reap bool
Do not start a process reaper. Do not start a process reaper.
--pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060) --pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060)
The address to serve pprof. The address to serve pprof.
--prometheus-address string, $CODER_AGENT_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112) --prometheus-address string, $CODER_AGENT_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
The bind address to serve Prometheus metrics. The bind address to serve Prometheus metrics.
--ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 72h) --ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 72h)
Specify the max timeout for a SSH connection, it is advisable to set Specify the max timeout for a SSH connection, it is advisable to set
it to a minimum of 60s, but no more than 72h. it to a minimum of 60s, but no more than 72h.
--tailnet-listen-port int, $CODER_AGENT_TAILNET_LISTEN_PORT (default: 0) --tailnet-listen-port int, $CODER_AGENT_TAILNET_LISTEN_PORT (default: 0)
Specify a static port for Tailscale to use for listening. Specify a static port for Tailscale to use for listening.
——— ———

18
cli/testdata/coder_config-ssh_--help.golden vendored
View File

@ -16,39 +16,39 @@ coder v0.0.0-devel
$ coder config-ssh --dry-run $ coder config-ssh --dry-run
OPTIONS: OPTIONS:
--coder-binary-path string, $CODER_SSH_CONFIG_BINARY_PATH --coder-binary-path string, $CODER_SSH_CONFIG_BINARY_PATH
Optionally specify the absolute path to the coder binary used in Optionally specify the absolute path to the coder binary used in
ProxyCommand. By default, the binary invoking this command ('config ProxyCommand. By default, the binary invoking this command ('config
ssh') is used. ssh') is used.
-n, --dry-run bool, $CODER_SSH_DRY_RUN -n, --dry-run bool, $CODER_SSH_DRY_RUN
Perform a trial run with no changes made, showing a diff at the end. Perform a trial run with no changes made, showing a diff at the end.
--force-unix-filepaths bool, $CODER_CONFIGSSH_UNIX_FILEPATHS --force-unix-filepaths bool, $CODER_CONFIGSSH_UNIX_FILEPATHS
By default, 'config-ssh' uses the os path separator when writing the By default, 'config-ssh' uses the os path separator when writing the
ssh config. This might be an issue in Windows machine that use a ssh config. This might be an issue in Windows machine that use a
unix-like shell. This flag forces the use of unix file paths (the unix-like shell. This flag forces the use of unix file paths (the
forward slash '/'). forward slash '/').
--ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config) --ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config)
Specifies the path to an SSH config. Specifies the path to an SSH config.
--ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX --ssh-host-prefix string, $CODER_CONFIGSSH_SSH_HOST_PREFIX
Override the default host prefix. Override the default host prefix.
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS -o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
Specifies additional SSH options to embed in each host stanza. Specifies additional SSH options to embed in each host stanza.
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS --use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
Specifies whether or not to keep options from previous run of Specifies whether or not to keep options from previous run of
config-ssh. config-ssh.
--wait yes|no|auto, $CODER_CONFIGSSH_WAIT (default: auto) --wait yes|no|auto, $CODER_CONFIGSSH_WAIT (default: auto)
Specifies whether or not to wait for the startup script to finish Specifies whether or not to wait for the startup script to finish
executing. Auto means that the agent startup script behavior executing. Auto means that the agent startup script behavior
configured in the workspace template is used. configured in the workspace template is used.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

12
cli/testdata/coder_create_--help.golden vendored
View File

@ -10,25 +10,25 @@ coder v0.0.0-devel
$ coder create <username>/<workspace_name> $ coder create <username>/<workspace_name>
OPTIONS: OPTIONS:
--parameter string-array, $CODER_RICH_PARAMETER --parameter string-array, $CODER_RICH_PARAMETER
Rich parameter value in the format "name=value". Rich parameter value in the format "name=value".
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the Specify a file path with values for rich parameters defined in the
template. template.
--start-at string, $CODER_WORKSPACE_START_AT --start-at string, $CODER_WORKSPACE_START_AT
Specify the workspace autostart schedule. Check coder schedule start Specify the workspace autostart schedule. Check coder schedule start
--help for the syntax. --help for the syntax.
--stop-after duration, $CODER_WORKSPACE_STOP_AFTER --stop-after duration, $CODER_WORKSPACE_STOP_AFTER
Specify a duration after which the workspace should shut down (e.g. Specify a duration after which the workspace should shut down (e.g.
8h). 8h).
-t, --template string, $CODER_TEMPLATE_NAME -t, --template string, $CODER_TEMPLATE_NAME
Specify a template name. Specify a template name.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

4
cli/testdata/coder_delete_--help.golden vendored
View File

@ -8,12 +8,12 @@ coder v0.0.0-devel
Aliases: rm Aliases: rm
OPTIONS: OPTIONS:
--orphan bool --orphan bool
Delete a workspace without deleting its resources. This can delete a Delete a workspace without deleting its resources. This can delete a
workspace in a broken state, but may also lead to unaccounted cloud workspace in a broken state, but may also lead to unaccounted cloud
resources. resources.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

6
cli/testdata/coder_dotfiles_--help.golden vendored
View File

@ -10,16 +10,16 @@ coder v0.0.0-devel
$ coder dotfiles --yes git@github.com:example/dotfiles.git $ coder dotfiles --yes git@github.com:example/dotfiles.git
OPTIONS: OPTIONS:
-b, --branch string -b, --branch string
Specifies which branch to clone. If empty, will default to cloning the Specifies which branch to clone. If empty, will default to cloning the
default branch or using the existing branch in the cloned repo on default branch or using the existing branch in the cloned repo on
disk. disk.
--symlink-dir string, $CODER_SYMLINK_DIR --symlink-dir string, $CODER_SYMLINK_DIR
Specifies the directory for the dotfiles symlink destinations. If Specifies the directory for the dotfiles symlink destinations. If
empty, will use $HOME. empty, will use $HOME.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

8
cli/testdata/coder_list_--help.golden vendored
View File

@ -8,18 +8,18 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-a, --all bool -a, --all bool
Specifies whether all workspaces will be listed or not. Specifies whether all workspaces will be listed or not.
-c, --column string-array (default: workspace,template,status,healthy,last built,outdated,starts at,stops after) -c, --column string-array (default: workspace,template,status,healthy,last built,outdated,starts at,stops after)
Columns to display in table output. Available columns: workspace, Columns to display in table output. Available columns: workspace,
template, status, healthy, last built, outdated, starts at, stops template, status, healthy, last built, outdated, starts at, stops
after, daily cost. after, daily cost.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
--search string (default: owner:me) --search string (default: owner:me)
Search for a workspace with a query. Search for a workspace with a query.
——— ———

10
cli/testdata/coder_login_--help.golden vendored
View File

@ -6,23 +6,23 @@ coder v0.0.0-devel
Authenticate with Coder deployment Authenticate with Coder deployment
OPTIONS: OPTIONS:
--first-user-email string, $CODER_FIRST_USER_EMAIL --first-user-email string, $CODER_FIRST_USER_EMAIL
Specifies an email address to use if creating the first user for the Specifies an email address to use if creating the first user for the
deployment. deployment.
--first-user-password string, $CODER_FIRST_USER_PASSWORD --first-user-password string, $CODER_FIRST_USER_PASSWORD
Specifies a password to use if creating the first user for the Specifies a password to use if creating the first user for the
deployment. deployment.
--first-user-trial bool, $CODER_FIRST_USER_TRIAL --first-user-trial bool, $CODER_FIRST_USER_TRIAL
Specifies whether a trial license should be provisioned for the Coder Specifies whether a trial license should be provisioned for the Coder
deployment or not. deployment or not.
--first-user-username string, $CODER_FIRST_USER_USERNAME --first-user-username string, $CODER_FIRST_USER_USERNAME
Specifies a username to use if creating the first user for the Specifies a username to use if creating the first user for the
deployment. deployment.
--use-token-as-session bool --use-token-as-session bool
By default, the CLI will generate a new session token when logging in. 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. This flag will instead use the provided token as the session token.

2
cli/testdata/coder_logout_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Unauthenticate your local session Unauthenticate your local session
OPTIONS: OPTIONS:
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

6
cli/testdata/coder_ping_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Ping a workspace Ping a workspace
OPTIONS: OPTIONS:
-n, --num int (default: 10) -n, --num int (default: 10)
Specifies the number of pings to perform. Specifies the number of pings to perform.
-t, --timeout duration (default: 5s) -t, --timeout duration (default: 5s)
Specifies how long to wait for a ping to complete. Specifies how long to wait for a ping to complete.
--wait duration (default: 1s) --wait duration (default: 1s)
Specifies how long to wait between pings. Specifies how long to wait between pings.
——— ———

4
cli/testdata/coder_port-forward_--help.golden vendored
View File

@ -34,10 +34,10 @@ coder v0.0.0-devel
$ coder port-forward <workspace> --tcp 1.2.3.4:8080:8080 $ coder port-forward <workspace> --tcp 1.2.3.4:8080:8080
OPTIONS: OPTIONS:
-p, --tcp string-array, $CODER_PORT_FORWARD_TCP -p, --tcp string-array, $CODER_PORT_FORWARD_TCP
Forward TCP port(s) from the workspace to the local machine. Forward TCP port(s) from the workspace to the local machine.
--udp string-array, $CODER_PORT_FORWARD_UDP --udp string-array, $CODER_PORT_FORWARD_UDP
Forward UDP port(s) from the workspace to the local machine. The UDP Forward UDP port(s) from the workspace to the local machine. The UDP
connection has TCP-like semantics to support stateful UDP protocols. connection has TCP-like semantics to support stateful UDP protocols.

4
cli/testdata/coder_publickey_--help.golden vendored
View File

@ -8,11 +8,11 @@ coder v0.0.0-devel
Aliases: pubkey Aliases: pubkey
OPTIONS: OPTIONS:
--reset bool --reset bool
Regenerate your public key. This will require updating the key on any Regenerate your public key. This will require updating the key on any
services it's registered with. services it's registered with.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

2
cli/testdata/coder_rename_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Rename a workspace Rename a workspace
OPTIONS: OPTIONS:
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

2
cli/testdata/coder_reset-password_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Directly connect to the database to reset a user's password Directly connect to the database to reset a user's password
OPTIONS: OPTIONS:
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database to connect to. URL of a PostgreSQL database to connect to.
——— ———

6
cli/testdata/coder_restart_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Restart a workspace Restart a workspace
OPTIONS: OPTIONS:
--build-option string-array, $CODER_BUILD_OPTION --build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value". Build option value in the format "name=value".
--build-options bool --build-options bool
Prompt for one-time build options defined with ephemeral parameters. Prompt for one-time build options defined with ephemeral parameters.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

200
cli/testdata/coder_server_--help.golden vendored
View File

@ -14,42 +14,42 @@ coder v0.0.0-devel
PostgreSQL deployment. PostgreSQL deployment.
OPTIONS: OPTIONS:
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir]) --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
The directory to cache temporary files. If unspecified and The directory to cache temporary files. If unspecified and
$CACHE_DIRECTORY is set, it will be used for compatibility with $CACHE_DIRECTORY is set, it will be used for compatibility with
systemd. systemd.
--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS --disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS
Remove the permission for the 'owner' role to have workspace execution Remove the permission for the 'owner' role to have workspace execution
on all workspaces. This prevents the 'owner' from ssh, apps, and on all workspaces. This prevents the 'owner' from ssh, apps, and
terminal access based on the 'owner' role. They still have their user terminal access based on the 'owner' role. They still have their user
permissions to access their own workspaces. permissions to access their own workspaces.
--disable-path-apps bool, $CODER_DISABLE_PATH_APPS --disable-path-apps bool, $CODER_DISABLE_PATH_APPS
Disable workspace apps that are not served from subdomains. Path-based Disable workspace apps that are not served from subdomains. Path-based
apps can make requests to the Coder API and pose a security risk when apps can make requests to the Coder API and pose a security risk when
the workspace serves malicious JavaScript. This is recommended for the workspace serves malicious JavaScript. This is recommended for
security purposes if a --wildcard-access-url is configured. security purposes if a --wildcard-access-url is configured.
--swagger-enable bool, $CODER_SWAGGER_ENABLE --swagger-enable bool, $CODER_SWAGGER_ENABLE
Expose the swagger endpoint via /swagger. Expose the swagger endpoint via /swagger.
--experiments string-array, $CODER_EXPERIMENTS --experiments string-array, $CODER_EXPERIMENTS
Enable one or more experiments. These are not ready for production. Enable one or more experiments. These are not ready for production.
Separate multiple experiments with commas, or enter '*' to opt-in to Separate multiple experiments with commas, or enter '*' to opt-in to
all available experiments. all available experiments.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
downloaded from Maven (https://repo1.maven.org/maven2) and store all downloaded from Maven (https://repo1.maven.org/maven2) and store all
data in the config root. Access the built-in database with "coder data in the config root. Access the built-in database with "coder
server postgres-builtin-url". server postgres-builtin-url".
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519) --ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
The algorithm to use for generating ssh keys. Accepted values are The algorithm to use for generating ssh keys. Accepted values are
"ed25519", "ecdsa", or "rsa4096". "ed25519", "ecdsa", or "rsa4096".
--update-check bool, $CODER_UPDATE_CHECK (default: false) --update-check bool, $CODER_UPDATE_CHECK (default: false)
Periodically check for new releases of Coder and inform the owner. The Periodically check for new releases of Coder and inform the owner. The
check is performed once per day. check is performed once per day.
@ -57,99 +57,99 @@ coder v0.0.0-devel
These options change the behavior of how clients interact with the Coder. These options change the behavior of how clients interact with the Coder.
Clients include the coder cli, vs code extension, and the web UI. Clients include the coder cli, vs code extension, and the web UI.
--ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS --ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS
These SSH config options will override the default SSH config options. These SSH config options will override the default SSH config options.
Provide options in "key=value" or "key value" format separated by Provide options in "key=value" or "key value" format separated by
commas.Using this incorrectly can break SSH to your deployment, use commas.Using this incorrectly can break SSH to your deployment, use
cautiously. cautiously.
--ssh-hostname-prefix string, $CODER_SSH_HOSTNAME_PREFIX (default: coder.) --ssh-hostname-prefix string, $CODER_SSH_HOSTNAME_PREFIX (default: coder.)
The SSH deployment prefix is used in the Host of the ssh config. The SSH deployment prefix is used in the Host of the ssh config.
CONFIG OPTIONS: CONFIG OPTIONS:
Use a YAML configuration file when your server launch become unwieldy. Use a YAML configuration file when your server launch become unwieldy.
-c, --config yaml-config-path, $CODER_CONFIG_PATH -c, --config yaml-config-path, $CODER_CONFIG_PATH
Specify a YAML file to load configuration from. Specify a YAML file to load configuration from.
--write-config bool --write-config bool
Write out the current server config as YAML to stdout. Write out the current server config as YAML to stdout.
INTROSPECTION / LOGGING OPTIONS: INTROSPECTION / LOGGING OPTIONS:
--enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false) --enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false)
Allow administrators to enable Terraform debug output. Allow administrators to enable Terraform debug output.
--log-human string, $CODER_LOGGING_HUMAN (default: /dev/stderr) --log-human string, $CODER_LOGGING_HUMAN (default: /dev/stderr)
Output human-readable logs to a given file. Output human-readable logs to a given file.
--log-json string, $CODER_LOGGING_JSON --log-json string, $CODER_LOGGING_JSON
Output JSON logs to a given file. Output JSON logs to a given file.
-l, --log-filter string-array, $CODER_LOG_FILTER -l, --log-filter string-array, $CODER_LOG_FILTER
Filter debug logs by matching against a given regex. Use .* to match Filter debug logs by matching against a given regex. Use .* to match
all debug logs. all debug logs.
--log-stackdriver string, $CODER_LOGGING_STACKDRIVER --log-stackdriver string, $CODER_LOGGING_STACKDRIVER
Output Stackdriver compatible logs to a given file. Output Stackdriver compatible logs to a given file.
INTROSPECTION / PROMETHEUS OPTIONS: INTROSPECTION / PROMETHEUS OPTIONS:
--prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112) --prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
The bind address to serve prometheus metrics. The bind address to serve prometheus metrics.
--prometheus-collect-agent-stats bool, $CODER_PROMETHEUS_COLLECT_AGENT_STATS --prometheus-collect-agent-stats bool, $CODER_PROMETHEUS_COLLECT_AGENT_STATS
Collect agent stats (may increase charges for metrics storage). Collect agent stats (may increase charges for metrics storage).
--prometheus-collect-db-metrics bool, $CODER_PROMETHEUS_COLLECT_DB_METRICS (default: false) --prometheus-collect-db-metrics bool, $CODER_PROMETHEUS_COLLECT_DB_METRICS (default: false)
Collect database metrics (may increase charges for metrics storage). Collect database metrics (may increase charges for metrics storage).
--prometheus-enable bool, $CODER_PROMETHEUS_ENABLE --prometheus-enable bool, $CODER_PROMETHEUS_ENABLE
Serve prometheus metrics on the address defined by prometheus address. Serve prometheus metrics on the address defined by prometheus address.
INTROSPECTION / TRACING OPTIONS: INTROSPECTION / TRACING OPTIONS:
--trace-logs bool, $CODER_TRACE_LOGS --trace-logs bool, $CODER_TRACE_LOGS
Enables capturing of logs as events in traces. This is useful for Enables capturing of logs as events in traces. This is useful for
debugging, but may result in a very large amount of events being sent debugging, but may result in a very large amount of events being sent
to the tracing backend which may incur significant costs. to the tracing backend which may incur significant costs.
--trace bool, $CODER_TRACE_ENABLE --trace bool, $CODER_TRACE_ENABLE
Whether application tracing data is collected. It exports to a backend Whether application tracing data is collected. It exports to a backend
configured by environment variables. See: configured by environment variables. See:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md. https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY --trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
Enables trace exporting to Honeycomb.io using the provided API Key. Enables trace exporting to Honeycomb.io using the provided API Key.
INTROSPECTION / PPROF OPTIONS: INTROSPECTION / PPROF OPTIONS:
--pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060) --pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060)
The bind address to serve pprof. The bind address to serve pprof.
--pprof-enable bool, $CODER_PPROF_ENABLE --pprof-enable bool, $CODER_PPROF_ENABLE
Serve pprof metrics on the address defined by pprof address. Serve pprof metrics on the address defined by pprof address.
NETWORKING OPTIONS: NETWORKING OPTIONS:
--access-url url, $CODER_ACCESS_URL --access-url url, $CODER_ACCESS_URL
The URL that users will use to access the Coder deployment. The URL that users will use to access the Coder deployment.
--docs-url url, $CODER_DOCS_URL --docs-url url, $CODER_DOCS_URL
Specifies the custom docs URL. Specifies the custom docs URL.
--proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS --proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
True-Client-Ip, X-Forwarded-For. True-Client-Ip, X-Forwarded-For.
--proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS --proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS
Origin addresses to respect "proxy-trusted-headers". e.g. Origin addresses to respect "proxy-trusted-headers". e.g.
192.168.1.0/24. 192.168.1.0/24.
--redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL --redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL
Specifies whether to redirect requests that do not match the access Specifies whether to redirect requests that do not match the access
URL host. URL host.
--secure-auth-cookie bool, $CODER_SECURE_AUTH_COOKIE --secure-auth-cookie bool, $CODER_SECURE_AUTH_COOKIE
Controls if the 'Secure' property is set on browser session cookies. Controls if the 'Secure' property is set on browser session cookies.
--wildcard-access-url url, $CODER_WILDCARD_ACCESS_URL --wildcard-access-url url, $CODER_WILDCARD_ACCESS_URL
Specifies the wildcard hostname to use for workspace applications in Specifies the wildcard hostname to use for workspace applications in
the form "*.example.com". the form "*.example.com".
@ -159,7 +159,7 @@ between workspaces and users are peer-to-peer. However, when Coder cannot
establish a peer to peer connection, Coder uses a distributed relay network establish a peer to peer connection, Coder uses a distributed relay network
backed by Tailscale and WireGuard. backed by Tailscale and WireGuard.
--block-direct-connections bool, $CODER_BLOCK_DIRECT --block-direct-connections bool, $CODER_BLOCK_DIRECT
Block peer-to-peer (aka. direct) workspace connections. All workspace Block peer-to-peer (aka. direct) workspace connections. All workspace
connections from the CLI will be proxied through Coder (or custom connections from the CLI will be proxied through Coder (or custom
configured DERP servers) and will never be peer-to-peer when enabled. configured DERP servers) and will never be peer-to-peer when enabled.
@ -167,28 +167,28 @@ backed by Tailscale and WireGuard.
until they are restarted after this change has been made, but new until they are restarted after this change has been made, but new
connections will still be proxied regardless. connections will still be proxied regardless.
--derp-config-path string, $CODER_DERP_CONFIG_PATH --derp-config-path string, $CODER_DERP_CONFIG_PATH
Path to read a DERP mapping from. See: Path to read a DERP mapping from. See:
https://tailscale.com/kb/1118/custom-derp-servers/. https://tailscale.com/kb/1118/custom-derp-servers/.
--derp-config-url string, $CODER_DERP_CONFIG_URL --derp-config-url string, $CODER_DERP_CONFIG_URL
URL to fetch a DERP mapping on startup. See: URL to fetch a DERP mapping on startup. See:
https://tailscale.com/kb/1118/custom-derp-servers/. https://tailscale.com/kb/1118/custom-derp-servers/.
--derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS --derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS
Force clients and agents to always use WebSocket to connect to DERP Force clients and agents to always use WebSocket to connect to DERP
relay servers. By default, DERP uses `Upgrade: derp`, which may cause relay servers. By default, DERP uses `Upgrade: derp`, which may cause
issues with some reverse proxies. Clients may automatically fallback issues with some reverse proxies. Clients may automatically fallback
to WebSocket if they detect an issue with `Upgrade: derp`, but this to WebSocket if they detect an issue with `Upgrade: derp`, but this
does not work in all situations. does not work in all situations.
--derp-server-enable bool, $CODER_DERP_SERVER_ENABLE (default: true) --derp-server-enable bool, $CODER_DERP_SERVER_ENABLE (default: true)
Whether to enable or disable the embedded DERP relay server. Whether to enable or disable the embedded DERP relay server.
--derp-server-region-name string, $CODER_DERP_SERVER_REGION_NAME (default: Coder Embedded Relay) --derp-server-region-name string, $CODER_DERP_SERVER_REGION_NAME (default: Coder Embedded Relay)
Region name that for the embedded DERP server. Region name that for the embedded DERP server.
--derp-server-stun-addresses string-array, $CODER_DERP_SERVER_STUN_ADDRESSES (default: stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302) --derp-server-stun-addresses string-array, $CODER_DERP_SERVER_STUN_ADDRESSES (default: stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302)
Addresses for STUN servers to establish P2P connections. It's Addresses for STUN servers to establish P2P connections. It's
recommended to have at least two STUN servers to give users the best recommended to have at least two STUN servers to give users the best
chance of connecting P2P to workspaces. Each STUN server will get it's chance of connecting P2P to workspaces. Each STUN server will get it's
@ -196,7 +196,7 @@ backed by Tailscale and WireGuard.
+ 1`. Use special value 'disable' to turn off STUN completely. + 1`. Use special value 'disable' to turn off STUN completely.
NETWORKING / HTTP OPTIONS: NETWORKING / HTTP OPTIONS:
--disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH --disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH
Disable password authentication. This is recommended for security Disable password authentication. This is recommended for security
purposes in production deployments that rely on an identity provider. purposes in production deployments that rely on an identity provider.
Any user with the owner role will be able to sign in with their Any user with the owner role will be able to sign in with their
@ -205,23 +205,23 @@ backed by Tailscale and WireGuard.
create-admin` command to create a new admin user directly in the create-admin` command to create a new admin user directly in the
database. database.
--disable-session-expiry-refresh bool, $CODER_DISABLE_SESSION_EXPIRY_REFRESH --disable-session-expiry-refresh bool, $CODER_DISABLE_SESSION_EXPIRY_REFRESH
Disable automatic session expiry bumping due to activity. This forces Disable automatic session expiry bumping due to activity. This forces
all sessions to become invalid after the session expiry duration has all sessions to become invalid after the session expiry duration has
been reached. been reached.
--http-address string, $CODER_HTTP_ADDRESS (default: 127.0.0.1:3000) --http-address string, $CODER_HTTP_ADDRESS (default: 127.0.0.1:3000)
HTTP bind address of the server. Unset to disable the HTTP endpoint. HTTP bind address of the server. Unset to disable the HTTP endpoint.
--max-token-lifetime duration, $CODER_MAX_TOKEN_LIFETIME (default: 876600h0m0s) --max-token-lifetime duration, $CODER_MAX_TOKEN_LIFETIME (default: 876600h0m0s)
The maximum lifetime duration users can specify when creating an API The maximum lifetime duration users can specify when creating an API
token. token.
--proxy-health-interval duration, $CODER_PROXY_HEALTH_INTERVAL (default: 1m0s) --proxy-health-interval duration, $CODER_PROXY_HEALTH_INTERVAL (default: 1m0s)
The interval in which coderd should be checking the status of The interval in which coderd should be checking the status of
workspace proxies. workspace proxies.
--session-duration duration, $CODER_SESSION_DURATION (default: 24h0m0s) --session-duration duration, $CODER_SESSION_DURATION (default: 24h0m0s)
The token expiry duration for browser sessions. Sessions may last The token expiry duration for browser sessions. Sessions may last
longer if they are actively making requests, but this functionality longer if they are actively making requests, but this functionality
can be disabled via --disable-session-expiry-refresh. can be disabled via --disable-session-expiry-refresh.
@ -231,178 +231,178 @@ Configure TLS / HTTPS for your Coder deployment. If you're running Coder behind
a TLS-terminating reverse proxy or are accessing Coder over a secure link, you a TLS-terminating reverse proxy or are accessing Coder over a secure link, you
can safely ignore these settings. can safely ignore these settings.
--strict-transport-security int, $CODER_STRICT_TRANSPORT_SECURITY (default: 0) --strict-transport-security int, $CODER_STRICT_TRANSPORT_SECURITY (default: 0)
Controls if the 'Strict-Transport-Security' header is set on all Controls if the 'Strict-Transport-Security' header is set on all
static file responses. This header should only be set if the server is static file responses. This header should only be set if the server is
accessed via HTTPS. This value is the MaxAge in seconds of the header. accessed via HTTPS. This value is the MaxAge in seconds of the header.
--strict-transport-security-options string-array, $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS --strict-transport-security-options string-array, $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS
Two optional fields can be set in the Strict-Transport-Security Two optional fields can be set in the Strict-Transport-Security
header; 'includeSubDomains' and 'preload'. The header; 'includeSubDomains' and 'preload'. The
'strict-transport-security' flag must be set to a non-zero value for 'strict-transport-security' flag must be set to a non-zero value for
these options to be used. these options to be used.
--tls-address host:port, $CODER_TLS_ADDRESS (default: 127.0.0.1:3443) --tls-address host:port, $CODER_TLS_ADDRESS (default: 127.0.0.1:3443)
HTTPS bind address of the server. HTTPS bind address of the server.
--tls-cert-file string-array, $CODER_TLS_CERT_FILE --tls-cert-file string-array, $CODER_TLS_CERT_FILE
Path to each certificate for TLS. It requires a PEM-encoded file. To Path to each certificate for TLS. It requires a PEM-encoded file. To
configure the listener to use a CA certificate, concatenate the configure the listener to use a CA certificate, concatenate the
primary certificate and the CA certificate together. The primary primary certificate and the CA certificate together. The primary
certificate should appear first in the combined file. certificate should appear first in the combined file.
--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none) --tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
Policy the server will follow for TLS Client Authentication. Accepted Policy the server will follow for TLS Client Authentication. Accepted
values are "none", "request", "require-any", "verify-if-given", or values are "none", "request", "require-any", "verify-if-given", or
"require-and-verify". "require-and-verify".
--tls-client-ca-file string, $CODER_TLS_CLIENT_CA_FILE --tls-client-ca-file string, $CODER_TLS_CLIENT_CA_FILE
PEM-encoded Certificate Authority file used for checking the PEM-encoded Certificate Authority file used for checking the
authenticity of client. authenticity of client.
--tls-client-cert-file string, $CODER_TLS_CLIENT_CERT_FILE --tls-client-cert-file string, $CODER_TLS_CLIENT_CERT_FILE
Path to certificate for client TLS authentication. It requires a Path to certificate for client TLS authentication. It requires a
PEM-encoded file. PEM-encoded file.
--tls-client-key-file string, $CODER_TLS_CLIENT_KEY_FILE --tls-client-key-file string, $CODER_TLS_CLIENT_KEY_FILE
Path to key for client TLS authentication. It requires a PEM-encoded Path to key for client TLS authentication. It requires a PEM-encoded
file. file.
--tls-enable bool, $CODER_TLS_ENABLE --tls-enable bool, $CODER_TLS_ENABLE
Whether TLS will be enabled. Whether TLS will be enabled.
--tls-key-file string-array, $CODER_TLS_KEY_FILE --tls-key-file string-array, $CODER_TLS_KEY_FILE
Paths to the private keys for each of the certificates. It requires a Paths to the private keys for each of the certificates. It requires a
PEM-encoded file. PEM-encoded file.
--tls-min-version string, $CODER_TLS_MIN_VERSION (default: tls12) --tls-min-version string, $CODER_TLS_MIN_VERSION (default: tls12)
Minimum supported version of TLS. Accepted values are "tls10", Minimum supported version of TLS. Accepted values are "tls10",
"tls11", "tls12" or "tls13". "tls11", "tls12" or "tls13".
OAUTH2 / GITHUB OPTIONS: OAUTH2 / GITHUB OPTIONS:
--oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE --oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE
Allow all logins, setting this option means allowed orgs and teams Allow all logins, setting this option means allowed orgs and teams
must be empty. must be empty.
--oauth2-github-allow-signups bool, $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS --oauth2-github-allow-signups bool, $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS
Whether new users can sign up with GitHub. Whether new users can sign up with GitHub.
--oauth2-github-allowed-orgs string-array, $CODER_OAUTH2_GITHUB_ALLOWED_ORGS --oauth2-github-allowed-orgs string-array, $CODER_OAUTH2_GITHUB_ALLOWED_ORGS
Organizations the user must be a member of to Login with GitHub. Organizations the user must be a member of to Login with GitHub.
--oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS --oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS
Teams inside organizations the user must be a member of to Login with Teams inside organizations the user must be a member of to Login with
GitHub. Structured as: <organization-name>/<team-slug>. GitHub. Structured as: <organization-name>/<team-slug>.
--oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID --oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID
Client ID for Login with GitHub. Client ID for Login with GitHub.
--oauth2-github-client-secret string, $CODER_OAUTH2_GITHUB_CLIENT_SECRET --oauth2-github-client-secret string, $CODER_OAUTH2_GITHUB_CLIENT_SECRET
Client secret for Login with GitHub. Client secret for Login with GitHub.
--oauth2-github-enterprise-base-url string, $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL --oauth2-github-enterprise-base-url string, $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL
Base URL of a GitHub Enterprise deployment to use for Login with Base URL of a GitHub Enterprise deployment to use for Login with
GitHub. GitHub.
OIDC OPTIONS: OIDC OPTIONS:
--oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false) --oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false)
Automatically creates missing groups from a user's groups claim. Automatically creates missing groups from a user's groups claim.
--oidc-allow-signups bool, $CODER_OIDC_ALLOW_SIGNUPS (default: true) --oidc-allow-signups bool, $CODER_OIDC_ALLOW_SIGNUPS (default: true)
Whether new users can sign up with OIDC. Whether new users can sign up with OIDC.
--oidc-auth-url-params struct[map[string]string], $CODER_OIDC_AUTH_URL_PARAMS (default: {"access_type": "offline"}) --oidc-auth-url-params struct[map[string]string], $CODER_OIDC_AUTH_URL_PARAMS (default: {"access_type": "offline"})
OIDC auth URL parameters to pass to the upstream provider. OIDC auth URL parameters to pass to the upstream provider.
--oidc-client-cert-file string, $CODER_OIDC_CLIENT_CERT_FILE --oidc-client-cert-file string, $CODER_OIDC_CLIENT_CERT_FILE
Pem encoded certificate file to use for oauth2 PKI/JWT authorization. Pem encoded certificate file to use for oauth2 PKI/JWT authorization.
The public certificate that accompanies oidc-client-key-file. A The public certificate that accompanies oidc-client-key-file. A
standard x509 certificate is expected. standard x509 certificate is expected.
--oidc-client-id string, $CODER_OIDC_CLIENT_ID --oidc-client-id string, $CODER_OIDC_CLIENT_ID
Client ID to use for Login with OIDC. Client ID to use for Login with OIDC.
--oidc-client-key-file string, $CODER_OIDC_CLIENT_KEY_FILE --oidc-client-key-file string, $CODER_OIDC_CLIENT_KEY_FILE
Pem encoded RSA private key to use for oauth2 PKI/JWT authorization. Pem encoded RSA private key to use for oauth2 PKI/JWT authorization.
This can be used instead of oidc-client-secret if your IDP supports This can be used instead of oidc-client-secret if your IDP supports
it. it.
--oidc-client-secret string, $CODER_OIDC_CLIENT_SECRET --oidc-client-secret string, $CODER_OIDC_CLIENT_SECRET
Client secret to use for Login with OIDC. Client secret to use for Login with OIDC.
--oidc-email-domain string-array, $CODER_OIDC_EMAIL_DOMAIN --oidc-email-domain string-array, $CODER_OIDC_EMAIL_DOMAIN
Email domains that clients logging in with OIDC must match. Email domains that clients logging in with OIDC must match.
--oidc-email-field string, $CODER_OIDC_EMAIL_FIELD (default: email) --oidc-email-field string, $CODER_OIDC_EMAIL_FIELD (default: email)
OIDC claim field to use as the email. OIDC claim field to use as the email.
--oidc-group-field string, $CODER_OIDC_GROUP_FIELD --oidc-group-field string, $CODER_OIDC_GROUP_FIELD
This field must be set if using the group sync feature and the scope This field must be set if using the group sync feature and the scope
name is not 'groups'. Set to the claim to be used for groups. name is not 'groups'. Set to the claim to be used for groups.
--oidc-group-mapping struct[map[string]string], $CODER_OIDC_GROUP_MAPPING (default: {}) --oidc-group-mapping struct[map[string]string], $CODER_OIDC_GROUP_MAPPING (default: {})
A map of OIDC group IDs and the group in Coder it should map to. This A map of OIDC group IDs and the group in Coder it should map to. This
is useful for when OIDC providers only return group IDs. is useful for when OIDC providers only return group IDs.
--oidc-ignore-email-verified bool, $CODER_OIDC_IGNORE_EMAIL_VERIFIED --oidc-ignore-email-verified bool, $CODER_OIDC_IGNORE_EMAIL_VERIFIED
Ignore the email_verified claim from the upstream provider. Ignore the email_verified claim from the upstream provider.
--oidc-ignore-userinfo bool, $CODER_OIDC_IGNORE_USERINFO (default: false) --oidc-ignore-userinfo bool, $CODER_OIDC_IGNORE_USERINFO (default: false)
Ignore the userinfo endpoint and only use the ID token for user Ignore the userinfo endpoint and only use the ID token for user
information. information.
--oidc-issuer-url string, $CODER_OIDC_ISSUER_URL --oidc-issuer-url string, $CODER_OIDC_ISSUER_URL
Issuer URL to use for Login with OIDC. Issuer URL to use for Login with OIDC.
--oidc-group-regex-filter regexp, $CODER_OIDC_GROUP_REGEX_FILTER (default: .*) --oidc-group-regex-filter regexp, $CODER_OIDC_GROUP_REGEX_FILTER (default: .*)
If provided any group name not matching the regex is ignored. This If provided any group name not matching the regex is ignored. This
allows for filtering out groups that are not needed. This filter is allows for filtering out groups that are not needed. This filter is
applied after the group mapping. applied after the group mapping.
--oidc-scopes string-array, $CODER_OIDC_SCOPES (default: openid,profile,email) --oidc-scopes string-array, $CODER_OIDC_SCOPES (default: openid,profile,email)
Scopes to grant when authenticating with OIDC. Scopes to grant when authenticating with OIDC.
--oidc-user-role-default string-array, $CODER_OIDC_USER_ROLE_DEFAULT --oidc-user-role-default string-array, $CODER_OIDC_USER_ROLE_DEFAULT
If user role sync is enabled, these roles are always included for all If user role sync is enabled, these roles are always included for all
authenticated users. The 'member' role is always assigned. authenticated users. The 'member' role is always assigned.
--oidc-user-role-field string, $CODER_OIDC_USER_ROLE_FIELD --oidc-user-role-field string, $CODER_OIDC_USER_ROLE_FIELD
This field must be set if using the user roles sync feature. Set this This field must be set if using the user roles sync feature. Set this
to the name of the claim used to store the user's role. The roles to the name of the claim used to store the user's role. The roles
should be sent as an array of strings. should be sent as an array of strings.
--oidc-user-role-mapping struct[map[string][]string], $CODER_OIDC_USER_ROLE_MAPPING (default: {}) --oidc-user-role-mapping struct[map[string][]string], $CODER_OIDC_USER_ROLE_MAPPING (default: {})
A map of the OIDC passed in user roles and the groups in Coder it A map of the OIDC passed in user roles and the groups in Coder it
should map to. This is useful if the group names do not match. If should map to. This is useful if the group names do not match. If
mapped to the empty string, the role will ignored. mapped to the empty string, the role will ignored.
--oidc-username-field string, $CODER_OIDC_USERNAME_FIELD (default: preferred_username) --oidc-username-field string, $CODER_OIDC_USERNAME_FIELD (default: preferred_username)
OIDC claim field to use as the username. OIDC claim field to use as the username.
--oidc-sign-in-text string, $CODER_OIDC_SIGN_IN_TEXT (default: OpenID Connect) --oidc-sign-in-text string, $CODER_OIDC_SIGN_IN_TEXT (default: OpenID Connect)
The text to show on the OpenID Connect sign in button. The text to show on the OpenID Connect sign in button.
--oidc-icon-url url, $CODER_OIDC_ICON_URL --oidc-icon-url url, $CODER_OIDC_ICON_URL
URL pointing to the icon to use on the OpenID Connect login button. URL pointing to the icon to use on the OpenID Connect login button.
PROVISIONING OPTIONS: PROVISIONING OPTIONS:
Tune the behavior of the provisioner, which is responsible for creating, Tune the behavior of the provisioner, which is responsible for creating,
updating, and deleting workspace resources. updating, and deleting workspace resources.
--provisioner-force-cancel-interval duration, $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL (default: 10m0s) --provisioner-force-cancel-interval duration, $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL (default: 10m0s)
Time to force cancel provisioning tasks that are stuck. Time to force cancel provisioning tasks that are stuck.
--provisioner-daemon-poll-interval duration, $CODER_PROVISIONER_DAEMON_POLL_INTERVAL (default: 1s) --provisioner-daemon-poll-interval duration, $CODER_PROVISIONER_DAEMON_POLL_INTERVAL (default: 1s)
Time to wait before polling for a new job. Time to wait before polling for a new job.
--provisioner-daemon-poll-jitter duration, $CODER_PROVISIONER_DAEMON_POLL_JITTER (default: 100ms) --provisioner-daemon-poll-jitter duration, $CODER_PROVISIONER_DAEMON_POLL_JITTER (default: 100ms)
Random jitter added to the poll interval. Random jitter added to the poll interval.
--provisioner-daemon-psk string, $CODER_PROVISIONER_DAEMON_PSK --provisioner-daemon-psk string, $CODER_PROVISIONER_DAEMON_PSK
Pre-shared key to authenticate external provisioner daemons to Coder Pre-shared key to authenticate external provisioner daemons to Coder
server. server.
--provisioner-daemons int, $CODER_PROVISIONER_DAEMONS (default: 3) --provisioner-daemons int, $CODER_PROVISIONER_DAEMONS (default: 3)
Number of provisioner daemons to create on start. If builds are stuck Number of provisioner daemons to create on start. If builds are stuck
in queued state for a long time, consider increasing this. in queued state for a long time, consider increasing this.
@ -411,11 +411,11 @@ Telemetry is critical to our ability to improve Coder. We strip all
personalinformation before sending data to our servers. Please only disable personalinformation before sending data to our servers. Please only disable
telemetrywhen required by your organization's security policy. telemetrywhen required by your organization's security policy.
--telemetry bool, $CODER_TELEMETRY_ENABLE (default: false) --telemetry bool, $CODER_TELEMETRY_ENABLE (default: false)
Whether telemetry is enabled or not. Coder collects anonymized usage Whether telemetry is enabled or not. Coder collects anonymized usage
data to help improve our product. data to help improve our product.
--telemetry-trace bool, $CODER_TELEMETRY_TRACE (default: false) --telemetry-trace bool, $CODER_TELEMETRY_TRACE (default: false)
Whether Opentelemetry traces are sent to Coder. Coder collects Whether Opentelemetry traces are sent to Coder. Coder collects
anonymized application tracing to help improve our product. Disabling anonymized application tracing to help improve our product. Disabling
telemetry also disables this option. telemetry also disables this option.
@ -424,7 +424,7 @@ telemetrywhen required by your organization's security policy.
Allow users to set quiet hours schedules each day for workspaces to avoid Allow users to set quiet hours schedules each day for workspaces to avoid
workspaces stopping during the day due to template max TTL. workspaces stopping during the day due to template max TTL.
--default-quiet-hours-schedule string, $CODER_QUIET_HOURS_DEFAULT_SCHEDULE --default-quiet-hours-schedule string, $CODER_QUIET_HOURS_DEFAULT_SCHEDULE
The default daily cron schedule applied to users that haven't set a The default daily cron schedule applied to users that haven't set a
custom quiet hours schedule themselves. The quiet hours schedule custom quiet hours schedule themselves. The quiet hours schedule
determines when workspaces will be force stopped due to the template's determines when workspaces will be force stopped due to the template's
@ -435,7 +435,7 @@ workspaces stopping during the day due to template max TTL.
are not supported). are not supported).
⚠️ DANGEROUS OPTIONS: ⚠️ DANGEROUS OPTIONS:
--dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING --dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING
Allow workspace apps that are not served from subdomains to be shared. Allow workspace apps that are not served from subdomains to be shared.
Path-based app sharing is DISABLED by default for security purposes. Path-based app sharing is DISABLED by default for security purposes.
Path-based apps can make requests to the Coder API and pose a security Path-based apps can make requests to the Coder API and pose a security
@ -443,7 +443,7 @@ workspaces stopping during the day due to template max TTL.
can be disabled entirely with --disable-path-apps for further can be disabled entirely with --disable-path-apps for further
security. security.
--dangerous-allow-path-app-site-owner-access bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS --dangerous-allow-path-app-site-owner-access bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS
Allow site-owners to access workspace apps from workspaces they do not Allow site-owners to access workspace apps from workspaces they do not
own. Owners cannot access path-based apps they do not own by default. own. Owners cannot access path-based apps they do not own by default.
Path-based apps can make requests to the Coder API and pose a security Path-based apps can make requests to the Coder API and pose a security
@ -454,14 +454,14 @@ workspaces stopping during the day due to template max TTL.
ENTERPRISE OPTIONS: ENTERPRISE OPTIONS:
These options are only available in the Enterprise Edition. These options are only available in the Enterprise Edition.
--browser-only bool, $CODER_BROWSER_ONLY --browser-only bool, $CODER_BROWSER_ONLY
Whether Coder only allows connections to workspaces via the browser. Whether Coder only allows connections to workspaces via the browser.
--derp-server-relay-url url, $CODER_DERP_SERVER_RELAY_URL --derp-server-relay-url url, $CODER_DERP_SERVER_RELAY_URL
An HTTP URL that is accessible by other replicas to relay DERP An HTTP URL that is accessible by other replicas to relay DERP
traffic. Required for high availability. traffic. Required for high availability.
--external-token-encryption-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS --external-token-encryption-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS
Encrypt OIDC and Git authentication tokens with AES-256-GCM in the Encrypt OIDC and Git authentication tokens with AES-256-GCM in the
database. The value must be a comma-separated list of base64-encoded database. The value must be a comma-separated list of base64-encoded
keys. Each key, when base64-decoded, must be exactly 32 bytes in keys. Each key, when base64-decoded, must be exactly 32 bytes in
@ -471,7 +471,7 @@ These options are only available in the Enterprise Edition.
process of rotating keys with the `coder server dbcrypt rotate` process of rotating keys with the `coder server dbcrypt rotate`
command. command.
--scim-auth-header string, $CODER_SCIM_AUTH_HEADER --scim-auth-header string, $CODER_SCIM_AUTH_HEADER
Enables SCIM and sets the authentication header for the built-in SCIM Enables SCIM and sets the authentication header for the built-in SCIM
server. New users are automatically created with OIDC authentication. server. New users are automatically created with OIDC authentication.

12
cli/testdata/coder_server_create-admin-user_--help.golden vendored
View File

@ -7,27 +7,27 @@ coder v0.0.0-devel
it to every organization. it to every organization.
OPTIONS: OPTIONS:
--email string, $CODER_EMAIL --email string, $CODER_EMAIL
The email of the new user. If not specified, you will be prompted via The email of the new user. If not specified, you will be prompted via
stdin. stdin.
--password string, $CODER_PASSWORD --password string, $CODER_PASSWORD
The password of the new user. If not specified, you will be prompted The password of the new user. If not specified, you will be prompted
via stdin. via stdin.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, the built-in PostgreSQL URL of a PostgreSQL database. If empty, the built-in PostgreSQL
deployment will be used (Coder must not be already running in this deployment will be used (Coder must not be already running in this
case). case).
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519) --ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
The algorithm to use for generating ssh keys. Accepted values are The algorithm to use for generating ssh keys. Accepted values are
"ed25519", "ecdsa", or "rsa4096". "ed25519", "ecdsa", or "rsa4096".
--username string, $CODER_USERNAME --username string, $CODER_USERNAME
The username of the new user. If not specified, you will be prompted The username of the new user. If not specified, you will be prompted
via stdin. via stdin.

2
cli/testdata/coder_server_postgres-builtin-serve_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Run the built-in PostgreSQL deployment. Run the built-in PostgreSQL deployment.
OPTIONS: OPTIONS:
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
——— ———

2
cli/testdata/coder_server_postgres-builtin-url_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Output the connection URL for the built-in PostgreSQL deployment. Output the connection URL for the built-in PostgreSQL deployment.
OPTIONS: OPTIONS:
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
——— ———

6
cli/testdata/coder_speedtest_--help.golden vendored
View File

@ -6,15 +6,15 @@ coder v0.0.0-devel
Run upload and download tests from your machine to a workspace Run upload and download tests from your machine to a workspace
OPTIONS: OPTIONS:
-d, --direct bool -d, --direct bool
Specifies whether to wait for a direct connection before testing Specifies whether to wait for a direct connection before testing
speed. speed.
--direction up|down (default: down) --direction up|down (default: down)
Specifies whether to run in reverse mode where the client receives and Specifies whether to run in reverse mode where the client receives and
the server sends. the server sends.
-t, --time duration (default: 5s) -t, --time duration (default: 5s)
Specifies the duration to monitor traffic. Specifies the duration to monitor traffic.
——— ———

18
cli/testdata/coder_ssh_--help.golden vendored
View File

@ -6,42 +6,42 @@ coder v0.0.0-devel
Start a shell into a workspace Start a shell into a workspace
OPTIONS: OPTIONS:
-A, --forward-agent bool, $CODER_SSH_FORWARD_AGENT -A, --forward-agent bool, $CODER_SSH_FORWARD_AGENT
Specifies whether to forward the SSH agent specified in Specifies whether to forward the SSH agent specified in
$SSH_AUTH_SOCK. $SSH_AUTH_SOCK.
-G, --forward-gpg bool, $CODER_SSH_FORWARD_GPG -G, --forward-gpg bool, $CODER_SSH_FORWARD_GPG
Specifies whether to forward the GPG agent. Unsupported on Windows Specifies whether to forward the GPG agent. Unsupported on Windows
workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on
both the client and workspace. The GPG agent must already be running both the client and workspace. The GPG agent must already be running
locally and will not be started for you. If a GPG agent is already locally and will not be started for you. If a GPG agent is already
running in the workspace, it will be attempted to be killed. running in the workspace, it will be attempted to be killed.
--identity-agent string, $CODER_SSH_IDENTITY_AGENT --identity-agent string, $CODER_SSH_IDENTITY_AGENT
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), Specifies which identity agent to use (overrides $SSH_AUTH_SOCK),
forward agent must also be enabled. forward agent must also be enabled.
-l, --log-dir string, $CODER_SSH_LOG_DIR -l, --log-dir string, $CODER_SSH_LOG_DIR
Specify the directory containing SSH diagnostic log files. Specify the directory containing SSH diagnostic log files.
--no-wait bool, $CODER_SSH_NO_WAIT --no-wait bool, $CODER_SSH_NO_WAIT
Enter workspace immediately after the agent has connected. This is the Enter workspace immediately after the agent has connected. This is the
default if the template has configured the agent startup script default if the template has configured the agent startup script
behavior as non-blocking. behavior as non-blocking.
DEPRECATED: Use --wait instead. DEPRECATED: Use --wait instead.
-R, --remote-forward string, $CODER_SSH_REMOTE_FORWARD -R, --remote-forward string, $CODER_SSH_REMOTE_FORWARD
Enable remote port forwarding (remote_port:local_address:local_port). Enable remote port forwarding (remote_port:local_address:local_port).
--stdio bool, $CODER_SSH_STDIO --stdio bool, $CODER_SSH_STDIO
Specifies whether to emit SSH output over stdin/stdout. Specifies whether to emit SSH output over stdin/stdout.
--wait yes|no|auto, $CODER_SSH_WAIT (default: auto) --wait yes|no|auto, $CODER_SSH_WAIT (default: auto)
Specifies whether or not to wait for the startup script to finish Specifies whether or not to wait for the startup script to finish
executing. Auto means that the agent startup script behavior executing. Auto means that the agent startup script behavior
configured in the workspace template is used. configured in the workspace template is used.
--workspace-poll-interval duration, $CODER_WORKSPACE_POLL_INTERVAL (default: 1m) --workspace-poll-interval duration, $CODER_WORKSPACE_POLL_INTERVAL (default: 1m)
Specifies how often to poll for workspace automated shutdown. Specifies how often to poll for workspace automated shutdown.
——— ———

6
cli/testdata/coder_start_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Start a workspace Start a workspace
OPTIONS: OPTIONS:
--build-option string-array, $CODER_BUILD_OPTION --build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value". Build option value in the format "name=value".
--build-options bool --build-options bool
Prompt for one-time build options defined with ephemeral parameters. Prompt for one-time build options defined with ephemeral parameters.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

4
cli/testdata/coder_stat_--help.golden vendored
View File

@ -11,11 +11,11 @@ coder v0.0.0-devel
mem Show memory usage, in gigabytes. mem Show memory usage, in gigabytes.
OPTIONS: OPTIONS:
-c, --column string-array (default: host_cpu,host_memory,home_disk,container_cpu,container_memory) -c, --column string-array (default: host_cpu,host_memory,home_disk,container_cpu,container_memory)
Columns to display in table output. Available columns: host cpu, host Columns to display in table output. Available columns: host cpu, host
memory, home disk, container cpu, container memory. memory, home disk, container cpu, container memory.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

4
cli/testdata/coder_stat_cpu_--help.golden vendored
View File

@ -6,10 +6,10 @@ coder v0.0.0-devel
Show CPU usage, in cores. Show CPU usage, in cores.
OPTIONS: OPTIONS:
--host bool --host bool
Force host CPU measurement. Force host CPU measurement.
-o, --output string (default: text) -o, --output string (default: text)
Output format. Available formats: text, json. Output format. Available formats: text, json.
——— ———

6
cli/testdata/coder_stat_disk_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Show disk usage, in gigabytes. Show disk usage, in gigabytes.
OPTIONS: OPTIONS:
-o, --output string (default: text) -o, --output string (default: text)
Output format. Available formats: text, json. Output format. Available formats: text, json.
--path string (default: /) --path string (default: /)
Path for which to check disk usage. Path for which to check disk usage.
--prefix Ki|Mi|Gi|Ti (default: Gi) --prefix Ki|Mi|Gi|Ti (default: Gi)
SI Prefix for disk measurement. SI Prefix for disk measurement.
——— ———

6
cli/testdata/coder_stat_mem_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Show memory usage, in gigabytes. Show memory usage, in gigabytes.
OPTIONS: OPTIONS:
--host bool --host bool
Force host memory measurement. Force host memory measurement.
-o, --output string (default: text) -o, --output string (default: text)
Output format. Available formats: text, json. Output format. Available formats: text, json.
--prefix Ki|Mi|Gi|Ti (default: Gi) --prefix Ki|Mi|Gi|Ti (default: Gi)
SI Prefix for memory measurement. SI Prefix for memory measurement.
——— ———

2
cli/testdata/coder_state_pull_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Pull a Terraform state file from a workspace. Pull a Terraform state file from a workspace.
OPTIONS: OPTIONS:
-b, --build int -b, --build int
Specify a workspace build to target by name. Defaults to latest. Specify a workspace build to target by name. Defaults to latest.
——— ———

2
cli/testdata/coder_state_push_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Push a Terraform state file to a workspace. Push a Terraform state file to a workspace.
OPTIONS: OPTIONS:
-b, --build int -b, --build int
Specify a workspace build to target by name. Defaults to latest. Specify a workspace build to target by name. Defaults to latest.
——— ———

2
cli/testdata/coder_stop_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Stop a workspace Stop a workspace
OPTIONS: OPTIONS:
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

26
cli/testdata/coder_templates_create_--help.golden vendored
View File

@ -6,59 +6,59 @@ coder v0.0.0-devel
Create a template from the current directory or as specified by flag Create a template from the current directory or as specified by flag
OPTIONS: OPTIONS:
--default-ttl duration (default: 24h) --default-ttl duration (default: 24h)
Specify a default TTL for workspaces created from this template. It is Specify a default TTL for workspaces created from this template. It is
the default time before shutdown - workspaces created from this the default time before shutdown - workspaces created from this
template default to this value. Maps to "Default autostop" in the UI. template default to this value. Maps to "Default autostop" in the UI.
-d, --directory string (default: .) -d, --directory string (default: .)
Specify the directory to create from, use '-' to read tar from stdin. Specify the directory to create from, use '-' to read tar from stdin.
--failure-ttl duration (default: 0h) --failure-ttl duration (default: 0h)
Specify a failure TTL for workspaces created from this template. It is Specify a failure TTL for workspaces created from this template. It is
the amount of time after a failed "start" build before coder the amount of time after a failed "start" build before coder
automatically schedules a "stop" build to cleanup.This licensed automatically schedules a "stop" build to cleanup.This licensed
feature's default is 0h (off). Maps to "Failure cleanup"in the UI. feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
--ignore-lockfile bool (default: false) --ignore-lockfile bool (default: false)
Ignore warnings about not having a .terraform.lock.hcl file present in Ignore warnings about not having a .terraform.lock.hcl file present in
the template. the template.
--inactivity-ttl duration (default: 0h) --inactivity-ttl duration (default: 0h)
Specify an inactivity TTL for workspaces created from this template. Specify an inactivity TTL for workspaces created from this template.
It is the amount of time the workspace is not used before it is be It is the amount of time the workspace is not used before it is be
stopped and auto-locked. This includes across multiple builds (e.g. stopped and auto-locked. This includes across multiple builds (e.g.
auto-starts and stops). This licensed feature's default is 0h (off). auto-starts and stops). This licensed feature's default is 0h (off).
Maps to "Dormancy threshold" in the UI. Maps to "Dormancy threshold" in the UI.
--max-ttl duration --max-ttl duration
Edit the template maximum time before shutdown - workspaces created Edit the template maximum time before shutdown - workspaces created
from this template must shutdown within the given duration after from this template must shutdown within the given duration after
starting. This is an enterprise-only feature. starting. This is an enterprise-only feature.
-m, --message string -m, --message string
Specify a message describing the changes in this version of the Specify a message describing the changes in this version of the
template. Messages longer than 72 characters will be displayed as template. Messages longer than 72 characters will be displayed as
truncated. truncated.
--private bool --private bool
Disable the default behavior of granting template access to the Disable the default behavior of granting template access to the
'everyone' group. The template permissions must be updated to allow 'everyone' group. The template permissions must be updated to allow
non-admin users to use this template. non-admin users to use this template.
--provisioner-tag string-array --provisioner-tag string-array
Specify a set of tags to target provisioner daemons. Specify a set of tags to target provisioner daemons.
--var string-array --var string-array
Alias of --variable. Alias of --variable.
--variable string-array --variable string-array
Specify a set of values for Terraform-managed variables. Specify a set of values for Terraform-managed variables.
--variables-file string --variables-file string
Specify a file path with values for Terraform-managed variables. Specify a file path with values for Terraform-managed variables.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

2
cli/testdata/coder_templates_delete_--help.golden vendored
View File

@ -8,7 +8,7 @@ coder v0.0.0-devel
Aliases: rm Aliases: rm
OPTIONS: OPTIONS:
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

24
cli/testdata/coder_templates_edit_--help.golden vendored
View File

@ -6,54 +6,54 @@ coder v0.0.0-devel
Edit the metadata of a template by name. Edit the metadata of a template by name.
OPTIONS: OPTIONS:
--allow-user-autostart bool (default: true) --allow-user-autostart bool (default: true)
Allow users to configure autostart for workspaces on this template. Allow users to configure autostart for workspaces on this template.
This can only be disabled in enterprise. This can only be disabled in enterprise.
--allow-user-autostop bool (default: true) --allow-user-autostop bool (default: true)
Allow users to customize the autostop TTL for workspaces on this Allow users to customize the autostop TTL for workspaces on this
template. This can only be disabled in enterprise. template. This can only be disabled in enterprise.
--allow-user-cancel-workspace-jobs bool (default: true) --allow-user-cancel-workspace-jobs bool (default: true)
Allow users to cancel in-progress workspace jobs. Allow users to cancel in-progress workspace jobs.
--default-ttl duration --default-ttl duration
Edit the template default time before shutdown - workspaces created Edit the template default time before shutdown - workspaces created
from this template default to this value. Maps to "Default autostop" from this template default to this value. Maps to "Default autostop"
in the UI. in the UI.
--description string --description string
Edit the template description. Edit the template description.
--display-name string --display-name string
Edit the template display name. Edit the template display name.
--failure-ttl duration (default: 0h) --failure-ttl duration (default: 0h)
Specify a failure TTL for workspaces created from this template. It is Specify a failure TTL for workspaces created from this template. It is
the amount of time after a failed "start" build before coder the amount of time after a failed "start" build before coder
automatically schedules a "stop" build to cleanup.This licensed automatically schedules a "stop" build to cleanup.This licensed
feature's default is 0h (off). Maps to "Failure cleanup" in the UI. feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
--icon string --icon string
Edit the template icon path. Edit the template icon path.
--inactivity-ttl duration (default: 0h) --inactivity-ttl duration (default: 0h)
Specify an inactivity TTL for workspaces created from this template. Specify an inactivity TTL for workspaces created from this template.
It is the amount of time the workspace is not used before it is be It is the amount of time the workspace is not used before it is be
stopped and auto-locked. This includes across multiple builds (e.g. stopped and auto-locked. This includes across multiple builds (e.g.
auto-starts and stops). This licensed feature's default is 0h (off). auto-starts and stops). This licensed feature's default is 0h (off).
Maps to "Dormancy threshold" in the UI. Maps to "Dormancy threshold" in the UI.
--max-ttl duration --max-ttl duration
Edit the template maximum time before shutdown - workspaces created Edit the template maximum time before shutdown - workspaces created
from this template must shutdown within the given duration after from this template must shutdown within the given duration after
starting, regardless of user activity. This is an enterprise-only starting, regardless of user activity. This is an enterprise-only
feature. Maps to "Max lifetime" in the UI. feature. Maps to "Max lifetime" in the UI.
--name string --name string
Edit the template name. Edit the template name.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

2
cli/testdata/coder_templates_init_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Get started with a templated template. Get started with a templated template.
OPTIONS: OPTIONS:
--id aws-ecs-container|aws-linux|aws-windows|azure-linux|do-linux|docker|docker-with-dotfiles|fly-docker-image|gcp-linux|gcp-vm-container|gcp-windows|kubernetes --id aws-ecs-container|aws-linux|aws-windows|azure-linux|do-linux|docker|docker-with-dotfiles|fly-docker-image|gcp-linux|gcp-vm-container|gcp-windows|kubernetes
Specify a given example template by ID. Specify a given example template by ID.
——— ———

4
cli/testdata/coder_templates_list_--help.golden vendored
View File

@ -8,12 +8,12 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-c, --column string-array (default: name,last updated,used by) -c, --column string-array (default: name,last updated,used by)
Columns to display in table output. Available columns: name, created Columns to display in table output. Available columns: name, created
at, last updated, organization id, provisioner, active version id, at, last updated, organization id, provisioner, active version id,
used by, default ttl. used by, default ttl.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

4
cli/testdata/coder_templates_pull_--help.golden vendored
View File

@ -6,10 +6,10 @@ coder v0.0.0-devel
Download the latest version of a template to a path. Download the latest version of a template to a path.
OPTIONS: OPTIONS:
--tar bool --tar bool
Output the template as a tar archive to stdout. Output the template as a tar archive to stdout.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

24
cli/testdata/coder_templates_push_--help.golden vendored
View File

@ -6,45 +6,45 @@ coder v0.0.0-devel
Push a new template version from the current directory or as specified by flag Push a new template version from the current directory or as specified by flag
OPTIONS: OPTIONS:
--activate bool (default: true) --activate bool (default: true)
Whether the new template will be marked active. Whether the new template will be marked active.
--always-prompt bool --always-prompt bool
Always prompt all parameters. Does not pull parameter values from Always prompt all parameters. Does not pull parameter values from
active template version. active template version.
--create bool (default: false) --create bool (default: false)
Create the template if it does not exist. Create the template if it does not exist.
-d, --directory string (default: .) -d, --directory string (default: .)
Specify the directory to create from, use '-' to read tar from stdin. Specify the directory to create from, use '-' to read tar from stdin.
--ignore-lockfile bool (default: false) --ignore-lockfile bool (default: false)
Ignore warnings about not having a .terraform.lock.hcl file present in Ignore warnings about not having a .terraform.lock.hcl file present in
the template. the template.
-m, --message string -m, --message string
Specify a message describing the changes in this version of the Specify a message describing the changes in this version of the
template. Messages longer than 72 characters will be displayed as template. Messages longer than 72 characters will be displayed as
truncated. truncated.
--name string --name string
Specify a name for the new template version. It will be automatically Specify a name for the new template version. It will be automatically
generated if not provided. generated if not provided.
--provisioner-tag string-array --provisioner-tag string-array
Specify a set of tags to target provisioner daemons. Specify a set of tags to target provisioner daemons.
--var string-array --var string-array
Alias of --variable. Alias of --variable.
--variable string-array --variable string-array
Specify a set of values for Terraform-managed variables. Specify a set of values for Terraform-managed variables.
--variables-file string --variables-file string
Specify a file path with values for Terraform-managed variables. Specify a file path with values for Terraform-managed variables.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

4
cli/testdata/coder_templates_versions_list_--help.golden vendored
View File

@ -6,11 +6,11 @@ coder v0.0.0-devel
List all the versions of the specified template List all the versions of the specified template
OPTIONS: OPTIONS:
-c, --column string-array (default: name,created at,created by,status,active) -c, --column string-array (default: name,created at,created by,status,active)
Columns to display in table output. Available columns: name, created Columns to display in table output. Available columns: name, created
at, created by, status, active. at, created by, status, active.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

4
cli/testdata/coder_tokens_create_--help.golden vendored
View File

@ -6,10 +6,10 @@ coder v0.0.0-devel
Create a token Create a token
OPTIONS: OPTIONS:
--lifetime duration, $CODER_TOKEN_LIFETIME (default: 720h0m0s) --lifetime duration, $CODER_TOKEN_LIFETIME (default: 720h0m0s)
Specify a duration for the lifetime of the token. Specify a duration for the lifetime of the token.
-n, --name string, $CODER_TOKEN_NAME -n, --name string, $CODER_TOKEN_NAME
Specify a human-readable name. Specify a human-readable name.
——— ———

6
cli/testdata/coder_tokens_list_--help.golden vendored
View File

@ -8,15 +8,15 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-a, --all bool -a, --all bool
Specifies whether all users' tokens will be listed or not (must have Specifies whether all users' tokens will be listed or not (must have
Owner role to see all tokens). Owner role to see all tokens).
-c, --column string-array (default: id,name,last used,expires at,created at) -c, --column string-array (default: id,name,last used,expires at,created at)
Columns to display in table output. Available columns: id, name, last Columns to display in table output. Available columns: id, name, last
used, expires at, created at, owner. used, expires at, created at, owner.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

10
cli/testdata/coder_update_--help.golden vendored
View File

@ -8,20 +8,20 @@ coder v0.0.0-devel
Use --always-prompt to change the parameter values of the workspace. Use --always-prompt to change the parameter values of the workspace.
OPTIONS: OPTIONS:
--always-prompt bool --always-prompt bool
Always prompt all parameters. Does not pull parameter values from Always prompt all parameters. Does not pull parameter values from
existing workspace. existing workspace.
--build-option string-array, $CODER_BUILD_OPTION --build-option string-array, $CODER_BUILD_OPTION
Build option value in the format "name=value". Build option value in the format "name=value".
--build-options bool --build-options bool
Prompt for one-time build options defined with ephemeral parameters. Prompt for one-time build options defined with ephemeral parameters.
--parameter string-array, $CODER_RICH_PARAMETER --parameter string-array, $CODER_RICH_PARAMETER
Rich parameter value in the format "name=value". Rich parameter value in the format "name=value".
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE --rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
Specify a file path with values for rich parameters defined in the Specify a file path with values for rich parameters defined in the
template. template.

2
cli/testdata/coder_users_activate_--help.golden vendored
View File

@ -11,7 +11,7 @@ coder v0.0.0-devel
$ coder users activate example_user $ coder users activate example_user
OPTIONS: OPTIONS:
-c, --column string-array (default: username,email,created_at,status) -c, --column string-array (default: username,email,created_at,status)
Specify a column to filter in the table. Specify a column to filter in the table.
——— ———

8
cli/testdata/coder_users_create_--help.golden vendored
View File

@ -4,19 +4,19 @@ coder v0.0.0-devel
coder users create [flags] coder users create [flags]
OPTIONS: OPTIONS:
-e, --email string -e, --email string
Specifies an email address for the new user. Specifies an email address for the new user.
--login-type string --login-type string
Optionally specify the login type for the user. Valid values are: Optionally specify the login type for the user. Valid values are:
password, none, github, oidc. Using 'none' prevents the user from password, none, github, oidc. Using 'none' prevents the user from
authenticating and requires an API key/token to be generated by an authenticating and requires an API key/token to be generated by an
admin. admin.
-p, --password string -p, --password string
Specifies a password for the new user. Specifies a password for the new user.
-u, --username string -u, --username string
Specifies a username for the new user. Specifies a username for the new user.
——— ———

4
cli/testdata/coder_users_list_--help.golden vendored
View File

@ -6,11 +6,11 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-c, --column string-array (default: username,email,created_at,status) -c, --column string-array (default: username,email,created_at,status)
Columns to display in table output. Available columns: id, username, Columns to display in table output. Available columns: id, username,
email, created at, status. email, created at, status.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

2
cli/testdata/coder_users_show_--help.golden vendored
View File

@ -8,7 +8,7 @@ coder v0.0.0-devel
$ coder users show me $ coder users show me
OPTIONS: OPTIONS:
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

2
cli/testdata/coder_users_suspend_--help.golden vendored
View File

@ -11,7 +11,7 @@ coder v0.0.0-devel
$ coder users suspend example_user $ coder users suspend example_user
OPTIONS: OPTIONS:
-c, --column string-array (default: username,email,created_at,status) -c, --column string-array (default: username,email,created_at,status)
Specify a column to filter in the table. Specify a column to filter in the table.
——— ———

2
cli/testdata/coder_version_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Show coder version Show coder version
OPTIONS: OPTIONS:
-o, --output string (default: text) -o, --output string (default: text)
Output format. Available formats: text, json. Output format. Available formats: text, json.
——— ———

20
enterprise/cli/testdata/coder_--help.golden vendored
View File

@ -24,38 +24,38 @@ coder v0.0.0-devel
Global options are applied to all commands. They can be set using environment Global options are applied to all commands. They can be set using environment
variables or flags. variables or flags.
--debug-options bool --debug-options bool
Print all options, how they're set, then exit. Print all options, how they're set, then exit.
--disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS --disable-direct-connections bool, $CODER_DISABLE_DIRECT_CONNECTIONS
Disable direct (P2P) connections to workspaces. Disable direct (P2P) connections to workspaces.
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2) --global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
Path to the global `coder` config directory. Path to the global `coder` config directory.
--header string-array, $CODER_HEADER --header string-array, $CODER_HEADER
Additional HTTP headers added to all requests. Provide as key=value. Additional HTTP headers added to all requests. Provide as key=value.
Can be specified multiple times. Can be specified multiple times.
--header-command string, $CODER_HEADER_COMMAND --header-command string, $CODER_HEADER_COMMAND
An external command that outputs additional HTTP headers added to all An external command that outputs additional HTTP headers added to all
requests. The command must output each header as `key=value` on its requests. The command must output each header as `key=value` on its
own line. own line.
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING --no-feature-warning bool, $CODER_NO_FEATURE_WARNING
Suppress warnings about unlicensed features. Suppress warnings about unlicensed features.
--no-version-warning bool, $CODER_NO_VERSION_WARNING --no-version-warning bool, $CODER_NO_VERSION_WARNING
Suppress warning when client and server versions do not match. Suppress warning when client and server versions do not match.
--token string, $CODER_SESSION_TOKEN --token string, $CODER_SESSION_TOKEN
Specify an authentication token. For security reasons setting Specify an authentication token. For security reasons setting
CODER_SESSION_TOKEN is preferred. CODER_SESSION_TOKEN is preferred.
--url url, $CODER_URL --url url, $CODER_URL
URL to a deployment. URL to a deployment.
-v, --verbose bool, $CODER_VERBOSE -v, --verbose bool, $CODER_VERBOSE
Enable verbose output. Enable verbose output.
——— ———

4
enterprise/cli/testdata/coder_features_list_--help.golden vendored
View File

@ -6,11 +6,11 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-c, --column string-array (default: Name,Entitlement,Enabled,Limit,Actual) -c, --column string-array (default: Name,Entitlement,Enabled,Limit,Actual)
Specify a column to filter in the table. Available columns are: Name, Specify a column to filter in the table. Available columns are: Name,
Entitlement, Enabled, Limit, Actual. Entitlement, Enabled, Limit, Actual.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats are: table, json. Output format. Available formats are: table, json.
——— ———

4
enterprise/cli/testdata/coder_groups_create_--help.golden vendored
View File

@ -6,10 +6,10 @@ coder v0.0.0-devel
Create a user group Create a user group
OPTIONS: OPTIONS:
-u, --avatar-url string, $CODER_AVATAR_URL -u, --avatar-url string, $CODER_AVATAR_URL
Set an avatar for a group. Set an avatar for a group.
--display-name string, $CODER_DISPLAY_NAME --display-name string, $CODER_DISPLAY_NAME
Optional human friendly name for the group. Optional human friendly name for the group.
——— ———

10
enterprise/cli/testdata/coder_groups_edit_--help.golden vendored
View File

@ -6,19 +6,19 @@ coder v0.0.0-devel
Edit a user group Edit a user group
OPTIONS: OPTIONS:
-a, --add-users string-array -a, --add-users string-array
Add users to the group. Accepts emails or IDs. Add users to the group. Accepts emails or IDs.
-u, --avatar-url string -u, --avatar-url string
Update the group avatar. Update the group avatar.
--display-name string, $CODER_DISPLAY_NAME --display-name string, $CODER_DISPLAY_NAME
Optional human friendly name for the group. Optional human friendly name for the group.
-n, --name string -n, --name string
Update the group name. Update the group name.
-r, --rm-users string-array -r, --rm-users string-array
Remove users to the group. Accepts emails or IDs. Remove users to the group. Accepts emails or IDs.
——— ———

4
enterprise/cli/testdata/coder_groups_list_--help.golden vendored
View File

@ -6,11 +6,11 @@ coder v0.0.0-devel
List user groups List user groups
OPTIONS: OPTIONS:
-c, --column string-array (default: name,display name,organization id,members,avatar url) -c, --column string-array (default: name,display name,organization id,members,avatar url)
Columns to display in table output. Available columns: name, display Columns to display in table output. Available columns: name, display
name, organization id, members, avatar url. name, organization id, members, avatar url.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

6
enterprise/cli/testdata/coder_licenses_add_--help.golden vendored
View File

@ -6,13 +6,13 @@ coder v0.0.0-devel
Add license to Coder deployment Add license to Coder deployment
OPTIONS: OPTIONS:
--debug bool --debug bool
Output license claims for debugging. Output license claims for debugging.
-f, --file string -f, --file string
Load license from file. Load license from file.
-l, --license string -l, --license string
License string. License string.
——— ———

4
enterprise/cli/testdata/coder_licenses_list_--help.golden vendored
View File

@ -8,11 +8,11 @@ coder v0.0.0-devel
Aliases: ls Aliases: ls
OPTIONS: OPTIONS:
-c, --column string-array (default: UUID,Expires At,Uploaded At,Features) -c, --column string-array (default: UUID,Expires At,Uploaded At,Features)
Columns to display in table output. Available columns: id, uuid, Columns to display in table output. Available columns: id, uuid,
uploaded at, features, expires at, trial. uploaded at, features, expires at, trial.
-o, --output string (default: table) -o, --output string (default: table)
Output format. Available formats: table, json. Output format. Available formats: table, json.
——— ———

10
enterprise/cli/testdata/coder_provisionerd_start_--help.golden vendored
View File

@ -6,19 +6,19 @@ coder v0.0.0-devel
Run a provisioner daemon Run a provisioner daemon
OPTIONS: OPTIONS:
-c, --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir]) -c, --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
Directory to store cached data. Directory to store cached data.
--poll-interval duration, $CODER_PROVISIONERD_POLL_INTERVAL (default: 1s) --poll-interval duration, $CODER_PROVISIONERD_POLL_INTERVAL (default: 1s)
How often to poll for provisioner jobs. How often to poll for provisioner jobs.
--poll-jitter duration, $CODER_PROVISIONERD_POLL_JITTER (default: 100ms) --poll-jitter duration, $CODER_PROVISIONERD_POLL_JITTER (default: 100ms)
How much to jitter the poll interval by. How much to jitter the poll interval by.
--psk string, $CODER_PROVISIONER_DAEMON_PSK --psk string, $CODER_PROVISIONER_DAEMON_PSK
Pre-shared key to authenticate with Coder server. Pre-shared key to authenticate with Coder server.
-t, --tag string-array, $CODER_PROVISIONERD_TAGS -t, --tag string-array, $CODER_PROVISIONERD_TAGS
Tags to filter provisioner jobs by. Tags to filter provisioner jobs by.
——— ———

200
enterprise/cli/testdata/coder_server_--help.golden vendored
View File

@ -15,42 +15,42 @@ coder v0.0.0-devel
PostgreSQL deployment. PostgreSQL deployment.
OPTIONS: OPTIONS:
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir]) --cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
The directory to cache temporary files. If unspecified and The directory to cache temporary files. If unspecified and
$CACHE_DIRECTORY is set, it will be used for compatibility with $CACHE_DIRECTORY is set, it will be used for compatibility with
systemd. systemd.
--disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS --disable-owner-workspace-access bool, $CODER_DISABLE_OWNER_WORKSPACE_ACCESS
Remove the permission for the 'owner' role to have workspace execution Remove the permission for the 'owner' role to have workspace execution
on all workspaces. This prevents the 'owner' from ssh, apps, and on all workspaces. This prevents the 'owner' from ssh, apps, and
terminal access based on the 'owner' role. They still have their user terminal access based on the 'owner' role. They still have their user
permissions to access their own workspaces. permissions to access their own workspaces.
--disable-path-apps bool, $CODER_DISABLE_PATH_APPS --disable-path-apps bool, $CODER_DISABLE_PATH_APPS
Disable workspace apps that are not served from subdomains. Path-based Disable workspace apps that are not served from subdomains. Path-based
apps can make requests to the Coder API and pose a security risk when apps can make requests to the Coder API and pose a security risk when
the workspace serves malicious JavaScript. This is recommended for the workspace serves malicious JavaScript. This is recommended for
security purposes if a --wildcard-access-url is configured. security purposes if a --wildcard-access-url is configured.
--swagger-enable bool, $CODER_SWAGGER_ENABLE --swagger-enable bool, $CODER_SWAGGER_ENABLE
Expose the swagger endpoint via /swagger. Expose the swagger endpoint via /swagger.
--experiments string-array, $CODER_EXPERIMENTS --experiments string-array, $CODER_EXPERIMENTS
Enable one or more experiments. These are not ready for production. Enable one or more experiments. These are not ready for production.
Separate multiple experiments with commas, or enter '*' to opt-in to Separate multiple experiments with commas, or enter '*' to opt-in to
all available experiments. all available experiments.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
downloaded from Maven (https://repo1.maven.org/maven2) and store all downloaded from Maven (https://repo1.maven.org/maven2) and store all
data in the config root. Access the built-in database with "coder data in the config root. Access the built-in database with "coder
server postgres-builtin-url". server postgres-builtin-url".
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519) --ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
The algorithm to use for generating ssh keys. Accepted values are The algorithm to use for generating ssh keys. Accepted values are
"ed25519", "ecdsa", or "rsa4096". "ed25519", "ecdsa", or "rsa4096".
--update-check bool, $CODER_UPDATE_CHECK (default: false) --update-check bool, $CODER_UPDATE_CHECK (default: false)
Periodically check for new releases of Coder and inform the owner. The Periodically check for new releases of Coder and inform the owner. The
check is performed once per day. check is performed once per day.
@ -58,99 +58,99 @@ coder v0.0.0-devel
These options change the behavior of how clients interact with the Coder. These options change the behavior of how clients interact with the Coder.
Clients include the coder cli, vs code extension, and the web UI. Clients include the coder cli, vs code extension, and the web UI.
--ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS --ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS
These SSH config options will override the default SSH config options. These SSH config options will override the default SSH config options.
Provide options in "key=value" or "key value" format separated by Provide options in "key=value" or "key value" format separated by
commas.Using this incorrectly can break SSH to your deployment, use commas.Using this incorrectly can break SSH to your deployment, use
cautiously. cautiously.
--ssh-hostname-prefix string, $CODER_SSH_HOSTNAME_PREFIX (default: coder.) --ssh-hostname-prefix string, $CODER_SSH_HOSTNAME_PREFIX (default: coder.)
The SSH deployment prefix is used in the Host of the ssh config. The SSH deployment prefix is used in the Host of the ssh config.
CONFIG OPTIONS: CONFIG OPTIONS:
Use a YAML configuration file when your server launch become unwieldy. Use a YAML configuration file when your server launch become unwieldy.
-c, --config yaml-config-path, $CODER_CONFIG_PATH -c, --config yaml-config-path, $CODER_CONFIG_PATH
Specify a YAML file to load configuration from. Specify a YAML file to load configuration from.
--write-config bool --write-config bool
Write out the current server config as YAML to stdout. Write out the current server config as YAML to stdout.
INTROSPECTION / LOGGING OPTIONS: INTROSPECTION / LOGGING OPTIONS:
--enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false) --enable-terraform-debug-mode bool, $CODER_ENABLE_TERRAFORM_DEBUG_MODE (default: false)
Allow administrators to enable Terraform debug output. Allow administrators to enable Terraform debug output.
--log-human string, $CODER_LOGGING_HUMAN (default: /dev/stderr) --log-human string, $CODER_LOGGING_HUMAN (default: /dev/stderr)
Output human-readable logs to a given file. Output human-readable logs to a given file.
--log-json string, $CODER_LOGGING_JSON --log-json string, $CODER_LOGGING_JSON
Output JSON logs to a given file. Output JSON logs to a given file.
-l, --log-filter string-array, $CODER_LOG_FILTER -l, --log-filter string-array, $CODER_LOG_FILTER
Filter debug logs by matching against a given regex. Use .* to match Filter debug logs by matching against a given regex. Use .* to match
all debug logs. all debug logs.
--log-stackdriver string, $CODER_LOGGING_STACKDRIVER --log-stackdriver string, $CODER_LOGGING_STACKDRIVER
Output Stackdriver compatible logs to a given file. Output Stackdriver compatible logs to a given file.
INTROSPECTION / PROMETHEUS OPTIONS: INTROSPECTION / PROMETHEUS OPTIONS:
--prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112) --prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
The bind address to serve prometheus metrics. The bind address to serve prometheus metrics.
--prometheus-collect-agent-stats bool, $CODER_PROMETHEUS_COLLECT_AGENT_STATS --prometheus-collect-agent-stats bool, $CODER_PROMETHEUS_COLLECT_AGENT_STATS
Collect agent stats (may increase charges for metrics storage). Collect agent stats (may increase charges for metrics storage).
--prometheus-collect-db-metrics bool, $CODER_PROMETHEUS_COLLECT_DB_METRICS (default: false) --prometheus-collect-db-metrics bool, $CODER_PROMETHEUS_COLLECT_DB_METRICS (default: false)
Collect database metrics (may increase charges for metrics storage). Collect database metrics (may increase charges for metrics storage).
--prometheus-enable bool, $CODER_PROMETHEUS_ENABLE --prometheus-enable bool, $CODER_PROMETHEUS_ENABLE
Serve prometheus metrics on the address defined by prometheus address. Serve prometheus metrics on the address defined by prometheus address.
INTROSPECTION / TRACING OPTIONS: INTROSPECTION / TRACING OPTIONS:
--trace-logs bool, $CODER_TRACE_LOGS --trace-logs bool, $CODER_TRACE_LOGS
Enables capturing of logs as events in traces. This is useful for Enables capturing of logs as events in traces. This is useful for
debugging, but may result in a very large amount of events being sent debugging, but may result in a very large amount of events being sent
to the tracing backend which may incur significant costs. to the tracing backend which may incur significant costs.
--trace bool, $CODER_TRACE_ENABLE --trace bool, $CODER_TRACE_ENABLE
Whether application tracing data is collected. It exports to a backend Whether application tracing data is collected. It exports to a backend
configured by environment variables. See: configured by environment variables. See:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md. https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY --trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
Enables trace exporting to Honeycomb.io using the provided API Key. Enables trace exporting to Honeycomb.io using the provided API Key.
INTROSPECTION / PPROF OPTIONS: INTROSPECTION / PPROF OPTIONS:
--pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060) --pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060)
The bind address to serve pprof. The bind address to serve pprof.
--pprof-enable bool, $CODER_PPROF_ENABLE --pprof-enable bool, $CODER_PPROF_ENABLE
Serve pprof metrics on the address defined by pprof address. Serve pprof metrics on the address defined by pprof address.
NETWORKING OPTIONS: NETWORKING OPTIONS:
--access-url url, $CODER_ACCESS_URL --access-url url, $CODER_ACCESS_URL
The URL that users will use to access the Coder deployment. The URL that users will use to access the Coder deployment.
--docs-url url, $CODER_DOCS_URL --docs-url url, $CODER_DOCS_URL
Specifies the custom docs URL. Specifies the custom docs URL.
--proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS --proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
True-Client-Ip, X-Forwarded-For. True-Client-Ip, X-Forwarded-For.
--proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS --proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS
Origin addresses to respect "proxy-trusted-headers". e.g. Origin addresses to respect "proxy-trusted-headers". e.g.
192.168.1.0/24. 192.168.1.0/24.
--redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL --redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL
Specifies whether to redirect requests that do not match the access Specifies whether to redirect requests that do not match the access
URL host. URL host.
--secure-auth-cookie bool, $CODER_SECURE_AUTH_COOKIE --secure-auth-cookie bool, $CODER_SECURE_AUTH_COOKIE
Controls if the 'Secure' property is set on browser session cookies. Controls if the 'Secure' property is set on browser session cookies.
--wildcard-access-url url, $CODER_WILDCARD_ACCESS_URL --wildcard-access-url url, $CODER_WILDCARD_ACCESS_URL
Specifies the wildcard hostname to use for workspace applications in Specifies the wildcard hostname to use for workspace applications in
the form "*.example.com". the form "*.example.com".
@ -160,7 +160,7 @@ between workspaces and users are peer-to-peer. However, when Coder cannot
establish a peer to peer connection, Coder uses a distributed relay network establish a peer to peer connection, Coder uses a distributed relay network
backed by Tailscale and WireGuard. backed by Tailscale and WireGuard.
--block-direct-connections bool, $CODER_BLOCK_DIRECT --block-direct-connections bool, $CODER_BLOCK_DIRECT
Block peer-to-peer (aka. direct) workspace connections. All workspace Block peer-to-peer (aka. direct) workspace connections. All workspace
connections from the CLI will be proxied through Coder (or custom connections from the CLI will be proxied through Coder (or custom
configured DERP servers) and will never be peer-to-peer when enabled. configured DERP servers) and will never be peer-to-peer when enabled.
@ -168,28 +168,28 @@ backed by Tailscale and WireGuard.
until they are restarted after this change has been made, but new until they are restarted after this change has been made, but new
connections will still be proxied regardless. connections will still be proxied regardless.
--derp-config-path string, $CODER_DERP_CONFIG_PATH --derp-config-path string, $CODER_DERP_CONFIG_PATH
Path to read a DERP mapping from. See: Path to read a DERP mapping from. See:
https://tailscale.com/kb/1118/custom-derp-servers/. https://tailscale.com/kb/1118/custom-derp-servers/.
--derp-config-url string, $CODER_DERP_CONFIG_URL --derp-config-url string, $CODER_DERP_CONFIG_URL
URL to fetch a DERP mapping on startup. See: URL to fetch a DERP mapping on startup. See:
https://tailscale.com/kb/1118/custom-derp-servers/. https://tailscale.com/kb/1118/custom-derp-servers/.
--derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS --derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS
Force clients and agents to always use WebSocket to connect to DERP Force clients and agents to always use WebSocket to connect to DERP
relay servers. By default, DERP uses `Upgrade: derp`, which may cause relay servers. By default, DERP uses `Upgrade: derp`, which may cause
issues with some reverse proxies. Clients may automatically fallback issues with some reverse proxies. Clients may automatically fallback
to WebSocket if they detect an issue with `Upgrade: derp`, but this to WebSocket if they detect an issue with `Upgrade: derp`, but this
does not work in all situations. does not work in all situations.
--derp-server-enable bool, $CODER_DERP_SERVER_ENABLE (default: true) --derp-server-enable bool, $CODER_DERP_SERVER_ENABLE (default: true)
Whether to enable or disable the embedded DERP relay server. Whether to enable or disable the embedded DERP relay server.
--derp-server-region-name string, $CODER_DERP_SERVER_REGION_NAME (default: Coder Embedded Relay) --derp-server-region-name string, $CODER_DERP_SERVER_REGION_NAME (default: Coder Embedded Relay)
Region name that for the embedded DERP server. Region name that for the embedded DERP server.
--derp-server-stun-addresses string-array, $CODER_DERP_SERVER_STUN_ADDRESSES (default: stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302) --derp-server-stun-addresses string-array, $CODER_DERP_SERVER_STUN_ADDRESSES (default: stun.l.google.com:19302,stun1.l.google.com:19302,stun2.l.google.com:19302,stun3.l.google.com:19302,stun4.l.google.com:19302)
Addresses for STUN servers to establish P2P connections. It's Addresses for STUN servers to establish P2P connections. It's
recommended to have at least two STUN servers to give users the best recommended to have at least two STUN servers to give users the best
chance of connecting P2P to workspaces. Each STUN server will get it's chance of connecting P2P to workspaces. Each STUN server will get it's
@ -197,7 +197,7 @@ backed by Tailscale and WireGuard.
+ 1`. Use special value 'disable' to turn off STUN completely. + 1`. Use special value 'disable' to turn off STUN completely.
NETWORKING / HTTP OPTIONS: NETWORKING / HTTP OPTIONS:
--disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH --disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH
Disable password authentication. This is recommended for security Disable password authentication. This is recommended for security
purposes in production deployments that rely on an identity provider. purposes in production deployments that rely on an identity provider.
Any user with the owner role will be able to sign in with their Any user with the owner role will be able to sign in with their
@ -206,23 +206,23 @@ backed by Tailscale and WireGuard.
create-admin` command to create a new admin user directly in the create-admin` command to create a new admin user directly in the
database. database.
--disable-session-expiry-refresh bool, $CODER_DISABLE_SESSION_EXPIRY_REFRESH --disable-session-expiry-refresh bool, $CODER_DISABLE_SESSION_EXPIRY_REFRESH
Disable automatic session expiry bumping due to activity. This forces Disable automatic session expiry bumping due to activity. This forces
all sessions to become invalid after the session expiry duration has all sessions to become invalid after the session expiry duration has
been reached. been reached.
--http-address string, $CODER_HTTP_ADDRESS (default: 127.0.0.1:3000) --http-address string, $CODER_HTTP_ADDRESS (default: 127.0.0.1:3000)
HTTP bind address of the server. Unset to disable the HTTP endpoint. HTTP bind address of the server. Unset to disable the HTTP endpoint.
--max-token-lifetime duration, $CODER_MAX_TOKEN_LIFETIME (default: 876600h0m0s) --max-token-lifetime duration, $CODER_MAX_TOKEN_LIFETIME (default: 876600h0m0s)
The maximum lifetime duration users can specify when creating an API The maximum lifetime duration users can specify when creating an API
token. token.
--proxy-health-interval duration, $CODER_PROXY_HEALTH_INTERVAL (default: 1m0s) --proxy-health-interval duration, $CODER_PROXY_HEALTH_INTERVAL (default: 1m0s)
The interval in which coderd should be checking the status of The interval in which coderd should be checking the status of
workspace proxies. workspace proxies.
--session-duration duration, $CODER_SESSION_DURATION (default: 24h0m0s) --session-duration duration, $CODER_SESSION_DURATION (default: 24h0m0s)
The token expiry duration for browser sessions. Sessions may last The token expiry duration for browser sessions. Sessions may last
longer if they are actively making requests, but this functionality longer if they are actively making requests, but this functionality
can be disabled via --disable-session-expiry-refresh. can be disabled via --disable-session-expiry-refresh.
@ -232,178 +232,178 @@ Configure TLS / HTTPS for your Coder deployment. If you're running Coder behind
a TLS-terminating reverse proxy or are accessing Coder over a secure link, you a TLS-terminating reverse proxy or are accessing Coder over a secure link, you
can safely ignore these settings. can safely ignore these settings.
--strict-transport-security int, $CODER_STRICT_TRANSPORT_SECURITY (default: 0) --strict-transport-security int, $CODER_STRICT_TRANSPORT_SECURITY (default: 0)
Controls if the 'Strict-Transport-Security' header is set on all Controls if the 'Strict-Transport-Security' header is set on all
static file responses. This header should only be set if the server is static file responses. This header should only be set if the server is
accessed via HTTPS. This value is the MaxAge in seconds of the header. accessed via HTTPS. This value is the MaxAge in seconds of the header.
--strict-transport-security-options string-array, $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS --strict-transport-security-options string-array, $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS
Two optional fields can be set in the Strict-Transport-Security Two optional fields can be set in the Strict-Transport-Security
header; 'includeSubDomains' and 'preload'. The header; 'includeSubDomains' and 'preload'. The
'strict-transport-security' flag must be set to a non-zero value for 'strict-transport-security' flag must be set to a non-zero value for
these options to be used. these options to be used.
--tls-address host:port, $CODER_TLS_ADDRESS (default: 127.0.0.1:3443) --tls-address host:port, $CODER_TLS_ADDRESS (default: 127.0.0.1:3443)
HTTPS bind address of the server. HTTPS bind address of the server.
--tls-cert-file string-array, $CODER_TLS_CERT_FILE --tls-cert-file string-array, $CODER_TLS_CERT_FILE
Path to each certificate for TLS. It requires a PEM-encoded file. To Path to each certificate for TLS. It requires a PEM-encoded file. To
configure the listener to use a CA certificate, concatenate the configure the listener to use a CA certificate, concatenate the
primary certificate and the CA certificate together. The primary primary certificate and the CA certificate together. The primary
certificate should appear first in the combined file. certificate should appear first in the combined file.
--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none) --tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
Policy the server will follow for TLS Client Authentication. Accepted Policy the server will follow for TLS Client Authentication. Accepted
values are "none", "request", "require-any", "verify-if-given", or values are "none", "request", "require-any", "verify-if-given", or
"require-and-verify". "require-and-verify".
--tls-client-ca-file string, $CODER_TLS_CLIENT_CA_FILE --tls-client-ca-file string, $CODER_TLS_CLIENT_CA_FILE
PEM-encoded Certificate Authority file used for checking the PEM-encoded Certificate Authority file used for checking the
authenticity of client. authenticity of client.
--tls-client-cert-file string, $CODER_TLS_CLIENT_CERT_FILE --tls-client-cert-file string, $CODER_TLS_CLIENT_CERT_FILE
Path to certificate for client TLS authentication. It requires a Path to certificate for client TLS authentication. It requires a
PEM-encoded file. PEM-encoded file.
--tls-client-key-file string, $CODER_TLS_CLIENT_KEY_FILE --tls-client-key-file string, $CODER_TLS_CLIENT_KEY_FILE
Path to key for client TLS authentication. It requires a PEM-encoded Path to key for client TLS authentication. It requires a PEM-encoded
file. file.
--tls-enable bool, $CODER_TLS_ENABLE --tls-enable bool, $CODER_TLS_ENABLE
Whether TLS will be enabled. Whether TLS will be enabled.
--tls-key-file string-array, $CODER_TLS_KEY_FILE --tls-key-file string-array, $CODER_TLS_KEY_FILE
Paths to the private keys for each of the certificates. It requires a Paths to the private keys for each of the certificates. It requires a
PEM-encoded file. PEM-encoded file.
--tls-min-version string, $CODER_TLS_MIN_VERSION (default: tls12) --tls-min-version string, $CODER_TLS_MIN_VERSION (default: tls12)
Minimum supported version of TLS. Accepted values are "tls10", Minimum supported version of TLS. Accepted values are "tls10",
"tls11", "tls12" or "tls13". "tls11", "tls12" or "tls13".
OAUTH2 / GITHUB OPTIONS: OAUTH2 / GITHUB OPTIONS:
--oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE --oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE
Allow all logins, setting this option means allowed orgs and teams Allow all logins, setting this option means allowed orgs and teams
must be empty. must be empty.
--oauth2-github-allow-signups bool, $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS --oauth2-github-allow-signups bool, $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS
Whether new users can sign up with GitHub. Whether new users can sign up with GitHub.
--oauth2-github-allowed-orgs string-array, $CODER_OAUTH2_GITHUB_ALLOWED_ORGS --oauth2-github-allowed-orgs string-array, $CODER_OAUTH2_GITHUB_ALLOWED_ORGS
Organizations the user must be a member of to Login with GitHub. Organizations the user must be a member of to Login with GitHub.
--oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS --oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS
Teams inside organizations the user must be a member of to Login with Teams inside organizations the user must be a member of to Login with
GitHub. Structured as: <organization-name>/<team-slug>. GitHub. Structured as: <organization-name>/<team-slug>.
--oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID --oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID
Client ID for Login with GitHub. Client ID for Login with GitHub.
--oauth2-github-client-secret string, $CODER_OAUTH2_GITHUB_CLIENT_SECRET --oauth2-github-client-secret string, $CODER_OAUTH2_GITHUB_CLIENT_SECRET
Client secret for Login with GitHub. Client secret for Login with GitHub.
--oauth2-github-enterprise-base-url string, $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL --oauth2-github-enterprise-base-url string, $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL
Base URL of a GitHub Enterprise deployment to use for Login with Base URL of a GitHub Enterprise deployment to use for Login with
GitHub. GitHub.
OIDC OPTIONS: OIDC OPTIONS:
--oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false) --oidc-group-auto-create bool, $CODER_OIDC_GROUP_AUTO_CREATE (default: false)
Automatically creates missing groups from a user's groups claim. Automatically creates missing groups from a user's groups claim.
--oidc-allow-signups bool, $CODER_OIDC_ALLOW_SIGNUPS (default: true) --oidc-allow-signups bool, $CODER_OIDC_ALLOW_SIGNUPS (default: true)
Whether new users can sign up with OIDC. Whether new users can sign up with OIDC.
--oidc-auth-url-params struct[map[string]string], $CODER_OIDC_AUTH_URL_PARAMS (default: {"access_type": "offline"}) --oidc-auth-url-params struct[map[string]string], $CODER_OIDC_AUTH_URL_PARAMS (default: {"access_type": "offline"})
OIDC auth URL parameters to pass to the upstream provider. OIDC auth URL parameters to pass to the upstream provider.
--oidc-client-cert-file string, $CODER_OIDC_CLIENT_CERT_FILE --oidc-client-cert-file string, $CODER_OIDC_CLIENT_CERT_FILE
Pem encoded certificate file to use for oauth2 PKI/JWT authorization. Pem encoded certificate file to use for oauth2 PKI/JWT authorization.
The public certificate that accompanies oidc-client-key-file. A The public certificate that accompanies oidc-client-key-file. A
standard x509 certificate is expected. standard x509 certificate is expected.
--oidc-client-id string, $CODER_OIDC_CLIENT_ID --oidc-client-id string, $CODER_OIDC_CLIENT_ID
Client ID to use for Login with OIDC. Client ID to use for Login with OIDC.
--oidc-client-key-file string, $CODER_OIDC_CLIENT_KEY_FILE --oidc-client-key-file string, $CODER_OIDC_CLIENT_KEY_FILE
Pem encoded RSA private key to use for oauth2 PKI/JWT authorization. Pem encoded RSA private key to use for oauth2 PKI/JWT authorization.
This can be used instead of oidc-client-secret if your IDP supports This can be used instead of oidc-client-secret if your IDP supports
it. it.
--oidc-client-secret string, $CODER_OIDC_CLIENT_SECRET --oidc-client-secret string, $CODER_OIDC_CLIENT_SECRET
Client secret to use for Login with OIDC. Client secret to use for Login with OIDC.
--oidc-email-domain string-array, $CODER_OIDC_EMAIL_DOMAIN --oidc-email-domain string-array, $CODER_OIDC_EMAIL_DOMAIN
Email domains that clients logging in with OIDC must match. Email domains that clients logging in with OIDC must match.
--oidc-email-field string, $CODER_OIDC_EMAIL_FIELD (default: email) --oidc-email-field string, $CODER_OIDC_EMAIL_FIELD (default: email)
OIDC claim field to use as the email. OIDC claim field to use as the email.
--oidc-group-field string, $CODER_OIDC_GROUP_FIELD --oidc-group-field string, $CODER_OIDC_GROUP_FIELD
This field must be set if using the group sync feature and the scope This field must be set if using the group sync feature and the scope
name is not 'groups'. Set to the claim to be used for groups. name is not 'groups'. Set to the claim to be used for groups.
--oidc-group-mapping struct[map[string]string], $CODER_OIDC_GROUP_MAPPING (default: {}) --oidc-group-mapping struct[map[string]string], $CODER_OIDC_GROUP_MAPPING (default: {})
A map of OIDC group IDs and the group in Coder it should map to. This A map of OIDC group IDs and the group in Coder it should map to. This
is useful for when OIDC providers only return group IDs. is useful for when OIDC providers only return group IDs.
--oidc-ignore-email-verified bool, $CODER_OIDC_IGNORE_EMAIL_VERIFIED --oidc-ignore-email-verified bool, $CODER_OIDC_IGNORE_EMAIL_VERIFIED
Ignore the email_verified claim from the upstream provider. Ignore the email_verified claim from the upstream provider.
--oidc-ignore-userinfo bool, $CODER_OIDC_IGNORE_USERINFO (default: false) --oidc-ignore-userinfo bool, $CODER_OIDC_IGNORE_USERINFO (default: false)
Ignore the userinfo endpoint and only use the ID token for user Ignore the userinfo endpoint and only use the ID token for user
information. information.
--oidc-issuer-url string, $CODER_OIDC_ISSUER_URL --oidc-issuer-url string, $CODER_OIDC_ISSUER_URL
Issuer URL to use for Login with OIDC. Issuer URL to use for Login with OIDC.
--oidc-group-regex-filter regexp, $CODER_OIDC_GROUP_REGEX_FILTER (default: .*) --oidc-group-regex-filter regexp, $CODER_OIDC_GROUP_REGEX_FILTER (default: .*)
If provided any group name not matching the regex is ignored. This If provided any group name not matching the regex is ignored. This
allows for filtering out groups that are not needed. This filter is allows for filtering out groups that are not needed. This filter is
applied after the group mapping. applied after the group mapping.
--oidc-scopes string-array, $CODER_OIDC_SCOPES (default: openid,profile,email) --oidc-scopes string-array, $CODER_OIDC_SCOPES (default: openid,profile,email)
Scopes to grant when authenticating with OIDC. Scopes to grant when authenticating with OIDC.
--oidc-user-role-default string-array, $CODER_OIDC_USER_ROLE_DEFAULT --oidc-user-role-default string-array, $CODER_OIDC_USER_ROLE_DEFAULT
If user role sync is enabled, these roles are always included for all If user role sync is enabled, these roles are always included for all
authenticated users. The 'member' role is always assigned. authenticated users. The 'member' role is always assigned.
--oidc-user-role-field string, $CODER_OIDC_USER_ROLE_FIELD --oidc-user-role-field string, $CODER_OIDC_USER_ROLE_FIELD
This field must be set if using the user roles sync feature. Set this This field must be set if using the user roles sync feature. Set this
to the name of the claim used to store the user's role. The roles to the name of the claim used to store the user's role. The roles
should be sent as an array of strings. should be sent as an array of strings.
--oidc-user-role-mapping struct[map[string][]string], $CODER_OIDC_USER_ROLE_MAPPING (default: {}) --oidc-user-role-mapping struct[map[string][]string], $CODER_OIDC_USER_ROLE_MAPPING (default: {})
A map of the OIDC passed in user roles and the groups in Coder it A map of the OIDC passed in user roles and the groups in Coder it
should map to. This is useful if the group names do not match. If should map to. This is useful if the group names do not match. If
mapped to the empty string, the role will ignored. mapped to the empty string, the role will ignored.
--oidc-username-field string, $CODER_OIDC_USERNAME_FIELD (default: preferred_username) --oidc-username-field string, $CODER_OIDC_USERNAME_FIELD (default: preferred_username)
OIDC claim field to use as the username. OIDC claim field to use as the username.
--oidc-sign-in-text string, $CODER_OIDC_SIGN_IN_TEXT (default: OpenID Connect) --oidc-sign-in-text string, $CODER_OIDC_SIGN_IN_TEXT (default: OpenID Connect)
The text to show on the OpenID Connect sign in button. The text to show on the OpenID Connect sign in button.
--oidc-icon-url url, $CODER_OIDC_ICON_URL --oidc-icon-url url, $CODER_OIDC_ICON_URL
URL pointing to the icon to use on the OpenID Connect login button. URL pointing to the icon to use on the OpenID Connect login button.
PROVISIONING OPTIONS: PROVISIONING OPTIONS:
Tune the behavior of the provisioner, which is responsible for creating, Tune the behavior of the provisioner, which is responsible for creating,
updating, and deleting workspace resources. updating, and deleting workspace resources.
--provisioner-force-cancel-interval duration, $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL (default: 10m0s) --provisioner-force-cancel-interval duration, $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL (default: 10m0s)
Time to force cancel provisioning tasks that are stuck. Time to force cancel provisioning tasks that are stuck.
--provisioner-daemon-poll-interval duration, $CODER_PROVISIONER_DAEMON_POLL_INTERVAL (default: 1s) --provisioner-daemon-poll-interval duration, $CODER_PROVISIONER_DAEMON_POLL_INTERVAL (default: 1s)
Time to wait before polling for a new job. Time to wait before polling for a new job.
--provisioner-daemon-poll-jitter duration, $CODER_PROVISIONER_DAEMON_POLL_JITTER (default: 100ms) --provisioner-daemon-poll-jitter duration, $CODER_PROVISIONER_DAEMON_POLL_JITTER (default: 100ms)
Random jitter added to the poll interval. Random jitter added to the poll interval.
--provisioner-daemon-psk string, $CODER_PROVISIONER_DAEMON_PSK --provisioner-daemon-psk string, $CODER_PROVISIONER_DAEMON_PSK
Pre-shared key to authenticate external provisioner daemons to Coder Pre-shared key to authenticate external provisioner daemons to Coder
server. server.
--provisioner-daemons int, $CODER_PROVISIONER_DAEMONS (default: 3) --provisioner-daemons int, $CODER_PROVISIONER_DAEMONS (default: 3)
Number of provisioner daemons to create on start. If builds are stuck Number of provisioner daemons to create on start. If builds are stuck
in queued state for a long time, consider increasing this. in queued state for a long time, consider increasing this.
@ -412,11 +412,11 @@ Telemetry is critical to our ability to improve Coder. We strip all
personalinformation before sending data to our servers. Please only disable personalinformation before sending data to our servers. Please only disable
telemetrywhen required by your organization's security policy. telemetrywhen required by your organization's security policy.
--telemetry bool, $CODER_TELEMETRY_ENABLE (default: false) --telemetry bool, $CODER_TELEMETRY_ENABLE (default: false)
Whether telemetry is enabled or not. Coder collects anonymized usage Whether telemetry is enabled or not. Coder collects anonymized usage
data to help improve our product. data to help improve our product.
--telemetry-trace bool, $CODER_TELEMETRY_TRACE (default: false) --telemetry-trace bool, $CODER_TELEMETRY_TRACE (default: false)
Whether Opentelemetry traces are sent to Coder. Coder collects Whether Opentelemetry traces are sent to Coder. Coder collects
anonymized application tracing to help improve our product. Disabling anonymized application tracing to help improve our product. Disabling
telemetry also disables this option. telemetry also disables this option.
@ -425,7 +425,7 @@ telemetrywhen required by your organization's security policy.
Allow users to set quiet hours schedules each day for workspaces to avoid Allow users to set quiet hours schedules each day for workspaces to avoid
workspaces stopping during the day due to template max TTL. workspaces stopping during the day due to template max TTL.
--default-quiet-hours-schedule string, $CODER_QUIET_HOURS_DEFAULT_SCHEDULE --default-quiet-hours-schedule string, $CODER_QUIET_HOURS_DEFAULT_SCHEDULE
The default daily cron schedule applied to users that haven't set a The default daily cron schedule applied to users that haven't set a
custom quiet hours schedule themselves. The quiet hours schedule custom quiet hours schedule themselves. The quiet hours schedule
determines when workspaces will be force stopped due to the template's determines when workspaces will be force stopped due to the template's
@ -436,7 +436,7 @@ workspaces stopping during the day due to template max TTL.
are not supported). are not supported).
⚠️ DANGEROUS OPTIONS: ⚠️ DANGEROUS OPTIONS:
--dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING --dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING
Allow workspace apps that are not served from subdomains to be shared. Allow workspace apps that are not served from subdomains to be shared.
Path-based app sharing is DISABLED by default for security purposes. Path-based app sharing is DISABLED by default for security purposes.
Path-based apps can make requests to the Coder API and pose a security Path-based apps can make requests to the Coder API and pose a security
@ -444,7 +444,7 @@ workspaces stopping during the day due to template max TTL.
can be disabled entirely with --disable-path-apps for further can be disabled entirely with --disable-path-apps for further
security. security.
--dangerous-allow-path-app-site-owner-access bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS --dangerous-allow-path-app-site-owner-access bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS
Allow site-owners to access workspace apps from workspaces they do not Allow site-owners to access workspace apps from workspaces they do not
own. Owners cannot access path-based apps they do not own by default. own. Owners cannot access path-based apps they do not own by default.
Path-based apps can make requests to the Coder API and pose a security Path-based apps can make requests to the Coder API and pose a security
@ -455,14 +455,14 @@ workspaces stopping during the day due to template max TTL.
ENTERPRISE OPTIONS: ENTERPRISE OPTIONS:
These options are only available in the Enterprise Edition. These options are only available in the Enterprise Edition.
--browser-only bool, $CODER_BROWSER_ONLY --browser-only bool, $CODER_BROWSER_ONLY
Whether Coder only allows connections to workspaces via the browser. Whether Coder only allows connections to workspaces via the browser.
--derp-server-relay-url url, $CODER_DERP_SERVER_RELAY_URL --derp-server-relay-url url, $CODER_DERP_SERVER_RELAY_URL
An HTTP URL that is accessible by other replicas to relay DERP An HTTP URL that is accessible by other replicas to relay DERP
traffic. Required for high availability. traffic. Required for high availability.
--external-token-encryption-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS --external-token-encryption-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_KEYS
Encrypt OIDC and Git authentication tokens with AES-256-GCM in the Encrypt OIDC and Git authentication tokens with AES-256-GCM in the
database. The value must be a comma-separated list of base64-encoded database. The value must be a comma-separated list of base64-encoded
keys. Each key, when base64-decoded, must be exactly 32 bytes in keys. Each key, when base64-decoded, must be exactly 32 bytes in
@ -472,7 +472,7 @@ These options are only available in the Enterprise Edition.
process of rotating keys with the `coder server dbcrypt rotate` process of rotating keys with the `coder server dbcrypt rotate`
command. command.
--scim-auth-header string, $CODER_SCIM_AUTH_HEADER --scim-auth-header string, $CODER_SCIM_AUTH_HEADER
Enables SCIM and sets the authentication header for the built-in SCIM Enables SCIM and sets the authentication header for the built-in SCIM
server. New users are automatically created with OIDC authentication. server. New users are automatically created with OIDC authentication.

12
enterprise/cli/testdata/coder_server_create-admin-user_--help.golden vendored
View File

@ -7,27 +7,27 @@ coder v0.0.0-devel
it to every organization. it to every organization.
OPTIONS: OPTIONS:
--email string, $CODER_EMAIL --email string, $CODER_EMAIL
The email of the new user. If not specified, you will be prompted via The email of the new user. If not specified, you will be prompted via
stdin. stdin.
--password string, $CODER_PASSWORD --password string, $CODER_PASSWORD
The password of the new user. If not specified, you will be prompted The password of the new user. If not specified, you will be prompted
via stdin. via stdin.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
URL of a PostgreSQL database. If empty, the built-in PostgreSQL URL of a PostgreSQL database. If empty, the built-in PostgreSQL
deployment will be used (Coder must not be already running in this deployment will be used (Coder must not be already running in this
case). case).
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519) --ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
The algorithm to use for generating ssh keys. Accepted values are The algorithm to use for generating ssh keys. Accepted values are
"ed25519", "ecdsa", or "rsa4096". "ed25519", "ecdsa", or "rsa4096".
--username string, $CODER_USERNAME --username string, $CODER_USERNAME
The username of the new user. If not specified, you will be prompted The username of the new user. If not specified, you will be prompted
via stdin. via stdin.

6
enterprise/cli/testdata/coder_server_dbcrypt_decrypt_--help.golden vendored
View File

@ -6,14 +6,14 @@ coder v0.0.0-devel
Decrypt a previously encrypted database. Decrypt a previously encrypted database.
OPTIONS: OPTIONS:
--keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS --keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS
Keys required to decrypt existing data. Must be a comma-separated list Keys required to decrypt existing data. Must be a comma-separated list
of base64-encoded keys. of base64-encoded keys.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
The connection URL for the Postgres database. The connection URL for the Postgres database.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

4
enterprise/cli/testdata/coder_server_dbcrypt_delete_--help.golden vendored
View File

@ -8,10 +8,10 @@ coder v0.0.0-devel
Aliases: rm Aliases: rm
OPTIONS: OPTIONS:
--postgres-url string, $CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL --postgres-url string, $CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL
The connection URL for the Postgres database. The connection URL for the Postgres database.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

8
enterprise/cli/testdata/coder_server_dbcrypt_rotate_--help.golden vendored
View File

@ -6,17 +6,17 @@ coder v0.0.0-devel
Rotate database encryption keys. Rotate database encryption keys.
OPTIONS: OPTIONS:
--new-key string, $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_NEW_KEY --new-key string, $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_NEW_KEY
The new external token encryption key. Must be base64-encoded. The new external token encryption key. Must be base64-encoded.
--old-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_OLD_KEYS --old-keys string-array, $CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_OLD_KEYS
The old external token encryption keys. Must be a comma-separated list The old external token encryption keys. Must be a comma-separated list
of base64-encoded keys. of base64-encoded keys.
--postgres-url string, $CODER_PG_CONNECTION_URL --postgres-url string, $CODER_PG_CONNECTION_URL
The connection URL for the Postgres database. The connection URL for the Postgres database.
-y, --yes bool -y, --yes bool
Bypass prompts. Bypass prompts.
——— ———

2
enterprise/cli/testdata/coder_server_postgres-builtin-serve_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Run the built-in PostgreSQL deployment. Run the built-in PostgreSQL deployment.
OPTIONS: OPTIONS:
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
——— ———

2
enterprise/cli/testdata/coder_server_postgres-builtin-url_--help.golden vendored
View File

@ -6,7 +6,7 @@ coder v0.0.0-devel
Output the connection URL for the built-in PostgreSQL deployment. Output the connection URL for the built-in PostgreSQL deployment.
OPTIONS: OPTIONS:
--raw-url bool --raw-url bool
Output the raw connection URL instead of a psql command. Output the raw connection URL instead of a psql command.
——— ———