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

feat: convert entire CLI to clibase (#6491)

Browse Source 
I'm sorry.
This commit is contained in:
Ammar Bandukwala
2023-03-23 17:42:20 -05:00
committed by GitHub
parent b71b8daa21
commit 2bd6d2908e
345 changed files with 9965 additions and 9082 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
docs/cli/coder_config-ssh.md
View File

@ -1,75 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
## Usage
```console
coder config-ssh [flags]
```
## Examples
```console
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
$ coder config-ssh -o ForwardAgent=yes
- You can use --dry-run (or -n) to see the changes that would be made:
$ coder config-ssh --dry-run
```
## Flags
### --dry-run, -n
Perform a trial run with no changes made, showing a diff at the end.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --ssh-config-file
Specifies the path to an SSH config.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
### --ssh-host-prefix
Override the default host prefix.
<br/>
| | |
| --- | --- |
### --ssh-option, -o
Specifies additional SSH options to embed in each host stanza.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --use-previous-options
Specifies whether or not to keep options from previous run of config-ssh.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
| Default | <code>false</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

62
docs/cli/coder_create.md
View File

@ -1,62 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder create
Create a workspace
## Usage
```console
coder create [name] [flags]
```
## Flags
### --parameter-file
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PARAMETER_FILE</code> |
### --rich-parameter-file
Specify a file path with values for rich parameters defined in the template.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_RICH_PARAMETER_FILE</code> |
### --start-at
Specify the workspace autostart schedule. Check `coder schedule start --help` for the syntax.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_WORKSPACE_START_AT</code> |
### --stop-after
Specify a duration after which the workspace should shut down (e.g. 8h).
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
| Default | <code>0s</code> |
### --template, -t
Specify a template name.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TEMPLATE_NAME</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

29
docs/cli/coder_delete.md
View File

@ -1,29 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder delete
Delete a workspace
## Usage
```console
coder delete <workspace> [flags]
```
## Flags
### --orphan
Delete a workspace without deleting its resources. This can delete a<br/>workspace in a broken state, but may also lead to unaccounted cloud resources.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

37
docs/cli/coder_dotfiles.md
View File

@ -1,37 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder dotfiles
Checkout and install a dotfiles repository from a Git URL
## Usage
```console
coder dotfiles [git_repo_url] [flags]
```
## Examples
```console
- Check out and install a dotfiles repository without prompts:
$ coder dotfiles --yes git@github.com:example/dotfiles.git
```
## Flags
### --symlink-dir
Specifies the directory for the dotfiles symlink destinations. If empty will use $HOME.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SYMLINK_DIR</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

45
docs/cli/coder_list.md
View File

@ -1,45 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder list
List workspaces
## Usage
```console
coder list [flags]
```
## Flags
### --all, -a
Specifies whether all workspaces will be listed or not.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --column, -c
Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after
<br/>
| | |
| --- | --- |
| Default | <code>[workspace,template,status,last built,outdated,starts at,stops after]</code> |
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |
### --search
Search for a workspace with a query.
<br/>
| | |
| --- | --- |
| Default | <code>owner:me</code> |

46
docs/cli/coder_login.md
View File

@ -1,46 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder login
Authenticate with Coder deployment
## Usage
```console
coder login <url> [flags]
```
## Flags
### --first-user-email
Specifies an email address to use if creating the first user for the deployment.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_FIRST_USER_EMAIL</code> |
### --first-user-password
Specifies a password to use if creating the first user for the deployment.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_FIRST_USER_PASSWORD</code> |
### --first-user-trial
Specifies whether a trial license should be provisioned for the Coder deployment or not.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_FIRST_USER_TRIAL</code> |
| Default | <code>false</code> |
### --first-user-username
Specifies a username to use if creating the first user for the deployment.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_FIRST_USER_USERNAME</code> |

21
docs/cli/coder_logout.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder logout
Unauthenticate your local session
## Usage
```console
coder logout [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

45
docs/cli/coder_ping.md
View File

@ -1,45 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder ping
Ping a workspace
## Usage
```console
coder ping <workspace> [flags]
```
## Flags
### --num, -n
Specifies the number of pings to perform.
<br/>
| | |
| --- | --- |
| Default | <code>10</code> |
### --timeout, -t
Specifies how long to wait for a ping to complete.
<br/>
| | |
| --- | --- |
| Default | <code>5s</code> |
### --verbose, -v
Enables verbose logging.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --wait
Specifies how long to wait between pings.
<br/>
| | |
| --- | --- |
| Default | <code>1s</code> |

21
docs/cli/coder_rename.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder rename
Rename a workspace
## Usage
```console
coder rename <workspace> <new name> [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

21
docs/cli/coder_reset-password.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder reset-password
Directly connect to the database to reset a user's password
## Usage
```console
coder reset-password <username> [flags]
```
## Flags
### --postgres-url
URL of a PostgreSQL database to connect to.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PG_CONNECTION_URL</code> |

21
docs/cli/coder_restart.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder restart
Restart a workspace
## Usage
```console
coder restart <workspace> [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

18
docs/cli/coder_scaletest.md
View File

@ -1,18 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder scaletest
Perform scale tests against the Coder server.
## Usage
```console
coder scaletest [flags]
```
## Subcommands
| Name | Purpose |
| --------------------------------------------------------------------- | ------------------------------------------------------ |
| [<code>cleanup</code>](./coder_scaletest_cleanup) | Cleanup any orphaned scaletest resources |
| [<code>create-workspaces</code>](./coder_scaletest_create-workspaces) | Creates many workspaces and waits for them to be ready |

40
docs/cli/coder_scaletest_cleanup.md
View File

@ -1,40 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder scaletest cleanup
Cleanup scaletest workspaces, then cleanup scaletest users. The strategy flags will apply to each stage of the cleanup process.
## Usage
```console
coder scaletest cleanup [flags]
```
## Flags
### --cleanup-concurrency
Number of concurrent cleanup jobs to run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_CONCURRENCY</code> |
| Default | <code>1</code> |
### --cleanup-job-timeout
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_JOB_TIMEOUT</code> |
| Default | <code>5m0s</code> |
### --cleanup-timeout
Timeout for the entire cleanup run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_TIMEOUT</code> |
| Default | <code>30m0s</code> |

261
docs/cli/coder_scaletest_create-workspaces.md
View File

@ -1,261 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder scaletest create-workspaces
Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
It is recommended that all rate limits are disabled on the server before running this scaletest. This test generates many login events which will be rate limited against the (most likely single) IP.
## Usage
```console
coder scaletest create-workspaces [flags]
```
## Flags
### --cleanup-concurrency
Number of concurrent cleanup jobs to run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_CONCURRENCY</code> |
| Default | <code>1</code> |
### --cleanup-job-timeout
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_JOB_TIMEOUT</code> |
| Default | <code>5m0s</code> |
### --cleanup-timeout
Timeout for the entire cleanup run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CLEANUP_TIMEOUT</code> |
| Default | <code>30m0s</code> |
### --concurrency
Number of concurrent jobs to run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONCURRENCY</code> |
| Default | <code>1</code> |
### --connect-hold
How long to hold the WireGuard connection open for.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONNECT_HOLD</code> |
| Default | <code>30s</code> |
### --connect-interval
How long to wait between making requests to the --connect-url once the connection is established.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONNECT_INTERVAL</code> |
| Default | <code>1s</code> |
### --connect-mode
Mode to use for connecting to the workspace. Can be 'derp' or 'direct'.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONNECT_MODE</code> |
| Default | <code>derp</code> |
### --connect-timeout
Timeout for each request to the --connect-url.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONNECT_TIMEOUT</code> |
| Default | <code>5s</code> |
### --connect-url
URL to connect to inside the the workspace over WireGuard. If not specified, no connections will be made over WireGuard.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_CONNECT_URL</code> |
### --count, -c
Required: Number of workspaces to create.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_COUNT</code> |
| Default | <code>1</code> |
### --job-timeout
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_JOB_TIMEOUT</code> |
| Default | <code>5m0s</code> |
### --no-cleanup
Do not clean up resources after the test completes. You can cleanup manually using `coder scaletest cleanup`.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_NO_CLEANUP</code> |
| Default | <code>false</code> |
### --no-plan
Skip the dry-run step to plan the workspace creation. This step ensures that the given parameters are valid for the given template.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_NO_PLAN</code> |
| Default | <code>false</code> |
### --no-wait-for-agents
Do not wait for agents to start before marking the test as succeeded. This can be useful if you are running the test against a template that does not start the agent quickly.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_NO_WAIT_FOR_AGENTS</code> |
| Default | <code>false</code> |
### --output
Output format specs in the format "<format>[:<path>]". Not specifying a path will default to stdout. Available formats: text, json.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SCALETEST_OUTPUTS</code> |
| Default | <code>[text]</code> |
### --parameter
Parameters to use for each workspace. Can be specified multiple times. Overrides any existing parameters with the same name from --parameters-file. Format: key=value.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_PARAMETERS</code> |
| Default | <code>[]</code> |
### --parameters-file
Path to a YAML file containing the parameters to use for each workspace.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_PARAMETERS_FILE</code> |
### --run-command
Command to run inside each workspace using reconnecting-pty (i.e. web terminal protocol). If not specified, no command will be run.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_RUN_COMMAND</code> |
### --run-expect-output
Expect the command to output the given string (on a single line). If the command does not output the given string, it will be marked as failed.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_RUN_EXPECT_OUTPUT</code> |
### --run-expect-timeout
Expect the command to timeout. If the command does not finish within the given --run-timeout, it will be marked as succeeded. If the command finishes before the timeout, it will be marked as failed.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_RUN_EXPECT_TIMEOUT</code> |
| Default | <code>false</code> |
### --run-log-output
Log the output of the command to the test logs. This should be left off unless you expect small amounts of output. Large amounts of output will cause high memory usage.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_RUN_LOG_OUTPUT</code> |
| Default | <code>false</code> |
### --run-timeout
Timeout for the command to complete.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_RUN_TIMEOUT</code> |
| Default | <code>5s</code> |
### --template, -t
Required: Name or ID of the template to use for workspaces.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TEMPLATE</code> |
### --timeout
Timeout for the entire test run. 0 means unlimited.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TIMEOUT</code> |
| Default | <code>30m0s</code> |
### --trace
Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TRACE</code> |
| Default | <code>false</code> |
### --trace-coder
Whether opentelemetry traces are sent to Coder. We recommend keeping this disabled unless we advise you to enable it.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TRACE_CODER</code> |
| Default | <code>false</code> |
### --trace-honeycomb-api-key
Enables trace exporting to Honeycomb.io using the provided API key.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TRACE_HONEYCOMB_API_KEY</code> |
### --trace-propagate
Enables trace propagation to the Coder backend, which will be used to correlate server-side spans with client-side spans. Only enable this if the server is configured with the exact same tracing configuration as the client.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOADTEST_TRACE_PROPAGATE</code> |
| Default | <code>false</code> |

20
docs/cli/coder_schedule.md
View File

@ -1,20 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule
Schedule automated start and stop times for workspaces
## Usage
```console
coder schedule { show | start | stop | override } <workspace> [flags]
```
## Subcommands
| Name | Purpose |
| ------------------------------------------------------------ | ---------------------------------- |
| [<code>override-stop</code>](./coder_schedule_override-stop) | Edit stop time of active workspace |
| [<code>show</code>](./coder_schedule_show) | Show workspace schedule |
| [<code>start</code>](./coder_schedule_start) | Edit workspace start schedule |
| [<code>stop</code>](./coder_schedule_stop) | Edit workspace stop schedule |

16
docs/cli/coder_schedule_show.md
View File

@ -1,16 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule show
Shows the following information for the given workspace:
- The automatic start schedule
- The next scheduled start time
- The duration after which it will stop
- The next scheduled stop time
## Usage
```console
coder schedule show <workspace-name> [flags]
```

28
docs/cli/coder_schedule_start.md
View File

@ -1,28 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule start
Schedules a workspace to regularly start at a specific time.
Schedule format: <start-time> [day-of-week] [location].
- Start-time (required) is accepted either in 12-hour (hh:mm{am|pm}) format, or 24-hour format hh:mm.
- Day-of-week (optional) allows specifying in the cron format, e.g. 1,3,5 or Mon-Fri.
Aliases such as @daily are not supported.
Default: \* (every day)
- Location (optional) must be a valid location in the IANA timezone database.
If omitted, we will fall back to either the TZ environment variable or /etc/localtime.
You can check your corresponding location by visiting https://ipinfo.io - it shows in the demo widget on the right.
## Usage
```console
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual } [flags]
```
## Examples
```console
- Set the workspace to start at 9:30am (in Dublin) from Monday to Friday:
$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin
```

30
docs/cli/coder_schedule_stop.md
View File

@ -1,30 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule stop
Schedules a workspace to stop after a given duration has elapsed.
- Workspace runtime is measured from the time that the workspace build completed.
- The minimum scheduled stop time is 1 minute.
- The workspace template may place restrictions on the maximum shutdown time.
- Changes to workspace schedules only take effect upon the next build of the workspace,
and do not affect a running instance of a workspace.
When enabling scheduled stop, enter a duration in one of the following formats:
- 3h2m (3 hours and two minutes)
- 3h (3 hours)
- 2m (2 minutes)
- 2 (2 minutes)
## Usage
```console
coder schedule stop <workspace-name> { <duration> | manual } [flags]
```
## Examples
```console
$ coder schedule stop my-workspace 2h30m
```

660
docs/cli/coder_server.md
View File

@ -1,660 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder server
Start a Coder server
## Usage
```console
coder server [flags]
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [<code>create-admin-user</code>](./coder_server_create-admin-user) | Create a new admin user with the given username, email and password and adds it to every organization. |
| [<code>postgres-builtin-serve</code>](./coder_server_postgres-builtin-serve) | Run the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-url</code>](./coder_server_postgres-builtin-url) | Output the connection URL for the built-in PostgreSQL deployment. |
## Flags
### --access-url
External URL to access your deployment. This must be accessible by all provisioned workspaces.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_ACCESS_URL</code> |
### --api-rate-limit
Maximum number of requests per minute allowed to the API per user, or per IP address for unauthenticated users. Negative values mean no rate limit. Some API endpoints have separate strict rate limits regardless of this value to prevent denial-of-service or brute force attacks.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_API_RATE_LIMIT</code> |
| Default | <code>512</code> |
### --cache-dir
The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_CACHE_DIRECTORY</code> |
| Default | <code>~/.cache/coder</code> |
### --dangerous-allow-path-app-sharing
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 apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SHARING</code> |
| Default | <code>false</code> |
### --dangerous-allow-path-app-site-owner-access
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. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS</code> |
| Default | <code>false</code> |
### --dangerous-disable-rate-limits
Disables all rate limits. This is not recommended in production.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_RATE_LIMIT_DISABLE_ALL</code> |
| Default | <code>false</code> |
### --derp-config-path
Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_CONFIG_PATH</code> |
### --derp-config-url
URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_CONFIG_URL</code> |
### --derp-server-enable
Whether to enable or disable the embedded DERP relay server.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_SERVER_ENABLE</code> |
| Default | <code>true</code> |
### --derp-server-region-code
Region code to use for the embedded DERP server.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_SERVER_REGION_CODE</code> |
| Default | <code>coder</code> |
### --derp-server-region-id
Region ID to use for the embedded DERP server.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_SERVER_REGION_ID</code> |
| Default | <code>999</code> |
### --derp-server-region-name
Region name that for the embedded DERP server.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_SERVER_REGION_NAME</code> |
| Default | <code>Coder Embedded Relay</code> |
### --derp-server-stun-addresses
Addresses for STUN servers to establish P2P connections. Set empty to disable P2P connections.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DERP_SERVER_STUN_ADDRESSES</code> |
| Default | <code>[stun.l.google.com:19302]</code> |
### --disable-password-auth
Disable password authentication. This is recommended for security purposes in production deployments that rely on an identity provider. Any user with the owner role will be able to sign in with their password regardless of this setting to avoid potential lock out. If you are locked out of your account, you can use the `coder server create-admin` command to create a new admin user directly in the database.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DISABLE_PASSWORD_AUTH</code> |
| Default | <code>false</code> |
### --disable-path-apps
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 the workspace serves malicious JavaScript. This is recommended for security purposes if a --wildcard-access-url is configured.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DISABLE_PATH_APPS</code> |
| Default | <code>false</code> |
### --disable-session-expiry-refresh
Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_DISABLE_SESSION_EXPIRY_REFRESH</code> |
| Default | <code>false</code> |
### --experiments
Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '\*' to opt-in to all available experiments.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_EXPERIMENTS</code> |
| Default | <code>[]</code> |
### --http-address
HTTP bind address of the server. Unset to disable the HTTP endpoint.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_HTTP_ADDRESS</code> |
| Default | <code>127.0.0.1:3000</code> |
### --log-human
Output human-readable logs to a given file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOGGING_HUMAN</code> |
| Default | <code>/dev/stderr</code> |
### --log-json
Output JSON logs to a given file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOGGING_JSON</code> |
### --log-stackdriver
Output Stackdriver compatible logs to a given file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_LOGGING_STACKDRIVER</code> |
### --max-token-lifetime
The maximum lifetime duration users can specify when creating an API token.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_MAX_TOKEN_LIFETIME</code> |
| Default | <code>2540400h0m0s</code> |
### --oauth2-github-allow-everyone
Allow all logins, setting this option means allowed orgs and teams must be empty.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_ALLOW_EVERYONE</code> |
| Default | <code>false</code> |
### --oauth2-github-allow-signups
Whether new users can sign up with GitHub.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS</code> |
| Default | <code>false</code> |
### --oauth2-github-allowed-orgs
Organizations the user must be a member of to Login with GitHub.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_ALLOWED_ORGS</code> |
| Default | <code>[]</code> |
### --oauth2-github-allowed-teams
Teams inside organizations the user must be a member of to Login with GitHub. Structured as: <organization-name>/<team-slug>.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_ALLOWED_TEAMS</code> |
| Default | <code>[]</code> |
### --oauth2-github-client-id
Client ID for Login with GitHub.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_CLIENT_ID</code> |
### --oauth2-github-client-secret
Client secret for Login with GitHub.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_CLIENT_SECRET</code> |
### --oauth2-github-enterprise-base-url
Base URL of a GitHub Enterprise deployment to use for Login with GitHub.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL</code> |
### --oidc-allow-signups
Whether new users can sign up with OIDC.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_ALLOW_SIGNUPS</code> |
| Default | <code>true</code> |
### --oidc-client-id
Client ID to use for Login with OIDC.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_CLIENT_ID</code> |
### --oidc-client-secret
Client secret to use for Login with OIDC.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_CLIENT_SECRET</code> |
### --oidc-email-domain
Email domains that clients logging in with OIDC must match.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_EMAIL_DOMAIN</code> |
| Default | <code>[]</code> |
### --oidc-icon-url
URL pointing to the icon to use on the OepnID Connect login button
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_ICON_URL</code> |
### --oidc-ignore-email-verified
Ignore the email_verified claim from the upstream provider.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_IGNORE_EMAIL_VERIFIED</code> |
| Default | <code>false</code> |
### --oidc-issuer-url
Issuer URL to use for Login with OIDC.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_ISSUER_URL</code> |
### --oidc-scopes
Scopes to grant when authenticating with OIDC.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_SCOPES</code> |
| Default | <code>[openid,profile,email]</code> |
### --oidc-sign-in-text
The text to show on the OpenID Connect sign in button
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_SIGN_IN_TEXT</code> |
| Default | <code>OpenID Connect</code> |
### --oidc-username-field
OIDC claim field to use as the username.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_OIDC_USERNAME_FIELD</code> |
| Default | <code>preferred_username</code> |
### --postgres-url
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root. Access the built-in database with "coder server postgres-builtin-url".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PG_CONNECTION_URL</code> |
### --pprof-address
The bind address to serve pprof.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PPROF_ADDRESS</code> |
| Default | <code>127.0.0.1:6060</code> |
### --pprof-enable
Serve pprof metrics on the address defined by pprof address.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PPROF_ENABLE</code> |
| Default | <code>false</code> |
### --prometheus-address
The bind address to serve prometheus metrics.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| Default | <code>127.0.0.1:2112</code> |
### --prometheus-enable
Serve prometheus metrics on the address defined by prometheus address.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROMETHEUS_ENABLE</code> |
| Default | <code>false</code> |
### --provisioner-daemon-poll-interval
Time to wait before polling for a new job.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROVISIONER_DAEMON_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
### --provisioner-daemon-poll-jitter
Random jitter added to the poll interval.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROVISIONER_DAEMON_POLL_JITTER</code> |
| Default | <code>100ms</code> |
### --provisioner-daemons
Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROVISIONER_DAEMONS</code> |
| Default | <code>3</code> |
### --provisioner-force-cancel-interval
Time to force cancel provisioning tasks that are stuck.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROVISIONER_FORCE_CANCEL_INTERVAL</code> |
| Default | <code>10m0s</code> |
### --proxy-trusted-headers
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROXY_TRUSTED_HEADERS</code> |
| Default | <code>[]</code> |
### --proxy-trusted-origins
Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PROXY_TRUSTED_ORIGINS</code> |
| Default | <code>[]</code> |
### --redirect-to-access-url
Specifies whether to redirect requests that do not match the access URL host.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_REDIRECT_TO_ACCESS_URL</code> |
| Default | <code>false</code> |
### --secure-auth-cookie
Controls if the 'Secure' property is set on browser session cookies.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SECURE_AUTH_COOKIE</code> |
| Default | <code>false</code> |
### --session-duration
The token expiry duration for browser sessions. Sessions may last longer if they are actively making requests, but this functionality can be disabled via --disable-session-expiry-refresh.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_MAX_SESSION_EXPIRY</code> |
| Default | <code>24h0m0s</code> |
### --ssh-keygen-algorithm
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
### --strict-transport-security
Controls if the 'Strict-Transport-Security' header is set on all 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.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_STRICT_TRANSPORT_SECURITY</code> |
| Default | <code>0</code> |
### --strict-transport-security-options
Two optional fields can be set in the Strict-Transport-Security header; 'includeSubDomains' and 'preload'. The 'strict-transport-security' flag must be set to a non-zero value for these options to be used.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_STRICT_TRANSPORT_SECURITY_OPTIONS</code> |
| Default | <code>[]</code> |
### --swagger-enable
Expose the swagger endpoint via /swagger.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SWAGGER_ENABLE</code> |
| Default | <code>false</code> |
### --telemetry
Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TELEMETRY_ENABLE</code> |
| Default | <code>true</code> |
### --telemetry-trace
Whether Opentelemetry traces are sent to Coder. Coder collects anonymized application tracing to help improve our product. Disabling telemetry also disables this option.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TELEMETRY_TRACE</code> |
| Default | <code>true</code> |
### --tls-address
HTTPS bind address of the server.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_ADDRESS</code> |
| Default | <code>127.0.0.1:3443</code> |
### --tls-cert-file
Path to each certificate for TLS. It requires a PEM-encoded file. To configure the listener to use a CA certificate, concatenate the primary certificate and the CA certificate together. The primary certificate should appear first in the combined file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_CERT_FILE</code> |
| Default | <code>[]</code> |
### --tls-client-auth
Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_CLIENT_AUTH</code> |
| Default | <code>none</code> |
### --tls-client-ca-file
PEM-encoded Certificate Authority file used for checking the authenticity of client
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_CLIENT_CA_FILE</code> |
### --tls-client-cert-file
Path to certificate for client TLS authentication. It requires a PEM-encoded file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_CLIENT_CERT_FILE</code> |
### --tls-client-key-file
Path to key for client TLS authentication. It requires a PEM-encoded file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_CLIENT_KEY_FILE</code> |
### --tls-enable
Whether TLS will be enabled.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_ENABLE</code> |
| Default | <code>false</code> |
### --tls-key-file
Paths to the private keys for each of the certificates. It requires a PEM-encoded file.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_KEY_FILE</code> |
| Default | <code>[]</code> |
### --tls-min-version
Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13"
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TLS_MIN_VERSION</code> |
| Default | <code>tls12</code> |
### --trace
Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TRACE_ENABLE</code> |
| Default | <code>false</code> |
### --trace-honeycomb-api-key
Enables trace exporting to Honeycomb.io using the provided API Key.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TRACE_HONEYCOMB_API_KEY</code> |
### --trace-logs
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 to the tracing backend which may incur significant costs. If the verbose flag was supplied, debug-level logs will be included.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TRACE_CAPTURE_LOGS</code> |
| Default | <code>false</code> |
### --update-check
Periodically check for new releases of Coder and inform the owner. The check is performed once per day.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_UPDATE_CHECK</code> |
| Default | <code>false</code> |
### --wildcard-access-url
Specifies the wildcard hostname to use for workspace applications in the form "\*.example.com".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_WILDCARD_ACCESS_URL</code> |

