opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): replace clibase with external coder/serpent (#12252)

Browse Source
This commit is contained in:
Ammar Bandukwala
2024-03-15 11:24:38 -05:00
committed by GitHub
parent bed2545636
commit 496232446d
185 changed files with 3770 additions and 7221 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/config-ssh.md
Generated
+34 -34
View File
@@ -25,34 +25,6 @@ workspaces:
## Options
### --coder-binary-path
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
### --disable-autostart
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -n, --dry-run
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
### --ssh-config-file
| | |
@@ -63,14 +35,14 @@ Perform a trial run with no changes made, showing a diff at the end.
Specifies the path to an SSH config.
### --ssh-host-prefix
### --coder-binary-path
| | |
| ----------- | --------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
Override the default host prefix.
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
### -o, --ssh-option
@@ -81,6 +53,15 @@ Override the default host prefix.
Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options
| | |
@@ -90,6 +71,15 @@ Specifies additional SSH options to embed in each host stanza.
Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix
| | |
| ----------- | --------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
Override the default host prefix.
### --wait
| | |
@@ -100,6 +90,16 @@ Specifies whether or not to keep options from previous run of config-ssh.
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
### --disable-autostart
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -y, --yes
| | |
docs/cli/create.md
Generated
+40 -40
View File
@@ -20,42 +20,14 @@ coder create [flags] [name]
## Options
### --automatic-updates
### -t, --template
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
| | |
| ----------- | --------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
| | |
| ----------- | -------------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
### --parameter
| | |
| ----------- | ---------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template.
Specify a template name.
### --start-at
@@ -75,14 +47,24 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
Specify a duration after which the workspace should shut down (e.g. 8h).
### -t, --template
### --automatic-updates
| | |
| ----------- | --------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
Specify a template name.
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
| | |
| ----------- | -------------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
### -y, --yes
@@ -91,3 +73,21 @@ Specify a template name.
| Type | <code>bool</code> |
Bypass prompts.
### --parameter
| | |
| ----------- | ---------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template.
docs/cli/dotfiles.md
Generated
+9 -9
View File
@@ -20,6 +20,15 @@ coder dotfiles [flags] <git_repo_url>
## Options
### --symlink-dir
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
### -b, --branch
| | |
@@ -38,15 +47,6 @@ Specifies which branch to clone. If empty, will default to cloning the default b
Specifies the directory for the dotfiles repository, relative to global config directory.
### --symlink-dir
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
### -y, --yes
| | |
docs/cli/groups.md
Generated
+2 -2
View File
@@ -19,6 +19,6 @@ coder groups
| Name | Purpose |
| ----------------------------------------- | ------------------- |
| [<code>create</code>](./groups_create.md) | Create a user group |
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
| [<code>list</code>](./groups_list.md) | List user groups |
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
| [<code>delete</code>](./groups_delete.md) | Delete a user group |
docs/cli/groups_edit.md
Generated
+10 -10
View File
@@ -12,13 +12,13 @@ coder groups edit [flags] <name>
## Options
### -a, --add-users
### -n, --name
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Add users to the group. Accepts emails or IDs.
Update the group name.
### -u, --avatar-url
@@ -37,13 +37,13 @@ Update the group avatar.
Optional human friendly name for the group.
### -n, --name
### -a, --add-users
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Update the group name.
Add users to the group. Accepts emails or IDs.
### -r, --rm-users
docs/cli/licenses.md
Generated
+1 -1
View File
@@ -19,5 +19,5 @@ coder licenses
| Name | Purpose |
| ------------------------------------------- | --------------------------------- |
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
| [<code>list</code>](./licenses_list.md) | List licenses (including expired) |
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
docs/cli/licenses_add.md
Generated
+8 -8
View File
@@ -12,14 +12,6 @@ coder licenses add [flags] [-f file | -l license]
## Options
### --debug
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output license claims for debugging.
### -f, --file
| | |
@@ -35,3 +27,11 @@ Load license from file.
| Type | <code>string</code> |
License string.
### --debug
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output license claims for debugging.
docs/cli/list.md
Generated
+9 -9
View File
@@ -24,6 +24,15 @@ coder list [flags]
Specifies whether all workspaces will be listed or not.
### --search
| | |
| ------- | --------------------- |
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
@@ -41,12 +50,3 @@ Columns to display in table output. Available columns: favorite, workspace, temp
| Default | <code>table</code> |
Output format. Available formats: table, json.
### --search
| | |
| ------- | --------------------- |
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
docs/cli/login.md
Generated
+9 -9
View File
@@ -21,6 +21,15 @@ coder login [flags] [<url>]
Specifies an email address to use if creating the first user for the deployment.
### --first-user-username
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
Specifies a username to use if creating the first user for the deployment.
### --first-user-password
| | |
@@ -39,15 +48,6 @@ Specifies a password to use if creating the first user for the deployment.
Specifies whether a trial license should be provisioned for the Coder deployment or not.
### --first-user-username
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
Specifies a username to use if creating the first user for the deployment.
### --use-token-as-session
| | |
docs/cli/ping.md
Generated
+12 -12
View File
@@ -12,14 +12,14 @@ coder ping [flags] <workspace>
## Options
### -n, --num
### --wait
| | |
| ------- | ---------------- |
| Type | <code>int</code> |
| Default | <code>10</code> |
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies the number of pings to perform.
Specifies how long to wait between pings.
### -t, --timeout
@@ -30,11 +30,11 @@ Specifies the number of pings to perform.
Specifies how long to wait for a ping to complete.
### --wait
### -n, --num
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>1s</code> |
| | |
| ------- | ---------------- |
| Type | <code>int</code> |
| Default | <code>10</code> |
Specifies how long to wait between pings.
Specifies the number of pings to perform.
docs/cli/port-forward.md
Generated
+10 -10
View File
@@ -42,16 +42,6 @@ machine:
## Options
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -p, --tcp
| | |
@@ -69,3 +59,13 @@ Forward TCP port(s) from the workspace to the local machine.
| Environment | <code>$CODER_PORT_FORWARD_UDP</code> |
Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
docs/cli/provisionerd_start.md
Generated
+67 -67
View File
@@ -22,14 +22,62 @@ coder provisionerd start [flags]
Directory to store cached data.
### --log-filter
### -t, --tag
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
Tags to filter provisioner jobs by.
### --poll-interval
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
Deprecated and ignored.
### --poll-jitter
| | |
| ----------- | -------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
| Default | <code>100ms</code> |
Deprecated and ignored.
### --psk
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
Pre-shared key to authenticate with Coder server.
### --name
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
Name of this provisioner daemon. Defaults to the current hostname without FQDN.
### --verbose
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
| Default | <code>false</code> |
Output debug-level logs.
### --log-human
@@ -59,44 +107,14 @@ Output JSON logs to a given file.
Output Stackdriver compatible logs to a given file.
### --name
### --log-filter
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
Name of this provisioner daemon. Defaults to the current hostname without FQDN.
### --poll-interval
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
Deprecated and ignored.
### --poll-jitter
| | |
| ----------- | -------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
| Default | <code>100ms</code> |
Deprecated and ignored.
### --prometheus-address
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| Default | <code>127.0.0.1:2112</code> |
The bind address to serve prometheus metrics.
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
### --prometheus-enable
@@ -108,30 +126,12 @@ The bind address to serve prometheus metrics.
Serve prometheus metrics on the address defined by prometheus address.
### --psk
### --prometheus-address
| | |
| ----------- | ------------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| Default | <code>127.0.0.1:2112</code> |
Pre-shared key to authenticate with Coder server.
### -t, --tag
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Tags to filter provisioner jobs by.
### --verbose
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
| Default | <code>false</code> |
Output debug-level logs.
The bind address to serve prometheus metrics.
docs/cli/restart.md
Generated
+4 -4
View File
@@ -12,13 +12,13 @@ coder restart [flags] <workspace>
## Options
### --always-prompt
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
Bypass prompts.
### --build-option
@@ -55,10 +55,10 @@ Rich parameter value in the format "name=value".
Specify a file path with values for rich parameters defined in the template.
### -y, --yes
### --always-prompt
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/cli/schedule.md
Generated
+1 -1
View File
@@ -14,7 +14,7 @@ coder schedule { show | start | stop | override } <workspace>
| Name | Purpose |
| --------------------------------------------------------- | ----------------------------------------------------------------- |
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
| [<code>show</code>](./schedule_show.md) | Show workspace schedules |
| [<code>start</code>](./schedule_start.md) | Edit workspace start schedule |
| [<code>stop</code>](./schedule_stop.md) | Edit workspace stop schedule |
| [<code>override-stop</code>](./schedule_override-stop.md) | Override the stop time of a currently running workspace instance. |
docs/cli/schedule_show.md
Generated
+9 -9
View File
@@ -31,6 +31,15 @@ Shows the following information for the given workspace(s):
Specifies whether all workspaces will be listed or not.
### --search
| | |
| ------- | --------------------- |
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
@@ -48,12 +57,3 @@ Columns to display in table output. Available columns: workspace, starts at, sta
| Default | <code>table</code> |
Output format. Available formats: table, json.
### --search
| | |
| ------- | --------------------- |
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
docs/cli/server.md
Generated
+797 -797
View File
File diff suppressed because it is too large Load Diff
docs/cli/server_create-admin-user.md
Generated
+26 -26
View File
@@ -12,24 +12,6 @@ coder server create-admin-user [flags]
## Options
### --email
| | |
| ----------- | ------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL</code> |
The email of the new user. If not specified, you will be prompted via stdin.
### --password
| | |
| ----------- | ---------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PASSWORD</code> |
The password of the new user. If not specified, you will be prompted via stdin.
### --postgres-url
| | |
@@ -39,14 +21,6 @@ The password of the new user. If not specified, you will be prompted via stdin.
URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case).
### --raw-url
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
### --ssh-keygen-algorithm
| | |
@@ -65,3 +39,29 @@ The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ec
| Environment | <code>$CODER_USERNAME</code> |
The username of the new user. If not specified, you will be prompted via stdin.
### --email
| | |
| ----------- | ------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL</code> |
The email of the new user. If not specified, you will be prompted via stdin.
### --password
| | |
| ----------- | ---------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PASSWORD</code> |
The password of the new user. If not specified, you will be prompted via stdin.
### --raw-url
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/cli/server_dbcrypt_decrypt.md
Generated
+9 -9
View File
@@ -12,15 +12,6 @@ coder server dbcrypt decrypt [flags]
## Options
### --keys
| | |
| ----------- | ---------------------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys.
### --postgres-url
| | |
@@ -30,6 +21,15 @@ Keys required to decrypt existing data. Must be a comma-separated list of base64
The connection URL for the Postgres database.
### --keys
| | |
| ----------- | ---------------------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys.
### -y, --yes
| | |
docs/cli/server_dbcrypt_rotate.md
Generated
+9 -9
View File
@@ -12,6 +12,15 @@ coder server dbcrypt rotate [flags]
## Options
### --postgres-url
| | |
| ----------- | ------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
The connection URL for the Postgres database.
### --new-key
| | |
@@ -30,15 +39,6 @@ The new external token encryption key. Must be base64-encoded.
The old external token encryption keys. Must be a comma-separated list of base64-encoded keys.
### --postgres-url
| | |
| ----------- | ------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
The connection URL for the Postgres database.
### -y, --yes
| | |
docs/cli/speedtest.md
Generated
+8 -8
View File
@@ -29,14 +29,6 @@ Specifies whether to wait for a direct connection before testing speed.
Specifies whether to run in reverse mode where the client receives and the server sends.
### --pcap-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specifies a file to write a network capture to.
### -t, --time
| | |
@@ -45,3 +37,11 @@ Specifies a file to write a network capture to.
| Default | <code>5s</code> |
Specifies the duration to monitor traffic.
### --pcap-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specifies a file to write a network capture to.
docs/cli/ssh.md
Generated
+47 -47
View File
@@ -12,15 +12,14 @@ coder ssh [flags] <workspace>
## Options
### --disable-autostart
### --stdio
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
| | |
| ----------- | ----------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Disable starting the workspace automatically when connecting via SSH.
Specifies whether to emit SSH output over stdin/stdout.
### -A, --forward-agent
@@ -49,41 +48,15 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
### -l, --log-dir
### --workspace-poll-interval
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
| | |
| ----------- | ------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
Specify the directory containing SSH diagnostic log files.
### --no-wait
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
Enable remote port forwarding (remote_port:local_address:local_port).
### --stdio
| | |
| ----------- | ----------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Specifies whether to emit SSH output over stdin/stdout.
Specifies how often to poll for workspace automated shutdown.
### --wait
@@ -95,12 +68,39 @@ Specifies whether to emit SSH output over stdin/stdout.
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
### --workspace-poll-interval
### --no-wait
| | |
| ----------- | ------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Specifies how often to poll for workspace automated shutdown.
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
### -l, --log-dir
| | |
| ----------- | ------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
Enable remote port forwarding (remote_port:local_address:local_port).
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
docs/cli/start.md
Generated
+4 -4
View File
@@ -12,13 +12,13 @@ coder start [flags] <workspace>
## Options
### --always-prompt
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
Bypass prompts.
### --build-option
@@ -55,10 +55,10 @@ Rich parameter value in the format "name=value".
Specify a file path with values for rich parameters defined in the template.
### -y, --yes
### --always-prompt
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/cli/stat.md
Generated
+1 -1
View File
@@ -15,8 +15,8 @@ coder stat [flags]
| Name | Purpose |
| ----------------------------------- | -------------------------------- |
| [<code>cpu</code>](./stat_cpu.md) | Show CPU usage, in cores. |
| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes. |
| [<code>mem</code>](./stat_mem.md) | Show memory usage, in gigabytes. |
| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes. |
## Options
docs/cli/stat_disk.md
Generated
+9 -9
View File
@@ -12,15 +12,6 @@ coder stat disk [flags]
## Options
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>text</code> |
Output format. Available formats: text, json.
### --path
| | |
@@ -38,3 +29,12 @@ Path for which to check disk usage.
| Default | <code>Gi</code> |
SI Prefix for disk measurement.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>text</code> |
Output format. Available formats: text, json.
docs/cli/stat_mem.md
Generated
+9 -9
View File
@@ -20,15 +20,6 @@ coder stat mem [flags]
Force host memory measurement.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>text</code> |
Output format. Available formats: text, json.
### --prefix
| | |
@@ -37,3 +28,12 @@ Output format. Available formats: text, json.
| Default | <code>Gi</code> |
SI Prefix for memory measurement.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>text</code> |
Output format. Available formats: text, json.
docs/cli/templates.md
Generated
+3 -3
View File
@@ -32,12 +32,12 @@ workspaces:
| Name | Purpose |
| ------------------------------------------------ | -------------------------------------------------------------------------------- |
| [<code>archive</code>](./templates_archive.md) | Archive unused or failed template versions from a given template(s) |
| [<code>create</code>](./templates_create.md) | DEPRECATED: Create a template from the current directory or as specified by flag |
| [<code>delete</code>](./templates_delete.md) | Delete templates |
| [<code>edit</code>](./templates_edit.md) | Edit the metadata of a template by name. |
| [<code>init</code>](./templates_init.md) | Get started with a templated template. |
| [<code>list</code>](./templates_list.md) | List all the templates available for the organization |
| [<code>pull</code>](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. |
| [<code>push</code>](./templates_push.md) | Create or update a template from the current directory or as specified by flag |
| [<code>versions</code>](./templates_versions.md) | Manage different versions of the specified template |
| [<code>delete</code>](./templates_delete.md) | Delete templates |
| [<code>pull</code>](./templates_pull.md) | Download the active, latest, or specified version of a template to a path. |
| [<code>archive</code>](./templates_archive.md) | Archive unused or failed template versions from a given template(s) |
docs/cli/templates_archive.md
Generated
+8 -8
View File
@@ -12,14 +12,6 @@ coder templates archive [flags] [template-name...]
## Options
### --all
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Include all unused template versions. By default, only failed template versions are archived.
### -y, --yes
| | |
@@ -27,3 +19,11 @@ Include all unused template versions. By default, only failed template versions
| Type | <code>bool</code> |
Bypass prompts.
### --all
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Include all unused template versions. By default, only failed template versions are archived.
docs/cli/templates_create.md
Generated
+81 -81
View File
@@ -12,6 +12,46 @@ coder templates create [flags] [name]
## Options
### --private
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
### --variables-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### --variable
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --var
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Alias of --variable.
### --provisioner-tag
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --default-ttl
| | |
@@ -21,33 +61,6 @@ coder templates create [flags] [name]
Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### -d, --directory
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>.</code> |
Specify the directory to create from, use '-' to read tar from stdin.
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --dormancy-threshold
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --failure-ttl
| | |
@@ -57,14 +70,23 @@ Specify a duration workspaces may be inactive prior to being moved to the dorman
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
### --ignore-lockfile
### --dormancy-threshold
| | |
| ------- | ------------------ |
| Type | <code>bool</code> |
| Default | <code>false</code> |
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --max-ttl
@@ -74,30 +96,6 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.
### -m, --message
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
### --private
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
### --provisioner-tag
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --require-active-version
| | |
@@ -107,30 +105,6 @@ Specify a set of tags to target provisioner daemons.
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
### --var
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Alias of --variable.
### --variable
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --variables-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### -y, --yes
| | |
@@ -138,3 +112,29 @@ Specify a file path with values for Terraform-managed variables.
| Type | <code>bool</code> |
Bypass prompts.
### -d, --directory
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>.</code> |
Specify the directory to create from, use '-' to read tar from stdin.
### --ignore-lockfile
| | |
| ------- | ------------------ |
| Type | <code>bool</code> |
| Default | <code>false</code> |
Ignore warnings about not having a .terraform.lock.hcl file present in the template.
### -m, --message
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
docs/cli/templates_edit.md
Generated
+106 -106
View File
@@ -12,6 +12,54 @@ coder templates edit [flags] <template>
## Options
### --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template name.
### --display-name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template display name.
### --description
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template description.
### --deprecated
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
### --icon
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template icon path.
### --default-ttl
| | |
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### --activity-bump
| | |
@@ -20,6 +68,58 @@ coder templates edit [flags] <template>
Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to "Activity bump" in the UI.
### --max-ttl
| | |
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
### --autostart-requirement-weekdays
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
### --failure-ttl
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
### --dormancy-threshold
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --allow-user-cancel-workspace-jobs
| | |
| ------- | ----------------- |
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to cancel in-progress workspace jobs.
### --allow-user-autostart
| | |
@@ -38,105 +138,14 @@ Allow users to configure autostart for workspaces on this template. This can onl
Allow users to customize the autostop TTL for workspaces on this template. This can only be disabled in enterprise.
### --allow-user-cancel-workspace-jobs
### --require-active-version
| | |
| ------- | ----------------- |
| Type | <code>bool</code> |
| Default | <code>true</code> |
| | |
| ------- | ------------------ |
| Type | <code>bool</code> |
| Default | <code>false</code> |
Allow users to cancel in-progress workspace jobs.
### --autostart-requirement-weekdays
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
### --default-ttl
| | |
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### --deprecated
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
### --description
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template description.
### --display-name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template display name.
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be in the dormant state prior to being deleted. This licensed feature's default is 0h (off). Maps to "Dormancy Auto-Deletion" in the UI.
### --dormancy-threshold
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a duration workspaces may be inactive prior to being moved to the dormant state. This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --failure-ttl
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
### --icon
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template icon path.
### --max-ttl
| | |
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
### --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template name.
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
### --private
@@ -147,15 +156,6 @@ Edit the template name.
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
### --require-active-version
| | |
| ------- | ------------------ |
| Type | <code>bool</code> |
| Default | <code>false</code> |
Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature.
### -y, --yes
| | |
docs/cli/templates_pull.md
Generated
+8 -8
View File
@@ -20,6 +20,14 @@ coder templates pull [flags] <name> [destination]
Output the template as a tar archive to stdout.
### --zip
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the template as a zip archive to stdout.
### --version
| | |
@@ -35,11 +43,3 @@ The name of the template version to pull. Use 'active' to pull the active versio
| Type | <code>bool</code> |
Bypass prompts.
### --zip
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the template as a zip archive to stdout.
docs/cli/templates_push.md
Generated
+50 -50
View File
@@ -12,6 +12,54 @@ coder templates push [flags] [template]
## Options
### --variables-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### --variable
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --var
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Alias of --variable.
### --provisioner-tag
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a name for the new template version. It will be automatically generated if not provided.
### --always-prompt
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from active template version.
### --activate
| | |
@@ -21,13 +69,13 @@ coder templates push [flags] [template]
Whether the new template will be marked active.
### --always-prompt
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from active template version.
Bypass prompts.
### -d, --directory
@@ -54,51 +102,3 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
### --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a name for the new template version. It will be automatically generated if not provided.
### --provisioner-tag
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --var
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Alias of --variable.
### --variable
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
### --variables-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.
docs/cli/templates_versions.md
Generated
+1 -1
View File
@@ -26,6 +26,6 @@ coder templates versions
| Name | Purpose |
| ----------------------------------------------------------- | ----------------------------------------------- |
| [<code>archive</code>](./templates_versions_archive.md) | Archive a template version(s). |
| [<code>list</code>](./templates_versions_list.md) | List all the versions of the specified template |
| [<code>archive</code>](./templates_versions_archive.md) | Archive a template version(s). |
| [<code>unarchive</code>](./templates_versions_unarchive.md) | Unarchive a template version(s). |
docs/cli/templates_versions_list.md
Generated
+8 -8
View File
@@ -12,6 +12,14 @@ coder templates versions list [flags] <template>
## Options
### --include-archived
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Include archived versions in the result list.
### -c, --column
| | |
@@ -21,14 +29,6 @@ coder templates versions list [flags] <template>
Columns to display in table output. Available columns: name, created at, created by, status, active, archived.
### --include-archived
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Include archived versions in the result list.
### -o, --output
| | |
docs/cli/update.md
Generated
+8 -8
View File
@@ -18,14 +18,6 @@ Use --always-prompt to change the parameter values of the workspace.
## Options
### --always-prompt
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
### --build-option
| | |
@@ -60,3 +52,11 @@ Rich parameter value in the format "name=value".
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template.
### --always-prompt
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/cli/users.md
Generated
+2 -2
View File
@@ -18,9 +18,9 @@ coder users [subcommand]
| Name | Purpose |
| -------------------------------------------- | ------------------------------------------------------------------------------------- |
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>create</code>](./users_create.md) | |
| [<code>delete</code>](./users_delete.md) | Delete a user by username or user_id. |
| [<code>list</code>](./users_list.md) | |
| [<code>show</code>](./users_show.md) | Show a single user. Use 'me' to indicate the currently authenticated user. |
| [<code>delete</code>](./users_delete.md) | Delete a user by username or user_id. |
| [<code>activate</code>](./users_activate.md) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>suspend</code>](./users_suspend.md) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |
docs/cli/users_create.md
Generated
+4 -4
View File
@@ -18,13 +18,13 @@ coder users create [flags]
Specifies an email address for the new user.
### --login-type
### -u, --username
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Optionally specify the login type for the user. Valid values are: password, none, github, oidc. Using 'none' prevents the user from authenticating and requires an API key/token to be generated by an admin.
Specifies a username for the new user.
### -p, --password
@@ -34,10 +34,10 @@ Optionally specify the login type for the user. Valid values are: password, none
Specifies a password for the new user.
### -u, --username
### --login-type
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specifies a username for the new user.
Optionally specify the login type for the user. Valid values are: password, none, github, oidc. Using 'none' prevents the user from authenticating and requires an API key/token to be generated by an admin.