54
docs/cli/coder_server_create-admin-user.md
View File

@ -1,54 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder server create-admin-user
Create a new admin user with the given username, email and password and adds it to every organization.
## Usage
```console
coder server create-admin-user [flags]
```
## Flags
### --email
The email of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_EMAIL</code> |
### --password
The password of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PASSWORD</code> |
### --postgres-url
URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case).
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_POSTGRES_URL</code> |
### --ssh-keygen-algorithm
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
### --username
The username of the new user. If not specified, you will be prompted via stdin.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_USERNAME</code> |

37
docs/cli/coder_speedtest.md
View File

@ -1,37 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder speedtest
Run upload and download tests from your machine to a workspace
## Usage
```console
coder speedtest <workspace> [flags]
```
## Flags
### --direct, -d
Specifies whether to wait for a direct connection before testing speed.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --direction
Specifies whether to run in reverse mode where the client receives and the server sends. (up|down)
<br/>
| | |
| --- | --- |
| Default | <code>down</code> |
### --time, -t
Specifies the duration to monitor traffic.
<br/>
| | |
| --- | --- |
| Default | <code>5s</code> |

66
docs/cli/coder_ssh.md
View File

@ -1,66 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder ssh
Start a shell into a workspace
## Usage
```console
coder ssh <workspace> [flags]
```
## Flags
### --forward-agent, -A
Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_FORWARD_AGENT</code> |
| Default | <code>false</code> |
### --forward-gpg, -G
Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on 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 running in the workspace, it will be attempted to be killed.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_FORWARD_GPG</code> |
| Default | <code>false</code> |
### --identity-agent
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_IDENTITY_AGENT</code> |
### --no-wait
Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_NO_WAIT</code> |
| Default | <code>false</code> |
### --stdio
Specifies whether to emit SSH output over stdin/stdout.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_SSH_STDIO</code> |
| Default | <code>false</code> |
### --workspace-poll-interval
Specifies how often to poll for workspace automated shutdown.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m0s</code> |

21
docs/cli/coder_start.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder start
Start a workspace
## Usage
```console
coder start <workspace> [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

18
docs/cli/coder_state.md
View File

@ -1,18 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder state
Manually manage Terraform state to fix broken workspaces
## Usage
```console
coder state [flags]
```
## Subcommands
| Name | Purpose |
| --------------------------------------- | --------------------------------------------- |
| [<code>pull</code>](./coder_state_pull) | Pull a Terraform state file from a workspace. |
| [<code>push</code>](./coder_state_push) | Push a Terraform state file to a workspace. |

21
docs/cli/coder_state_pull.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder state pull
Pull a Terraform state file from a workspace.
## Usage
```console
coder state pull <workspace> [file] [flags]
```
## Flags
### --build, -b
Specify a workspace build to target by name.
<br/>
| | |
| --- | --- |
| Default | <code>0</code> |

21
docs/cli/coder_state_push.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder state push
Push a Terraform state file to a workspace.
## Usage
```console
coder state push <workspace> <file> [flags]
```
## Flags
### --build, -b
Specify a workspace build to target by name.
<br/>
| | |
| --- | --- |
| Default | <code>0</code> |

21
docs/cli/coder_stop.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder stop
Stop a workspace
## Usage
```console
coder stop <workspace> [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

40
docs/cli/coder_templates.md
View File

@ -1,40 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates
Templates are written in standard Terraform and describe the infrastructure for workspaces
## Usage
```console
coder templates [flags]
```
## Examples
```console
- Create a template for developers to create workspaces:
$ coder templates create
- Make changes to your template, and plan the changes:
$ coder templates plan my-template
- Push an update to the template. Your developers can update their workspaces:
$ coder templates push my-template
```
## Subcommands
| Name | Purpose |
| --------------------------------------------------- | ------------------------------------------------------------------------------ |
| [<code>create</code>](./coder_templates_create) | Create a template from the current directory or as specified by flag |
| [<code>delete</code>](./coder_templates_delete) | Delete templates |
| [<code>edit</code>](./coder_templates_edit) | Edit the metadata of a template by name. |
| [<code>init</code>](./coder_templates_init) | Get started with a templated template. |
| [<code>list</code>](./coder_templates_list) | List all the templates available for the organization |
| [<code>pull</code>](./coder_templates_pull) | Download the latest version of a template to a path. |
| [<code>push</code>](./coder_templates_push) | Push a new template version from the current directory or as specified by flag |
| [<code>versions</code>](./coder_templates_versions) | Manage different versions of the specified template |

67
docs/cli/coder_templates_create.md
View File

@ -1,67 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates create
Create a template from the current directory or as specified by flag
## Usage
```console
coder templates create [name] [flags]
```
## Flags
### --default-ttl
Specify a default TTL for workspaces created from this template.
<br/>
| | |
| --- | --- |
| Default | <code>24h0m0s</code> |
### --directory, -d
Specify the directory to create from, use '-' to read tar from stdin
<br/>
| | |
| --- | --- |
| Default | <code>.</code> |
### --parameter-file
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
### --provisioner-tag
Specify a set of tags to target provisioner daemons.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variable
Specify a set of values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variables-file
Specify a file path with values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

21
docs/cli/coder_templates_delete.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates delete
Delete templates
## Usage
```console
coder templates delete [name...] [flags]
```
## Flags
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

73
docs/cli/coder_templates_edit.md
View File

@ -1,73 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates edit
Edit the metadata of a template by name.
## Usage
```console
coder templates edit <template> [flags]
```
## Flags
### --allow-user-cancel-workspace-jobs
Allow users to cancel in-progress workspace jobs.
<br/>
| | |
| --- | --- |
| Default | <code>true</code> |
### --default-ttl
Edit the template default time before shutdown - workspaces created from this template default to this value.
<br/>
| | |
| --- | --- |
| Default | <code>0s</code> |
### --description
Edit the template description.
<br/>
| | |
| --- | --- |
### --display-name
Edit the template display name.
<br/>
| | |
| --- | --- |
### --icon
Edit the template icon path.
<br/>
| | |
| --- | --- |
### --max-ttl
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.
<br/>
| | |
| --- | --- |
| Default | <code>0s</code> |
### --name
Edit the template name.
<br/>
| | |
| --- | --- |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

29
docs/cli/coder_templates_list.md
View File

@ -1,29 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates list
List all the templates available for the organization
## Usage
```console
coder templates list [flags]
```
## Flags
### --column, -c
Columns to display in table output. Available columns: name, created at, last updated, organization id, provisioner, active version id, used by, default ttl
<br/>
| | |
| --- | --- |
| Default | <code>[name,last updated,used by]</code> |
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |

29
docs/cli/coder_templates_pull.md
View File

@ -1,29 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates pull
Download the latest version of a template to a path.
## Usage
```console
coder templates pull <name> [destination] [flags]
```
## Flags
### --tar
output the template as a tar archive to stdout
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

74
docs/cli/coder_templates_push.md
View File

@ -1,74 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates push
Push a new template version from the current directory or as specified by flag
## Usage
```console
coder templates push [template] [flags]
```
## Flags
### --always-prompt
Always prompt all parameters. Does not pull parameter values from active template version
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --directory, -d
Specify the directory to create from, use '-' to read tar from stdin
<br/>
| | |
| --- | --- |
| Default | <code>.</code> |
### --name
Specify a name for the new template version. It will be automatically generated if not provided.
<br/>
| | |
| --- | --- |
### --parameter-file
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
### --provisioner-tag
Specify a set of tags to target provisioner daemons.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variable
Specify a set of values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variables-file
Specify a file path with values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

25
docs/cli/coder_templates_versions.md
View File

@ -1,25 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates versions
Manage different versions of the specified template
## Usage
```console
coder templates versions [flags]
```
## Examples
```console
- List versions of a specific template:
$ coder templates versions list my-template
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------- | ----------------------------------------------- |
| [<code>list</code>](./coder_templates_versions_list) | List all the versions of the specified template |

29
docs/cli/coder_templates_versions_list.md
View File

@ -1,29 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates versions list
List all the versions of the specified template
## Usage
```console
coder templates versions list <template> [flags]
```
## Flags
### --column, -c
Columns to display in table output. Available columns: name, created at, created by, status, active
<br/>
| | |
| --- | --- |
| Default | <code>[name,created at,created by,status,active]</code> |
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |

35
docs/cli/coder_tokens.md
View File

@ -1,35 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder tokens
Tokens are used to authenticate automated clients to Coder.
## Usage
```console
coder tokens [flags]
```
## Examples
```console
- Create a token for automation:
$ coder tokens create
- List your tokens:
$ coder tokens ls
- Remove a token by ID:
$ coder tokens rm WuoWs4ZsMX
```
## Subcommands
| Name | Purpose |
| -------------------------------------------- | -------------- |
| [<code>create</code>](./coder_tokens_create) | Create a token |
| [<code>list</code>](./coder_tokens_list) | List tokens |
| [<code>remove</code>](./coder_tokens_remove) | Delete a token |

29
docs/cli/coder_tokens_create.md
View File

@ -1,29 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder tokens create
Create a token
## Usage
```console
coder tokens create [flags]
```
## Flags
### --lifetime
Specify a duration for the lifetime of the token.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_TOKEN_LIFETIME</code> |
| Default | <code>720h0m0s</code> |
### --name, -n
Specify a human-readable name.
<br/>
| | |
| --- | --- |

37
docs/cli/coder_tokens_list.md
View File

@ -1,37 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder tokens list
List tokens
## Usage
```console
coder tokens list [flags]
```
## Flags
### --all, -a
Specifies whether all users' tokens will be listed or not (must have Owner role to see all tokens).
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --column, -c
Columns to display in table output. Available columns: id, name, last used, expires at, created at, owner
<br/>
| | |
| --- | --- |
| Default | <code>[id,name,last used,expires at,created at]</code> |
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |

37
docs/cli/coder_update.md
View File

@ -1,37 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder update
Will update and start a given workspace if it is out of date. Use --always-prompt to change the parameter values of the workspace.
## Usage
```console
coder update <workspace> [flags]
```
## Flags
### --always-prompt
Always prompt all parameters. Does not pull parameter values from existing workspace
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --parameter-file
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PARAMETER_FILE</code> |
### --rich-parameter-file
Specify a file path with values for rich parameters defined in the template.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_RICH_PARAMETER_FILE</code> |

21
docs/cli/coder_users.md
View File

@ -1,21 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users
Manage users
## Usage
```console
coder users [flags]
```
## Subcommands
| Name | Purpose |
| ----------------------------------------------- | ------------------------------------------------------------------------------------- |
| [<code>activate</code>](./coder_users_activate) | Update a user's status to 'active'. Active users can fully interact with the platform |
| [<code>create</code>](./coder_users_create) | |
| [<code>list</code>](./coder_users_list) | |
| [<code>show</code>](./coder_users_show) | Show a single user. Use 'me' to indicate the currently authenticated user. |
| [<code>suspend</code>](./coder_users_suspend) | Update a user's status to 'suspended'. A suspended user cannot log into the platform |

27
docs/cli/coder_users_activate.md
View File

@ -1,27 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users activate
Update a user's status to 'active'. Active users can fully interact with the platform
## Usage
```console
coder users activate <username|user_id> [flags]
```
## Examples
```console
$ coder users activate example_user
```
## Flags
### --column, -c
Specify a column to filter in the table.
<br/>
| | |
| --- | --- |
| Default | <code>[username,email,created_at,status]</code> |

32
docs/cli/coder_users_create.md
View File

@ -1,32 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users create
## Usage
```console
coder users create [flags]
```
## Flags
### --email, -e
Specifies an email address for the new user.
<br/>
| | |
| --- | --- |
### --password, -p
Specifies a password for the new user.
<br/>
| | |
| --- | --- |
### --username, -u
Specifies a username for the new user.
<br/>
| | |
| --- | --- |

27
docs/cli/coder_users_list.md
View File

@ -1,27 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users list
## Usage
```console
coder users list [flags]
```
## Flags
### --column, -c
Columns to display in table output. Available columns: id, username, email, created at, status
<br/>
| | |
| --- | --- |
| Default | <code>[username,email,created_at,status]</code> |
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |

27
docs/cli/coder_users_show.md
View File

@ -1,27 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users show
Show a single user. Use 'me' to indicate the currently authenticated user.
## Usage
```console
coder users show <username|user_id|'me'> [flags]
```
## Examples
```console
$ coder users show me
```
## Flags
### --output, -o
Output format. Available formats: table, json
<br/>
| | |
| --- | --- |
| Default | <code>table</code> |

27
docs/cli/coder_users_suspend.md
View File

@ -1,27 +0,0 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder users suspend
Update a user's status to 'suspended'. A suspended user cannot log into the platform
## Usage
```console
coder users suspend <username|user_id> [flags]
```
## Examples
```console
$ coder users suspend example_user
```
## Flags
### --column, -c
Specify a column to filter in the table.
<br/>
| | |
| --- | --- |
| Default | <code>[username,email,created_at,status]</code> |

79
docs/cli/config-ssh.md Normal file
View File

@ -0,0 +1,79 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
## Usage
```console
coder config-ssh [flags]
```
## Description
```console
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
$ coder config-ssh -o ForwardAgent=yes
- You can use --dry-run (or -n) to see the changes that would be made:
$ coder config-ssh --dry-run
```
## Options
### -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
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
Specifies the path to an SSH config.
### --ssh-host-prefix
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Override the default host prefix.
### -o, --ssh-option
| | |
| ----------- | ----------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
Specifies additional SSH options to embed in each host stanza.
### --use-previous-options
| | |
| ----------- | -------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
Specifies whether or not to keep options from previous run of config-ssh.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

66
docs/cli/create.md Normal file
View File

@ -0,0 +1,66 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# create
Create a workspace
## Usage
```console
coder create [flags] [name]
```
## Options
### --parameter-file
| | |
| ----------- | ---------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PARAMETER_FILE</code> |
Specify a file path with parameter values.
### --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.
### --start-at
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.
### --stop-after
| | |
| ----------- | ---------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
Specify a duration after which the workspace should shut down (e.g. 8h).
### -t, --template
| | |
| ----------- | --------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify a template name.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

33
docs/cli/delete.md Normal file
View File

@ -0,0 +1,33 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# delete
Delete a workspace
Aliases:
- rm
## Usage
```console
coder delete [flags] <workspace>
```
## Options
### --orphan
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

38
docs/cli/dotfiles.md Normal file
View File

@ -0,0 +1,38 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles
Personalize your workspace by applying a canonical dotfiles repository
## Usage
```console
coder dotfiles [flags] <git_repo_url>
```
## Description
```console
- Check out and install a dotfiles repository without prompts:
$ coder dotfiles --yes git@github.com:example/dotfiles.git
```
## 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.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

21
docs/cli/features.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features
List Enterprise features
Aliases:
- feature
## Usage
```console
coder features
```
## Subcommands
| Name | Purpose |
| ------------------------------------ | ------- |
| [<code>list</code>](./features_list) | |

33
docs/cli/features_list.md Normal file
View File

@ -0,0 +1,33 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features list
Aliases:
- ls
## Usage
```console
coder features list [flags]
```
## Options
### -c, --column
| | |
| ------- | -------------------------------------------------- |
| Type | <code>string-array</code> |
| Default | <code>Name,Entitlement,Enabled,Limit,Actual</code> |
Specify a column to filter in the table. Available columns are: Name, Entitlement, Enabled, Limit, Actual.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>table</code> |
Output format. Available formats are: table, json.

24
docs/cli/groups.md Normal file
View File

@ -0,0 +1,24 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups
Manage groups
Aliases:
- group
## Usage
```console
coder groups
```
## Subcommands
| Name | Purpose |
| -------------------------------------- | ------------------- |
| [<code>create</code>](./groups_create) | Create a user group |
| [<code>delete</code>](./groups_delete) | Delete a user group |
| [<code>edit</code>](./groups_edit) | Edit a user group |
| [<code>list</code>](./groups_list) | List user groups |

22
docs/cli/groups_create.md Normal file
View File

@ -0,0 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups create
Create a user group
## Usage
```console
coder groups create [flags] <name>
```
## Options
### -u, --avatar-url
| | |
| ----------- | ------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_AVATAR_URL</code> |
Set an avatar for a group.

15
docs/cli/groups_delete.md Normal file
View File

@ -0,0 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups delete
Delete a user group
Aliases:
- rm
## Usage
```console
coder groups delete <name>
```

45
docs/cli/groups_edit.md Normal file
View File

@ -0,0 +1,45 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups edit
Edit a user group
## Usage
```console
coder groups edit [flags] <name>
```
## Options
### -a, --add-users
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Add users to the group. Accepts emails or IDs.
### -u, --avatar-url
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Update the group avatar.
### -n, --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Update the group name.
### -r, --rm-users
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Remove users to the group. Accepts emails or IDs.

31
docs/cli/groups_list.md Normal file
View File

@ -0,0 +1,31 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups list
List user groups
## Usage
```console
coder groups list [flags]
```
## Options
### -c, --column
| | |
| ------- | ---------------------------------------------------- |
| Type | <code>string-array</code> |
| Default | <code>name,organization id,members,avatar url</code> |
Columns to display in table output. Available columns: name, organization id, members, avatar url.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>table</code> |
Output format. Available formats: table, json.

23
docs/cli/licenses.md Normal file
View File

@ -0,0 +1,23 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses
Add, delete, and list licenses
Aliases:
- license
## Usage
```console
coder licenses
```
## Subcommands
| Name | Purpose |
| ---------------------------------------- | --------------------------------- |
| [<code>add</code>](./licenses_add) | Add license to Coder deployment |
| [<code>delete</code>](./licenses_delete) | Delete license by ID |
| [<code>list</code>](./licenses_list) | List licenses (including expired) |

37
docs/cli/licenses_add.md Normal file
View File

@ -0,0 +1,37 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses add
Add license to Coder deployment
## Usage
```console
coder licenses add [flags] [-f file | -l license]
```
## Options
### --debug
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output license claims for debugging.
### -f, --file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Load license from file.
### -l, --license
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
License string.

16
docs/cli/licenses_delete.md Normal file
View File

@ -0,0 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses delete
Delete license by ID
Aliases:
- del
- rm
## Usage
```console
coder licenses delete <id>
```

15
docs/cli/licenses_list.md Normal file
View File

@ -0,0 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses list
List licenses (including expired)
Aliases:
- ls
## Usage
```console
coder licenses list
```

52
docs/cli/list.md Normal file
View File

@ -0,0 +1,52 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# list
List workspaces
Aliases:
- ls
## Usage
```console
coder list [flags]
```
## Options
### -a, --all
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### -c, --column
| | |
| ------- | -------------------------------------------------------------------------------- |
| Type | <code>string-array</code> |
| Default | <code>workspace,template,status,last built,outdated,starts at,stops after</code> |
Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| 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.

49
docs/cli/login.md Normal file
View File

@ -0,0 +1,49 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login
Authenticate with Coder deployment
## Usage
```console
coder login [flags] <url>
```
## Options
### --first-user-email
| | |
| ----------- | ------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_EMAIL</code> |
Specifies an email address to use if creating the first user for the deployment.
### --first-user-password
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_PASSWORD</code> |
Specifies a password to use if creating the first user for the deployment.
### --first-user-trial
| | |
| ----------- | ------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL</code> |
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.

21
docs/cli/logout.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logout
Unauthenticate your local session
## Usage
```console
coder logout [flags]
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

40
docs/cli/ping.md Normal file
View File

@ -0,0 +1,40 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ping
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### -n, --num
| | |
| ------- | ---------------- |
| Type | <code>int</code> |
| Default | <code>10</code> |
Specifies the number of pings to perform.
### -t, --timeout
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies how long to wait for a ping to complete.
### --wait
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies how long to wait between pings.

34
docs/cli/coder_port-forward.md → docs/cli/port-forward.md
View File

@ -1,16 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder port-forward
# port-forward
Forward ports from machine to a workspace
Aliases:
- tunnel
## Usage
```console
coder port-forward <workspace> [flags]
coder port-forward [flags] <workspace>
```
## Examples
## Description
```console
- Port forward a single TCP port from 1234 in the workspace to port 5678 on
@ -32,22 +36,22 @@ coder port-forward <workspace> [flags]
$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012
```
## Flags
## Options
### --tcp, -p
### -p, --tcp
| | |
| ----------- | ------------------------------------ |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_TCP</code> |
Forward TCP port(s) from the workspace to the local machine.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PORT_FORWARD_TCP</code> |
| Default | <code>[]</code> |
### --udp
| | |
| ----------- | ------------------------------------ |
| Type | <code>string-array</code> |
| 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.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PORT_FORWARD_UDP</code> |
| Default | <code>[]</code> |

17
docs/cli/provisionerd.md Normal file
View File

@ -0,0 +1,17 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd
Manage provisioner daemons
## Usage
```console
coder provisionerd
```
## Subcommands
| Name | Purpose |
| ------------------------------------------ | ------------------------ |
| [<code>start</code>](./provisionerd_start) | Run a provisioner daemon |

52
docs/cli/provisionerd_start.md Normal file
View File

@ -0,0 +1,52 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisionerd start
Run a provisioner daemon
## Usage
```console
coder provisionerd start [flags]
```
## Options
### -c, --cache-dir
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
| Default | <code>~/.cache/coder</code> |
Directory to store cached data.
### --poll-interval
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
How often to poll for provisioner jobs.
### --poll-jitter
| | |
| ----------- | -------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
| Default | <code>100ms</code> |
How much to jitter the poll interval by.
### -t, --tag
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Tags to filter provisioner jobs by.

28
docs/cli/coder_publickey.md → docs/cli/publickey.md
View File

@ -1,29 +1,33 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder publickey
# publickey
Output your Coder public key used for Git operations
Aliases:
- pubkey
## Usage
```console
coder publickey [flags]
```
## Flags
## Options
### --reset
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Regenerate your public key. This will require updating the key on any services it's registered with.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
### --yes, -y
### -y, --yes
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

21
docs/cli/rename.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# rename
Rename a workspace
## Usage
```console
coder rename [flags] <workspace> <new name>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

22
docs/cli/reset-password.md Normal file
View File

@ -0,0 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# reset-password
Directly connect to the database to reset a user's password
## Usage
```console
coder reset-password [flags] <username>
```
## Options
### --postgres-url
| | |
| ----------- | ------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
URL of a PostgreSQL database to connect to.

21
docs/cli/restart.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# restart
Restart a workspace
## Usage
```console
coder restart [flags] <workspace>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

18
docs/cli/scaletest.md Normal file
View File

@ -0,0 +1,18 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# scaletest
Run a scale test against the Coder API
## Usage
```console
coder scaletest
```
## Subcommands
| Name | Purpose |
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [<code>cleanup</code>](./scaletest_cleanup) | Cleanup scaletest workspaces, then cleanup scaletest users. |
| [<code>create-workspaces</code>](./scaletest_create-workspaces) | Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard. |

49
docs/cli/scaletest_cleanup.md Normal file
View File

@ -0,0 +1,49 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# scaletest cleanup
Cleanup scaletest workspaces, then cleanup scaletest users.
## Usage
```console
coder scaletest cleanup [flags]
```
## Description
```console
The strategy flags will apply to each stage of the cleanup process.
```
## Options
### --cleanup-concurrency
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_CONCURRENCY</code> |
| Default | <code>1</code> |
Number of concurrent cleanup jobs to run. 0 means unlimited.
### --cleanup-job-timeout
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_JOB_TIMEOUT</code> |
| Default | <code>5m</code> |
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
### --cleanup-timeout
| | |
| ----------- | --------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_TIMEOUT</code> |
| Default | <code>30m</code> |
Timeout for the entire cleanup run. 0 means unlimited.

284
docs/cli/scaletest_create-workspaces.md Normal file
View File

@ -0,0 +1,284 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# scaletest create-workspaces
Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
## Usage
```console
coder scaletest create-workspaces [flags]
```
## Description
```console
It is recommended that all rate limits are disabled on the server before running this scaletest. This test generates many login events which will be rate limited against the (most likely single) IP.
```
## Options
### --cleanup-concurrency
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_CONCURRENCY</code> |
| Default | <code>1</code> |
Number of concurrent cleanup jobs to run. 0 means unlimited.
### --cleanup-job-timeout
| | |
| ----------- | ------------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_JOB_TIMEOUT</code> |
| Default | <code>5m</code> |
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
### --cleanup-timeout
| | |
| ----------- | --------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CLEANUP_TIMEOUT</code> |
| Default | <code>30m</code> |
Timeout for the entire cleanup run. 0 means unlimited.
### --concurrency
| | |
| ----------- | ----------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_SCALETEST_CONCURRENCY</code> |
| Default | <code>1</code> |
Number of concurrent jobs to run. 0 means unlimited.
### --connect-hold
| | |
| ----------- | ------------------------------------------ |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CONNECT_HOLD</code> |
| Default | <code>30s</code> |
How long to hold the WireGuard connection open for.
### --connect-interval
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CONNECT_INTERVAL</code> |
| Default | <code>1s</code> |
How long to wait between making requests to the --connect-url once the connection is established.
### --connect-mode
| | |
| ----------- | ------------------------------------------ | -------------- |
| Type | <code>enum[derp | direct]</code> |
| Environment | <code>$CODER_SCALETEST_CONNECT_MODE</code> |
| Default | <code>derp</code> |
Mode to use for connecting to the workspace.
### --connect-timeout
| | |
| ----------- | --------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_CONNECT_TIMEOUT</code> |
| Default | <code>5s</code> |
Timeout for each request to the --connect-url.
### --connect-url
| | |
| ----------- | ----------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_CONNECT_URL</code> |
URL to connect to inside the the workspace over WireGuard. If not specified, no connections will be made over WireGuard.
### -c, --count
| | |
| ----------- | ----------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_SCALETEST_COUNT</code> |
| Default | <code>1</code> |
Required: Number of workspaces to create.
### --job-timeout
| | |
| ----------- | ----------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_JOB_TIMEOUT</code> |
| Default | <code>5m</code> |
Timeout per job. Jobs may take longer to complete under higher concurrency limits.
### --no-cleanup
| | |
| ----------- | ---------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_NO_CLEANUP</code> |
Do not clean up resources after the test completes. You can cleanup manually using coder scaletest cleanup.
### --no-plan
| | |
| ----------- | ------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_NO_PLAN</code> |
Skip the dry-run step to plan the workspace creation. This step ensures that the given parameters are valid for the given template.
### --no-wait-for-agents
| | |
| ----------- | ------------------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_NO_WAIT_FOR_AGENTS</code> |
Do not wait for agents to start before marking the test as succeeded. This can be useful if you are running the test against a template that does not start the agent quickly.
### --output
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SCALETEST_OUTPUTS</code> |
| Default | <code>text</code> |
Output format specs in the format "<format>[:<path>]". Not specifying a path will default to stdout. Available formats: text, json.
### --parameter
| | |
| ----------- | ---------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SCALETEST_PARAMETERS</code> |
Parameters to use for each workspace. Can be specified multiple times. Overrides any existing parameters with the same name from --parameters-file. Format: key=value.
### --parameters-file
| | |
| ----------- | --------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_PARAMETERS_FILE</code> |
Path to a YAML file containing the parameters to use for each workspace.
### --run-command
| | |
| ----------- | ----------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_RUN_COMMAND</code> |
Command to run inside each workspace using reconnecting-pty (i.e. web terminal protocol). If not specified, no command will be run.
### --run-expect-output
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_RUN_EXPECT_OUTPUT</code> |
Expect the command to output the given string (on a single line). If the command does not output the given string, it will be marked as failed.
### --run-expect-timeout
| | |
| ----------- | ------------------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_RUN_EXPECT_TIMEOUT</code> |
Expect the command to timeout. If the command does not finish within the given --run-timeout, it will be marked as succeeded. If the command finishes before the timeout, it will be marked as failed.
### --run-log-output
| | |
| ----------- | -------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_RUN_LOG_OUTPUT</code> |
Log the output of the command to the test logs. This should be left off unless you expect small amounts of output. Large amounts of output will cause high memory usage.
### --run-timeout
| | |
| ----------- | ----------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_RUN_TIMEOUT</code> |
| Default | <code>5s</code> |
Timeout for the command to complete.
### -t, --template
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_TEMPLATE</code> |
Required: Name or ID of the template to use for workspaces.
### --timeout
| | |
| ----------- | ------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SCALETEST_TIMEOUT</code> |
| Default | <code>30m</code> |
Timeout for the entire test run. 0 means unlimited.
### --trace
| | |
| ----------- | ----------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_TRACE</code> |
Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
### --trace-coder
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_TRACE_CODER</code> |
Whether opentelemetry traces are sent to Coder. We recommend keeping this disabled unless we advise you to enable it.
### --trace-honeycomb-api-key
| | |
| ----------- | ----------------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY</code> |
Enables trace exporting to Honeycomb.io using the provided API key.
### --trace-propagate
| | |
| ----------- | --------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SCALETEST_TRACE_PROPAGATE</code> |
Enables trace propagation to the Coder backend, which will be used to correlate server-side spans with client-side spans. Only enable this if the server is configured with the exact same tracing configuration as the client.

20
docs/cli/schedule.md Normal file
View File

@ -0,0 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule
Schedule automated start and stop times for workspaces
## Usage
```console
coder schedule { show | start | stop | override } <workspace>
```
## Subcommands
| Name | Purpose |
| ------------------------------------------------------ | ----------------------------------------------------------------- |
| [<code>override-stop</code>](./schedule_override-stop) | Override the stop time of a currently running workspace instance. |
| [<code>show</code>](./schedule_show) | Show workspace schedule |
| [<code>start</code>](./schedule_start) | Edit workspace start schedule |
| [<code>stop</code>](./schedule_stop) | Edit workspace stop schedule |

15
docs/cli/coder_schedule_override-stop.md → docs/cli/schedule_override-stop.md
View File

@ -1,21 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder schedule override-stop
# schedule override-stop
Override the stop time of a currently running workspace instance.
- The new stop time is calculated from _now_.
- The new stop time must be at least 30 minutes in the future.
- The workspace template may restrict the maximum workspace runtime.
## Usage
```console
coder schedule override-stop <workspace-name> <duration from now> [flags]
coder schedule override-stop <workspace-name> <duration from now>
```
## Examples
## Description
```console
* The new stop time is calculated from *now*.
* The new stop time must be at least 30 minutes in the future.
* The workspace template may restrict the maximum workspace runtime.
$ coder schedule override-stop my-workspace 90m
```

22
docs/cli/schedule_show.md Normal file
View File

@ -0,0 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule show
Show workspace schedule
## Usage
```console
coder schedule show <workspace-name>
```
## Description
```console
Shows the following information for the given workspace:
* The automatic start schedule
* The next scheduled start time
* The duration after which it will stop
* The next scheduled stop time
```

29
docs/cli/schedule_start.md Normal file
View File

@ -0,0 +1,29 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule start
Edit workspace start schedule
## Usage
```console
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual }
```
## Description
```console
Schedules a workspace to regularly start at a specific time.
Schedule format: <start-time> [day-of-week] [location].
* Start-time (required) is accepted either in 12-hour (hh:mm{am|pm}) format, or 24-hour format hh:mm.
* Day-of-week (optional) allows specifying in the cron format, e.g. 1,3,5 or Mon-Fri.
Aliases such as @daily are not supported.
Default: * (every day)
* Location (optional) must be a valid location in the IANA timezone database.
If omitted, we will fall back to either the TZ environment variable or /etc/localtime.
You can check your corresponding location by visiting https://ipinfo.io - it shows in the demo widget on the right.
- Set the workspace to start at 9:30am (in Dublin) from Monday to Friday:
$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin
```

30
docs/cli/schedule_stop.md Normal file
View File

@ -0,0 +1,30 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule stop
Edit workspace stop schedule
## Usage
```console
coder schedule stop <workspace-name> { <duration> | manual }
```
## Description
```console
Schedules a workspace to stop after a given duration has elapsed.
* Workspace runtime is measured from the time that the workspace build completed.
* The minimum scheduled stop time is 1 minute.
* The workspace template may place restrictions on the maximum shutdown time.
* Changes to workspace schedules only take effect upon the next build of the workspace,
and do not affect a running instance of a workspace.
When enabling scheduled stop, enter a duration in one of the following formats:
* 3h2m (3 hours and two minutes)
* 3h (3 hours)
* 2m (2 minutes)
* 2 (2 minutes)
$ coder schedule stop my-workspace 2h30m
```

772
docs/cli/server.md Normal file
View File

@ -0,0 +1,772 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server
Start a Coder server
## Usage
```console
coder server [flags]
```
## Subcommands
| Name | Purpose |
| ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| [<code>create-admin-user</code>](./server_create-admin-user) | Create a new admin user with the given username, email and password and adds it to every organization. |
| [<code>postgres-builtin-serve</code>](./server_postgres-builtin-serve) | Run the built-in PostgreSQL deployment. |
| [<code>postgres-builtin-url</code>](./server_postgres-builtin-url) | Output the connection URL for the built-in PostgreSQL deployment. |
## Options
### --access-url
| | |
| ----------- | ------------------------------ |
| Type | <code>url</code> |
| Environment | <code>$CODER_ACCESS_URL</code> |
The URL that users will use to access the Coder deployment.
### --audit-logging
| | |
| ----------- | --------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_AUDIT_LOGGING</code> |
| Default | <code>true</code> |
Specifies whether audit logging is enabled.
### --browser-only
| | |
| ----------- | -------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_BROWSER_ONLY</code> |
Whether Coder only allows connections to workspaces via the browser.
### --cache-dir
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
| Default | <code>~/.cache/coder</code> |
The directory to cache temporary files. If unspecified and $CACHE_DIRECTORY is set, it will be used for compatibility with systemd.
### --dangerous-allow-path-app-sharing
| | |
| ----------- | ---------------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SHARING</code> |
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 apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
### --dangerous-allow-path-app-site-owner-access
| | |
| ----------- | -------------------------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS</code> |
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. Path-based apps can make requests to the Coder API and pose a security risk when the workspace serves malicious JavaScript. Path-based apps can be disabled entirely with --disable-path-apps for further security.
### --derp-config-path
| | |
| ----------- | ------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_CONFIG_PATH</code> |
Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.
### --derp-config-url
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_CONFIG_URL</code> |
URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.
### --derp-server-enable
| | |
| ----------- | -------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DERP_SERVER_ENABLE</code> |
| Default | <code>true</code> |
Whether to enable or disable the embedded DERP relay server.
### --derp-server-region-code
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_SERVER_REGION_CODE</code> |
| Default | <code>coder</code> |
Region code to use for the embedded DERP server.
### --derp-server-region-id
| | |
| ----------- | ----------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_DERP_SERVER_REGION_ID</code> |
| Default | <code>999</code> |
Region ID to use for the embedded DERP server.
### --derp-server-region-name
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_DERP_SERVER_REGION_NAME</code> |
| Default | <code>Coder Embedded Relay</code> |
Region name that for the embedded DERP server.
### --derp-server-relay-url
| | |
| ----------- | ----------------------------------------- |
| Type | <code>url</code> |
| Environment | <code>$CODER_DERP_SERVER_RELAY_URL</code> |
An HTTP URL that is accessible by other replicas to relay DERP traffic. Required for high availability.
### --derp-server-stun-addresses
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_DERP_SERVER_STUN_ADDRESSES</code> |
| Default | <code>stun.l.google.com:19302</code> |
Addresses for STUN servers to establish P2P connections. Set empty to disable P2P connections.
### --disable-password-auth
| | |
| ----------- | ----------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_PASSWORD_AUTH</code> |
Disable password authentication. This is recommended for security purposes in production deployments that rely on an identity provider. Any user with the owner role will be able to sign in with their password regardless of this setting to avoid potential lock out. If you are locked out of your account, you can use the `coder server create-admin` command to create a new admin user directly in the database.
### --disable-path-apps
| | |
| ----------- | ------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_PATH_APPS</code> |
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 the workspace serves malicious JavaScript. This is recommended for security purposes if a --wildcard-access-url is configured.
### --disable-session-expiry-refresh
| | |
| ----------- | -------------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_SESSION_EXPIRY_REFRESH</code> |
Disable automatic session expiry bumping due to activity. This forces all sessions to become invalid after the session expiry duration has been reached.
### --experiments
| | |
| ----------- | ------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXPERIMENTS</code> |
Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '\*' to opt-in to all available experiments.
### --http-address
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_HTTP_ADDRESS</code> |
| Default | <code>127.0.0.1:3000</code> |
HTTP bind address of the server. Unset to disable the HTTP endpoint.
### --log-human
| | |
| ----------- | --------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_HUMAN</code> |
| Default | <code>/dev/stderr</code> |
Output human-readable logs to a given file.
### --log-json
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_JSON</code> |
Output JSON logs to a given file.
### --log-stackdriver
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_LOGGING_STACKDRIVER</code> |
Output Stackdriver compatible logs to a given file.
### --max-token-lifetime
| | |
| ----------- | -------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_MAX_TOKEN_LIFETIME</code> |
| Default | <code>2562047h47m16.854775807s</code> |
The maximum lifetime duration users can specify when creating an API token.
### --oauth2-github-allow-everyone
| | |
| ----------- | ------------------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOW_EVERYONE</code> |
Allow all logins, setting this option means allowed orgs and teams must be empty.
### --oauth2-github-allow-signups
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS</code> |
Whether new users can sign up with GitHub.
### --oauth2-github-allowed-orgs
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOWED_ORGS</code> |
Organizations the user must be a member of to Login with GitHub.
### --oauth2-github-allowed-teams
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ALLOWED_TEAMS</code> |
Teams inside organizations the user must be a member of to Login with GitHub. Structured as: <organization-name>/<team-slug>.
### --oauth2-github-client-id
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_CLIENT_ID</code> |
Client ID for Login with GitHub.
### --oauth2-github-client-secret
| | |
| ----------- | ----------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_CLIENT_SECRET</code> |
Client secret for Login with GitHub.
### --oauth2-github-enterprise-base-url
| | |
| ----------- | ----------------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL</code> |
Base URL of a GitHub Enterprise deployment to use for Login with GitHub.
### --oidc-allow-signups
| | |
| ----------- | -------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_ALLOW_SIGNUPS</code> |
| Default | <code>true</code> |
Whether new users can sign up with OIDC.
### --oidc-client-id
| | |
| ----------- | ---------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_ID</code> |
Client ID to use for Login with OIDC.
### --oidc-client-secret
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_CLIENT_SECRET</code> |
Client secret to use for Login with OIDC.
### --oidc-email-domain
| | |
| ----------- | ------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_EMAIL_DOMAIN</code> |
Email domains that clients logging in with OIDC must match.
### --oidc-group-field
| | |
| ----------- | ------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_GROUP_FIELD</code> |
Change the OIDC default 'groups' claim field. By default, will be 'groups' if present in the oidc scopes argument.
### --oidc-group-mapping
| | |
| ----------- | -------------------------------------- |
| Type | <code>struct[map[string]string]</code> |
| Environment | <code>$OIDC_GROUP_MAPPING</code> |
| Default | <code>{}</code> |
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.
### --oidc-icon-url
| | |
| ----------- | --------------------------------- |
| Type | <code>url</code> |
| Environment | <code>$CODER_OIDC_ICON_URL</code> |
URL pointing to the icon to use on the OepnID Connect login button.
### --oidc-ignore-email-verified
| | |
| ----------- | ---------------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_OIDC_IGNORE_EMAIL_VERIFIED</code> |
Ignore the email_verified claim from the upstream provider.
### --oidc-issuer-url
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_ISSUER_URL</code> |
Issuer URL to use for Login with OIDC.
### --oidc-scopes
| | |
| ----------- | --------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_OIDC_SCOPES</code> |
| Default | <code>openid,profile,email</code> |
Scopes to grant when authenticating with OIDC.
### --oidc-sign-in-text
| | |
| ----------- | ------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_SIGN_IN_TEXT</code> |
| Default | <code>OpenID Connect</code> |
The text to show on the OpenID Connect sign in button.
### --oidc-username-field
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_OIDC_USERNAME_FIELD</code> |
| Default | <code>preferred_username</code> |
OIDC claim field to use as the username.
### --postgres-url
| | |
| ----------- | ------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven (https://repo1.maven.org/maven2) and store all data in the config root. Access the built-in database with "coder server postgres-builtin-url".
### --pprof-address
| | |
| ----------- | --------------------------------- |
| Type | <code>host:port</code> |
| Environment | <code>$CODER_PPROF_ADDRESS</code> |
| Default | <code>127.0.0.1:6060</code> |
The bind address to serve pprof.
### --pprof-enable
| | |
| ----------- | -------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PPROF_ENABLE</code> |
Serve pprof metrics on the address defined by pprof address.
### --prometheus-address
| | |
| ----------- | -------------------------------------- |
| Type | <code>host:port</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| Default | <code>127.0.0.1:2112</code> |
The bind address to serve prometheus metrics.
### --prometheus-enable
| | |
| ----------- | ------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
Serve prometheus metrics on the address defined by prometheus address.
### --provisioner-daemon-poll-interval
| | |
| ----------- | ---------------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
Time to wait before polling for a new job.
### --provisioner-daemon-poll-jitter
| | |
| ----------- | -------------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_POLL_JITTER</code> |
| Default | <code>100ms</code> |
Random jitter added to the poll interval.
### --provisioner-daemons
| | |
| ----------- | --------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMONS</code> |
| Default | <code>3</code> |
Number of provisioner daemons to create on start. If builds are stuck in queued state for a long time, consider increasing this.
### --provisioner-force-cancel-interval
| | |
| ----------- | ----------------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_FORCE_CANCEL_INTERVAL</code> |
| Default | <code>10m0s</code> |
Time to force cancel provisioning tasks that are stuck.
### --proxy-trusted-headers
| | |
| ----------- | ----------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROXY_TRUSTED_HEADERS</code> |
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip, True-Client-Ip, X-Forwarded-For.
### --proxy-trusted-origins
| | |
| ----------- | ----------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROXY_TRUSTED_ORIGINS</code> |
Origin addresses to respect "proxy-trusted-headers". e.g. 192.168.1.0/24.
### --redirect-to-access-url
| | |
| ----------- | ------------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_REDIRECT_TO_ACCESS_URL</code> |
Specifies whether to redirect requests that do not match the access URL host.
### --scim-auth-header
| | |
| ----------- | ------------------------------------ |
| Type | <code>string</code> |
| Environment | <code>$CODER_SCIM_AUTH_HEADER</code> |
Enables SCIM and sets the authentication header for the built-in SCIM server. New users are automatically created with OIDC authentication.
### --secure-auth-cookie
| | |
| ----------- | -------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SECURE_AUTH_COOKIE</code> |
Controls if the 'Secure' property is set on browser session cookies.
### --session-duration
| | |
| ----------- | ------------------------------------ |
| Type | <code>duration</code> |
| Environment | <code>$CODER_SESSION_DURATION</code> |
| Default | <code>24h0m0s</code> |
The token expiry duration for browser sessions. Sessions may last longer if they are actively making requests, but this functionality can be disabled via --disable-session-expiry-refresh.
### --ssh-config-options
| | |
| ----------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTIONS</code> |
These SSH config options will override the default SSH config options. Provide options in "key=value" or "key value" format separated by commas.Using this incorrectly can break SSH to your deployment, use cautiously.
### --ssh-hostname-prefix
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_HOSTNAME_PREFIX</code> |
| Default | <code>coder.</code> |
The SSH deployment prefix is used in the Host of the ssh config.
### --ssh-keygen-algorithm
| | |
| ----------- | ---------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
### --strict-transport-security
| | |
| ----------- | --------------------------------------------- |
| Type | <code>int</code> |
| Environment | <code>$CODER_STRICT_TRANSPORT_SECURITY</code> |
| Default | <code>0</code> |
Controls if the 'Strict-Transport-Security' header is set on all 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.
### --strict-transport-security-options
| | |
| ----------- | ----------------------------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_STRICT_TRANSPORT_SECURITY_OPTIONS</code> |
Two optional fields can be set in the Strict-Transport-Security header; 'includeSubDomains' and 'preload'. The 'strict-transport-security' flag must be set to a non-zero value for these options to be used.
### --swagger-enable
| | |
| ----------- | ---------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SWAGGER_ENABLE</code> |
Expose the swagger endpoint via /swagger.
### --telemetry
| | |
| ----------- | ------------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_TELEMETRY_ENABLE</code> |
| Default | <code>true</code> |
Whether telemetry is enabled or not. Coder collects anonymized usage data to help improve our product.
### --telemetry-trace
| | |
| ----------- | ----------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_TELEMETRY_TRACE</code> |
| Default | <code>true</code> |
Whether Opentelemetry traces are sent to Coder. Coder collects anonymized application tracing to help improve our product. Disabling telemetry also disables this option.
### --tls-address
| | |
| ----------- | ------------------------------- |
| Type | <code>host:port</code> |
| Environment | <code>$CODER_TLS_ADDRESS</code> |
| Default | <code>127.0.0.1:3443</code> |
HTTPS bind address of the server.
### --tls-cert-file
| | |
| ----------- | --------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_CERT_FILE</code> |
Path to each certificate for TLS. It requires a PEM-encoded file. To configure the listener to use a CA certificate, concatenate the primary certificate and the CA certificate together. The primary certificate should appear first in the combined file.
### --tls-client-auth
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_AUTH</code> |
| Default | <code>none</code> |
Policy the server will follow for TLS Client Authentication. Accepted values are "none", "request", "require-any", "verify-if-given", or "require-and-verify".
### --tls-client-ca-file
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CA_FILE</code> |
PEM-encoded Certificate Authority file used for checking the authenticity of client.
### --tls-client-cert-file
| | |
| ----------- | ---------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_CERT_FILE</code> |
Path to certificate for client TLS authentication. It requires a PEM-encoded file.
### --tls-client-key-file
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_CLIENT_KEY_FILE</code> |
Path to key for client TLS authentication. It requires a PEM-encoded file.
### --tls-enable
| | |
| ----------- | ------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_TLS_ENABLE</code> |
Whether TLS will be enabled.
### --tls-key-file
| | |
| ----------- | -------------------------------- |
| Type | <code>string-array</code> |
| Environment | <code>$CODER_TLS_KEY_FILE</code> |
Paths to the private keys for each of the certificates. It requires a PEM-encoded file.
### --tls-min-version
| | |
| ----------- | ----------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TLS_MIN_VERSION</code> |
| Default | <code>tls12</code> |
Minimum supported version of TLS. Accepted values are "tls10", "tls11", "tls12" or "tls13".
### --trace
| | |
| ----------- | -------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_ENABLE</code> |
Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
### --trace-honeycomb-api-key
| | |
| ----------- | ------------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_TRACE_HONEYCOMB_API_KEY</code> |
Enables trace exporting to Honeycomb.io using the provided API Key.
### --trace-logs
| | |
| ----------- | ------------------------------ |
| Type | <code>bool</code> |
| Environment | <code>$CODER_TRACE_LOGS</code> |
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 to the tracing backend which may incur significant costs. If the verbose flag was supplied, debug-level logs will be included.
### --update-check
| | |
| ----------- | -------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_UPDATE_CHECK</code> |
| Default | <code>false</code> |
Periodically check for new releases of Coder and inform the owner. The check is performed once per day.
### -v, --verbose
| | |
| ----------- | --------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_VERBOSE</code> |
Output debug-level logs.
### --wildcard-access-url
| | |
| ----------- | --------------------------------------- |
| Type | <code>url</code> |
| Environment | <code>$CODER_WILDCARD_ACCESS_URL</code> |
Specifies the wildcard hostname to use for workspace applications in the form "\*.example.com".

67
docs/cli/server_create-admin-user.md Normal file
View File

@ -0,0 +1,67 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server create-admin-user
Create a new admin user with the given username, email and password and adds it to every organization.
## Usage
```console
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
| | |
| ----------- | -------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_POSTGRES_URL</code> |
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
| | |
| ----------- | ---------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
### --username
| | |
| ----------- | ---------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_USERNAME</code> |
The username of the new user. If not specified, you will be prompted via stdin.

12
docs/cli/coder_server_postgres-builtin-serve.md → docs/cli/server_postgres-builtin-serve.md
View File

@ -1,6 +1,6 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder server postgres-builtin-serve
# server postgres-builtin-serve
Run the built-in PostgreSQL deployment.
@ -10,12 +10,12 @@ Run the built-in PostgreSQL deployment.
coder server postgres-builtin-serve [flags]
```
## Flags
## Options
### --raw-url
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

12
docs/cli/coder_server_postgres-builtin-url.md → docs/cli/server_postgres-builtin-url.md
View File

@ -1,6 +1,6 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder server postgres-builtin-url
# server postgres-builtin-url
Output the connection URL for the built-in PostgreSQL deployment.
@ -10,12 +10,12 @@ Output the connection URL for the built-in PostgreSQL deployment.
coder server postgres-builtin-url [flags]
```
## Flags
## Options
### --raw-url
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |

4
docs/cli/coder_show.md → docs/cli/show.md
View File

@ -1,11 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder show
# show
Display details of a workspace's resources and agents
## Usage
```console
coder show <workspace> [flags]
coder show <workspace>
```

39
docs/cli/speedtest.md Normal file
View File

@ -0,0 +1,39 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# speedtest
Run upload and download tests from your machine to a workspace
## Usage
```console
coder speedtest [flags] <workspace>
```
## Options
### -d, --direct
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Specifies whether to wait for a direct connection before testing speed.
### --direction
| | |
| ------- | ----------------- | ------------ |
| Type | <code>enum[up | down]</code> |
| Default | <code>down</code> |
Specifies whether to run in reverse mode where the client receives and the server sends.
### -t, --time
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies the duration to monitor traffic.

68
docs/cli/ssh.md Normal file
View File

@ -0,0 +1,68 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ssh
Start a shell into a workspace
## Usage
```console
coder ssh [flags] <workspace>
```
## Options
### -A, --forward-agent
| | |
| ----------- | ------------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_AGENT</code> |
Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
### -G, --forward-gpg
| | |
| ----------- | ----------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_GPG</code> |
Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on 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 running in the workspace, it will be attempted to be killed.
### --identity-agent
| | |
| ----------- | -------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_IDENTITY_AGENT</code> |
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
### --no-wait
| | |
| ----------- | ------------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Specifies whether to wait for a workspace to become ready before logging in (only applicable when the login before ready option has not been enabled). Note that the workspace agent may still be in the process of executing the startup script and the workspace may be in an incomplete state.
### --stdio
| | |
| ----------- | ----------------------------- |
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Specifies whether to emit SSH output over stdin/stdout.
### --workspace-poll-interval
| | |
| ----------- | ------------------------------------------- |
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
Specifies how often to poll for workspace automated shutdown.

21
docs/cli/start.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# start
Start a workspace
## Usage
```console
coder start [flags] <workspace>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

18
docs/cli/state.md Normal file
View File

@ -0,0 +1,18 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state
Manually manage Terraform state to fix broken workspaces
## Usage
```console
coder state
```
## Subcommands
| Name | Purpose |
| --------------------------------- | --------------------------------------------- |
| [<code>pull</code>](./state_pull) | Pull a Terraform state file from a workspace. |
| [<code>push</code>](./state_push) | Push a Terraform state file to a workspace. |

21
docs/cli/state_pull.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state pull
Pull a Terraform state file from a workspace.
## Usage
```console
coder state pull [flags] <workspace> [file]
```
## Options
### -b, --build
| | |
| ---- | ---------------- |
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.

21
docs/cli/state_push.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state push
Push a Terraform state file to a workspace.
## Usage
```console
coder state push [flags] <workspace> <file>
```
## Options
### -b, --build
| | |
| ---- | ---------------- |
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.

21
docs/cli/stop.md Normal file
View File

@ -0,0 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stop
Stop a workspace
## Usage
```console
coder stop [flags] <workspace>
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

46
docs/cli/templates.md Normal file
View File

@ -0,0 +1,46 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates
Manage templates
Aliases:
- template
## Usage
```console
coder templates
```
## Description
```console
Templates are written in standard Terraform and describe the infrastructure for workspaces
- Create a template for developers to create workspaces:
$ coder templates create
- Make changes to your template, and plan the changes:
$ coder templates plan my-template
- Push an update to the template. Your developers can update their workspaces:
$ coder templates push my-template
```
## Subcommands
| Name | Purpose |
| --------------------------------------------- | ------------------------------------------------------------------------------ |
| [<code>create</code>](./templates_create) | Create a template from the current directory or as specified by flag |
| [<code>delete</code>](./templates_delete) | Delete templates |
| [<code>edit</code>](./templates_edit) | Edit the metadata of a template by name. |
| [<code>init</code>](./templates_init) | Get started with a templated template. |
| [<code>list</code>](./templates_list) | List all the templates available for the organization |
| [<code>plan</code>](./templates_plan) | Plan a template push from the current directory |
| [<code>pull</code>](./templates_pull) | Download the latest version of a template to a path. |
| [<code>push</code>](./templates_push) | Push a new template version from the current directory or as specified by flag |
| [<code>versions</code>](./templates_versions) | Manage different versions of the specified template |

71
docs/cli/templates_create.md Normal file
View File

@ -0,0 +1,71 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates create
Create a template from the current directory or as specified by flag
## Usage
```console
coder templates create [flags] [name]
```
## Options
### --default-ttl
| | |
| ------- | --------------------- |
| Type | <code>duration</code> |
| Default | <code>24h</code> |
Specify a default TTL for workspaces created from this template.
### -d, --directory
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>.</code> |
Specify the directory to create from, use '-' to read tar from stdin.
### --parameter-file
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Specify a file path with parameter values.
### --provisioner-tag
| | |
| ---- | ------------------------- |
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
### --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.

25
docs/cli/templates_delete.md Normal file
View File

@ -0,0 +1,25 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates delete
Delete templates
Aliases:
- rm
## Usage
```console
coder templates delete [flags] [name...]
```
## Options
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

78
docs/cli/templates_edit.md Normal file
View File

@ -0,0 +1,78 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates edit
Edit the metadata of a template by name.
## Usage
```console
coder templates edit [flags] <template>
```
## Options
### --allow-user-cancel-workspace-jobs
| | |
| ------- | ----------------- |
| Type | <code>bool</code> |
| Default | <code>true</code> |
Allow users to cancel in-progress workspace jobs.
### --default-ttl
| | |
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value.
### --description
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template description.
### --display-name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template display name.
### --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. This is an enterprise-only feature.
### --name
| | |
| ---- | ------------------- |
| Type | <code>string</code> |
Edit the template name.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

4
docs/cli/coder_templates_init.md → docs/cli/templates_init.md
View File

@ -1,11 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates init
# templates init
Get started with a templated template.
## Usage
```console
coder templates init [directory] [flags]
coder templates init [directory]
```

35
docs/cli/templates_list.md Normal file
View File

@ -0,0 +1,35 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates list
List all the templates available for the organization
Aliases:
- ls
## Usage
```console
coder templates list [flags]
```
## Options
### -c, --column
| | |
| ------- | -------------------------------------- |
| Type | <code>string-array</code> |
| Default | <code>name,last updated,used by</code> |
Columns to display in table output. Available columns: name, created at, last updated, organization id, provisioner, active version id, used by, default ttl.
### -o, --output
| | |
| ------- | ------------------- |
| Type | <code>string</code> |
| Default | <code>table</code> |
Output format. Available formats: table, json.

11
docs/cli/templates_plan.md Normal file
View File

@ -0,0 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates plan
Plan a template push from the current directory
## Usage
```console
coder templates plan <directory>
```

29
docs/cli/templates_pull.md Normal file
View File

@ -0,0 +1,29 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates pull
Download the latest version of a template to a path.
## Usage
```console
coder templates pull [flags] <name> [destination]
```
## Options
### --tar
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Output the template as a tar archive to stdout.
### -y, --yes
| | |
| ---- | ----------------- |
| Type | <code>bool</code> |
Bypass prompts.

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