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

chore: adopt markdownlint and markdown-table-formatter for *.md (#15831)

Browse Source 
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
This commit is contained in:
Muhammad Atif Ali
2025-01-03 13:12:59 +00:00
committed by GitHub
co-authored by Edward Angert
parent 08463c27d8
commit 94f5d52fdc
255 changed files with 18279 additions and 16786 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/cli/autoupdate.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# autoupdate
Toggle auto-update policy for a workspace
@@ -15,7 +14,7 @@ coder autoupdate [flags] <workspace> <always|never>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/completion.md
Generated
+2 -3
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# completion
Install or update shell completion scripts for the detected or chosen shell.
@@ -15,7 +14,7 @@ coder completion [flags]
### -s, --shell
| | |
| ---- | ---------------------------------------- |
|------|------------------------------------------|
| Type | <code>bash\|fish\|zsh\|powershell</code> |
The shell to install completion for.
@@ -23,7 +22,7 @@ The shell to install completion for.
### -p, --print
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Print the completion script instead of installing it.
docs/reference/cli/config-ssh.md
Generated
+9 -10
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
Add an SSH Host entry for your workspaces "ssh coder.workspace"
@@ -28,7 +27,7 @@ workspaces:
### --ssh-config-file
| | |
| ----------- | ----------------------------------- |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
@@ -38,7 +37,7 @@ Specifies the path to an SSH config.
### --coder-binary-path
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
@@ -47,7 +46,7 @@ Optionally specify the absolute path to the coder binary used in ProxyCommand. B
### -o, --ssh-option
| | |
| ----------- | ----------------------------------- |
|-------------|-------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
@@ -56,7 +55,7 @@ Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
@@ -65,7 +64,7 @@ Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options
| | |
| ----------- | -------------------------------------------- |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
@@ -74,7 +73,7 @@ Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix
| | |
| ----------- | --------------------------------------------- |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
@@ -83,7 +82,7 @@ Override the default host prefix.
### --wait
| | |
| ----------- | ---------------------------------- |
|-------------|------------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
| Default | <code>auto</code> |
@@ -93,7 +92,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --disable-autostart
| | |
| ----------- | ----------------------------------------------- |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
@@ -103,7 +102,7 @@ Disable starting the workspace automatically when connecting via SSH.
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/create.md
Generated
+11 -12
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# create
Create a workspace
@@ -23,7 +22,7 @@ coder create [flags] [workspace]
### -t, --template
| | |
| ----------- | --------------------------------- |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
@@ -32,7 +31,7 @@ Specify a template name.
### --template-version
| | |
| ----------- | ------------------------------------ |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
@@ -41,7 +40,7 @@ Specify a template version name.
### --start-at
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
@@ -50,7 +49,7 @@ Specify the workspace autostart schedule. Check coder schedule start --help for
### --stop-after
| | |
| ----------- | ---------------------------------------- |
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
@@ -59,7 +58,7 @@ Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
| | |
| ----------- | ----------------------------------------------- |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
@@ -69,7 +68,7 @@ Specify automatic updates setting for the workspace (accepts 'always' or 'never'
### --copy-parameters-from
| | |
| ----------- | -------------------------------------------------- |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
@@ -78,7 +77,7 @@ Specify the source workspace name to copy parameters from.
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -86,7 +85,7 @@ Bypass prompts.
### --parameter
| | |
| ----------- | ---------------------------------- |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -95,7 +94,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -104,7 +103,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -113,7 +112,7 @@ Rich parameter default values in the format "name=value".
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/delete.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# delete
Delete a workspace
Aliases:
- rm
* rm
## Usage
@@ -27,7 +26,7 @@ coder delete [flags] <workspace>
### --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.
@@ -35,7 +34,7 @@ Delete a workspace without deleting its resources. This can delete a workspace i
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/dotfiles.md
Generated
+4 -5
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles
Personalize your workspace by applying a canonical dotfiles repository
@@ -23,7 +22,7 @@ coder dotfiles [flags] <git_repo_url>
### --symlink-dir
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
@@ -32,7 +31,7 @@ Specifies the directory for the dotfiles symlink destinations. If empty, will us
### -b, --branch
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specifies which branch to clone. If empty, will default to cloning the default branch or using the existing branch in the cloned repo on disk.
@@ -40,7 +39,7 @@ Specifies which branch to clone. If empty, will default to cloning the default b
### --repo-dir
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DOTFILES_REPO_DIR</code> |
| Default | <code>dotfiles</code> |
@@ -50,7 +49,7 @@ Specifies the directory for the dotfiles repository, relative to global config d
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/external-auth.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth
Manage external authentication
@@ -19,5 +18,5 @@ Authenticate with external services inside of a workspace.
## Subcommands
| Name | Purpose |
| ------------------------------------------------------------ | ----------------------------------- |
|--------------------------------------------------------------|-------------------------------------|
| [<code>access-token</code>](./external-auth_access-token.md) | Print auth for an external provider |
docs/reference/cli/external-auth_access-token.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth access-token
Print auth for an external provider
@@ -37,7 +36,7 @@ fi
### --extra
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Extract a field from the "extra" properties of the OAuth token.
docs/reference/cli/favorite.md
Generated
+2 -3
View File
@@ -1,13 +1,12 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# favorite
Add a workspace to your favorites
Aliases:
- fav
- favourite
* fav
* favourite
## Usage
docs/reference/cli/features.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features
List Enterprise features
Aliases:
- feature
* feature
## Usage
@@ -17,5 +16,5 @@ coder features
## Subcommands
| Name | Purpose |
| --------------------------------------- | ------- |
|-----------------------------------------|---------|
| [<code>list</code>](./features_list.md) | |
docs/reference/cli/features_list.md
Generated
+3 -4
View File
@@ -1,10 +1,9 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features list
Aliases:
- ls
* ls
## Usage
@@ -17,7 +16,7 @@ coder features list [flags]
### -c, --column
| | |
| ------- | -------------------------------------------------------- |
|---------|----------------------------------------------------------|
| Type | <code>[name\|entitlement\|enabled\|limit\|actual]</code> |
| Default | <code>name,entitlement,enabled,limit,actual</code> |
@@ -26,7 +25,7 @@ Specify columns to filter in the table.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/groups.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups
Manage groups
Aliases:
- group
* group
## Usage
@@ -17,7 +16,7 @@ coder groups
## Subcommands
| Name | Purpose |
| ----------------------------------------- | ------------------- |
|-------------------------------------------|---------------------|
| [<code>create</code>](./groups_create.md) | Create a user group |
| [<code>list</code>](./groups_list.md) | List user groups |
| [<code>edit</code>](./groups_edit.md) | Edit a user group |
docs/reference/cli/groups_create.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups create
Create a user group
@@ -15,7 +14,7 @@ coder groups create [flags] <name>
### -u, --avatar-url
| | |
| ----------- | ------------------------------ |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AVATAR_URL</code> |
@@ -24,7 +23,7 @@ Set an avatar for a group.
### --display-name
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
@@ -33,7 +32,7 @@ Optional human friendly name for the group.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups_delete.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups delete
Delete a user group
Aliases:
- rm
* rm
## Usage
@@ -19,7 +18,7 @@ coder groups delete [flags] <name>
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups_edit.md
Generated
+6 -7
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups edit
Edit a user group
@@ -15,7 +14,7 @@ coder groups edit [flags] <name>
### -n, --name
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Update the group name.
@@ -23,7 +22,7 @@ Update the group name.
### -u, --avatar-url
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Update the group avatar.
@@ -31,7 +30,7 @@ Update the group avatar.
### --display-name
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
@@ -40,7 +39,7 @@ Optional human friendly name for the group.
### -a, --add-users
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Add users to the group. Accepts emails or IDs.
@@ -48,7 +47,7 @@ Add users to the group. Accepts emails or IDs.
### -r, --rm-users
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Remove users to the group. Accepts emails or IDs.
@@ -56,7 +55,7 @@ Remove users to the group. Accepts emails or IDs.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/groups_list.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups list
List user groups
@@ -15,7 +14,7 @@ coder groups list [flags]
### -c, --column
| | |
| ------- | ----------------------------------------------------------------------- |
|---------|-------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|members\|avatar url]</code> |
| Default | <code>name,display name,organization id,members,avatar url</code> |
@@ -24,7 +23,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
@@ -33,7 +32,7 @@ Output format.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/index.md
Generated
+12 -13
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder
## Usage
@@ -24,7 +23,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
## Subcommands
| Name | Purpose |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|----------------------------------------------------|-------------------------------------------------------------------------------------------------------|
| [<code>completion</code>](./completion.md) | Install or update shell completion scripts for the detected or chosen shell. |
| [<code>dotfiles</code>](./dotfiles.md) | Personalize your workspace by applying a canonical dotfiles repository |
| [<code>external-auth</code>](./external-auth.md) | Manage external authentication |
@@ -73,7 +72,7 @@ Coder — A tool for provisioning self-hosted development environments with Terr
### --url
| | |
| ----------- | ----------------------- |
|-------------|-------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_URL</code> |
@@ -82,7 +81,7 @@ URL to a deployment.
### --debug-options
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Print all options, how they're set, then exit.
@@ -90,7 +89,7 @@ Print all options, how they're set, then exit.
### --token
| | |
| ----------- | --------------------------------- |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SESSION_TOKEN</code> |
@@ -99,7 +98,7 @@ Specify an authentication token. For security reasons setting CODER_SESSION_TOKE
### --no-version-warning
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_NO_VERSION_WARNING</code> |
@@ -108,7 +107,7 @@ Suppress warning when client and server versions do not match.
### --no-feature-warning
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_NO_FEATURE_WARNING</code> |
@@ -117,7 +116,7 @@ Suppress warnings about unlicensed features.
### --header
| | |
| ----------- | -------------------------- |
|-------------|----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_HEADER</code> |
@@ -126,7 +125,7 @@ Additional HTTP headers added to all requests. Provide as key=value. Can be spec
### --header-command
| | |
| ----------- | ---------------------------------- |
|-------------|------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_HEADER_COMMAND</code> |
@@ -135,7 +134,7 @@ An external command that outputs additional HTTP headers added to all requests.
### -v, --verbose
| | |
| ----------- | --------------------------- |
|-------------|-----------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_VERBOSE</code> |
@@ -144,7 +143,7 @@ Enable verbose output.
### --disable-direct-connections
| | |
| ----------- | ---------------------------------------------- |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_DIRECT_CONNECTIONS</code> |
@@ -153,7 +152,7 @@ Disable direct (P2P) connections to workspaces.
### --disable-network-telemetry
| | |
| ----------- | --------------------------------------------- |
|-------------|-----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_DISABLE_NETWORK_TELEMETRY</code> |
@@ -162,7 +161,7 @@ Disable network telemetry. Network telemetry is collected when connecting to wor
### --global-config
| | |
| ----------- | ------------------------------ |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIG_DIR</code> |
| Default | <code>~/.config/coderv2</code> |
docs/reference/cli/licenses.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses
Add, delete, and list licenses
Aliases:
- license
* license
## Usage
@@ -17,7 +16,7 @@ coder licenses
## Subcommands
| Name | Purpose |
| ------------------------------------------- | --------------------------------- |
|---------------------------------------------|-----------------------------------|
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
| [<code>list</code>](./licenses_list.md) | List licenses (including expired) |
| [<code>delete</code>](./licenses_delete.md) | Delete license by ID |
docs/reference/cli/licenses_add.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses add
Add license to Coder deployment
@@ -15,7 +14,7 @@ coder licenses add [flags] [-f file | -l license]
### -f, --file
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Load license from file.
@@ -23,7 +22,7 @@ Load license from file.
### -l, --license
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
License string.
@@ -31,7 +30,7 @@ License string.
### --debug
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output license claims for debugging.
docs/reference/cli/licenses_delete.md
Generated
+2 -3
View File
@@ -1,13 +1,12 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses delete
Delete license by ID
Aliases:
- del
- rm
* del
* rm
## Usage
docs/reference/cli/licenses_list.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses list
List licenses (including expired)
Aliases:
- ls
* ls
## Usage
@@ -19,7 +18,7 @@ coder licenses list [flags]
### -c, --column
| | |
| ------- | ----------------------------------------------------------------- |
|---------|-------------------------------------------------------------------|
| Type | <code>[id\|uuid\|uploaded at\|features\|expires at\|trial]</code> |
| Default | <code>ID,UUID,Expires At,Uploaded At,Features</code> |
@@ -28,7 +27,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/list.md
Generated
+5 -6
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# list
List workspaces
Aliases:
- ls
* ls
## Usage
@@ -19,7 +18,7 @@ coder list [flags]
### -a, --all
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
@@ -27,7 +26,7 @@ Specifies whether all workspaces will be listed or not.
### --search
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
@@ -36,7 +35,7 @@ Search for a workspace with a query.
### -c, --column
| | |
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated,starts at,stops after</code> |
@@ -45,7 +44,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/login.md
Generated
+6 -7
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login
Authenticate with Coder deployment
@@ -15,7 +14,7 @@ coder login [flags] [<url>]
### --first-user-email
| | |
| ----------- | ------------------------------------ |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_EMAIL</code> |
@@ -24,7 +23,7 @@ Specifies an email address to use if creating the first user for the deployment.
### --first-user-username
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
@@ -33,7 +32,7 @@ Specifies a username to use if creating the first user for the deployment.
### --first-user-full-name
| | |
| ----------- | ---------------------------------------- |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_FULL_NAME</code> |
@@ -42,7 +41,7 @@ Specifies a human-readable name for the first user of the deployment.
### --first-user-password
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_PASSWORD</code> |
@@ -51,7 +50,7 @@ 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> |
@@ -60,7 +59,7 @@ Specifies whether a trial license should be provisioned for the Coder deployment
### --use-token-as-session
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
By default, the CLI will generate a new session token when logging in. This flag will instead use the provided token as the session token.
docs/reference/cli/logout.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logout
Unauthenticate your local session
@@ -15,7 +14,7 @@ coder logout [flags]
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/netcheck.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# netcheck
Print network debug information for DERP and STUN
docs/reference/cli/notifications.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications
Manage Coder notifications
Aliases:
- notification
* notification
## Usage
@@ -32,6 +31,6 @@ server or Webhook not responding).:
## Subcommands
| Name | Purpose |
| ------------------------------------------------ | -------------------- |
|--------------------------------------------------|----------------------|
| [<code>pause</code>](./notifications_pause.md) | Pause notifications |
| [<code>resume</code>](./notifications_resume.md) | Resume notifications |
docs/reference/cli/notifications_pause.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications pause
Pause notifications
docs/reference/cli/notifications_resume.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications resume
Resume notifications
docs/reference/cli/open.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open
Open a workspace
@@ -13,5 +12,5 @@ coder open
## Subcommands
| Name | Purpose |
| --------------------------------------- | ----------------------------------- |
|-----------------------------------------|-------------------------------------|
| [<code>vscode</code>](./open_vscode.md) | Open a workspace in VS Code Desktop |
docs/reference/cli/open_vscode.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open vscode
Open a workspace in VS Code Desktop
@@ -15,7 +14,7 @@ coder open vscode [flags] <workspace> [<directory in workspace>]
### --generate-token
| | |
| ----------- | ---------------------------------------------- |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OPEN_VSCODE_GENERATE_TOKEN</code> |
docs/reference/cli/organizations.md
Generated
+5 -6
View File
@@ -1,14 +1,13 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations
Organization related commands
Aliases:
- organization
- org
- orgs
* organization
* org
* orgs
## Usage
@@ -19,7 +18,7 @@ coder organizations [flags] [subcommand]
## Subcommands
| Name | Purpose |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [<code>show</code>](./organizations_show.md) | Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of. |
| [<code>create</code>](./organizations_create.md) | Create a new organization. |
| [<code>members</code>](./organizations_members.md) | Manage organization members |
@@ -31,7 +30,7 @@ coder organizations [flags] [subcommand]
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/organizations_create.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations create
Create a new organization.
@@ -15,7 +14,7 @@ coder organizations create [flags] <organization name>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/organizations_members.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members
Manage organization members
Aliases:
- member
* member
## Usage
@@ -17,7 +16,7 @@ coder organizations members
## Subcommands
| Name | Purpose |
| ---------------------------------------------------------------- | ----------------------------------------------- |
|------------------------------------------------------------------|-------------------------------------------------|
| [<code>list</code>](./organizations_members_list.md) | List all organization members |
| [<code>edit-roles</code>](./organizations_members_edit-roles.md) | Edit organization member's roles |
| [<code>add</code>](./organizations_members_add.md) | Add a new member to the current organization |
docs/reference/cli/organizations_members_add.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members add
Add a new member to the current organization
docs/reference/cli/organizations_members_edit-roles.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members edit-roles
Edit organization member's roles
Aliases:
- edit-role
* edit-role
## Usage
docs/reference/cli/organizations_members_list.md
Generated
+2 -3
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members list
List all organization members
@@ -15,7 +14,7 @@ coder organizations members list [flags]
### -c, --column
| | |
| ------- | --------------------------------------------------------------------------------------------------- |
|---------|-----------------------------------------------------------------------------------------------------|
| Type | <code>[username\|name\|user id\|organization id\|created at\|updated at\|organization roles]</code> |
| Default | <code>username,organization roles</code> |
@@ -24,7 +23,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/organizations_members_remove.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members remove
Remove a new member to the current organization
Aliases:
- rm
* rm
## Usage
docs/reference/cli/organizations_roles.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles
Manage organization roles.
Aliases:
- role
* role
## Usage
@@ -17,6 +16,6 @@ coder organizations roles
## Subcommands
| Name | Purpose |
| -------------------------------------------------- | -------------------------------- |
|----------------------------------------------------|----------------------------------|
| [<code>show</code>](./organizations_roles_show.md) | Show role(s) |
| [<code>edit</code>](./organizations_roles_edit.md) | Edit an organization custom role |
docs/reference/cli/organizations_roles_edit.md
Generated
+5 -6
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles edit
Edit an organization custom role
@@ -23,7 +22,7 @@ coder organizations roles edit [flags] <role_name>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -31,7 +30,7 @@ Bypass prompts.
### --dry-run
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Does all the work, but does not submit the final updated role.
@@ -39,7 +38,7 @@ Does all the work, but does not submit the final updated role.
### --stdin
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Reads stdin for the json role definition to upload.
@@ -47,7 +46,7 @@ Reads stdin for the json role definition to upload.
### -c, --column
| | |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
|---------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
@@ -56,7 +55,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/organizations_roles_show.md
Generated
+2 -3
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles show
Show role(s)
@@ -15,7 +14,7 @@ coder organizations roles show [flags] [role_names ...]
### -c, --column
| | |
| ------- | ---------------------------------------------------------------------------------------------------------------- |
|---------|------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|site permissions\|organization permissions\|user permissions]</code> |
| Default | <code>name,display name,site permissions,organization permissions,user permissions</code> |
@@ -24,7 +23,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/organizations_settings.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings
Manage organization settings.
Aliases:
- setting
* setting
## Usage
@@ -17,6 +16,6 @@ coder organizations settings
## Subcommands
| Name | Purpose |
| ----------------------------------------------------- | --------------------------------------- |
|-------------------------------------------------------|-----------------------------------------|
| [<code>show</code>](./organizations_settings_show.md) | Outputs specified organization setting. |
| [<code>set</code>](./organizations_settings_set.md) | Update specified organization setting. |
docs/reference/cli/organizations_settings_set.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set
Update specified organization setting.
@@ -21,7 +20,7 @@ coder organizations settings set
## Subcommands
| Name | Purpose |
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
|-------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| [<code>group-sync</code>](./organizations_settings_set_group-sync.md) | Group sync settings to sync groups from an IdP. |
| [<code>role-sync</code>](./organizations_settings_set_role-sync.md) | Role sync settings to sync organization roles from an IdP. |
| [<code>organization-sync</code>](./organizations_settings_set_organization-sync.md) | Organization sync settings to sync organization memberships from an IdP. |
docs/reference/cli/organizations_settings_set_group-sync.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set group-sync
Group sync settings to sync groups from an IdP.
Aliases:
- groupsync
* groupsync
## Usage
docs/reference/cli/organizations_settings_set_organization-sync.md
Generated
+3 -4
View File
@@ -1,14 +1,13 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set organization-sync
Organization sync settings to sync organization memberships from an IdP.
Aliases:
- organizationsync
- org-sync
- orgsync
* organizationsync
* org-sync
* orgsync
## Usage
docs/reference/cli/organizations_settings_set_role-sync.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set role-sync
Role sync settings to sync organization roles from an IdP.
Aliases:
- rolesync
* rolesync
## Usage
docs/reference/cli/organizations_settings_show.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show
Outputs specified organization setting.
@@ -21,7 +20,7 @@ coder organizations settings show
## Subcommands
| Name | Purpose |
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
| [<code>group-sync</code>](./organizations_settings_show_group-sync.md) | Group sync settings to sync groups from an IdP. |
| [<code>role-sync</code>](./organizations_settings_show_role-sync.md) | Role sync settings to sync organization roles from an IdP. |
| [<code>organization-sync</code>](./organizations_settings_show_organization-sync.md) | Organization sync settings to sync organization memberships from an IdP. |
docs/reference/cli/organizations_settings_show_group-sync.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show group-sync
Group sync settings to sync groups from an IdP.
Aliases:
- groupsync
* groupsync
## Usage
docs/reference/cli/organizations_settings_show_organization-sync.md
Generated
+3 -4
View File
@@ -1,14 +1,13 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show organization-sync
Organization sync settings to sync organization memberships from an IdP.
Aliases:
- organizationsync
- org-sync
- orgsync
* organizationsync
* org-sync
* orgsync
## Usage
docs/reference/cli/organizations_settings_show_role-sync.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show role-sync
Role sync settings to sync organization roles from an IdP.
Aliases:
- rolesync
* rolesync
## Usage
docs/reference/cli/organizations_show.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations show
Show the organization. Using "selected" will show the selected organization from the "--org" flag. Using "me" will show all organizations you are a member of.
@@ -35,7 +34,7 @@ coder organizations show [flags] ["selected"|"me"|uuid|org_name]
### --only-id
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Only print the organization ID.
@@ -43,7 +42,7 @@ Only print the organization ID.
### -c, --column
| | |
| ------- | ----------------------------------------------------------------------------------------- |
|---------|-------------------------------------------------------------------------------------------|
| Type | <code>[id\|name\|display name\|icon\|description\|created at\|updated at\|default]</code> |
| Default | <code>id,name,default</code> |
@@ -52,7 +51,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------------ |
|---------|--------------------------------|
| Type | <code>text\|table\|json</code> |
| Default | <code>text</code> |
docs/reference/cli/ping.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ping
Ping a workspace
@@ -15,7 +14,7 @@ coder ping [flags] <workspace>
### --wait
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
@@ -24,7 +23,7 @@ Specifies how long to wait between pings.
### -t, --timeout
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
@@ -33,7 +32,7 @@ Specifies how long to wait for a ping to complete.
### -n, --num
| | |
| ---- | ---------------- |
|------|------------------|
| Type | <code>int</code> |
Specifies the number of pings to perform. By default, pings will continue until interrupted.
docs/reference/cli/port-forward.md
Generated
+4 -5
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# port-forward
Forward ports from a workspace to the local machine. For reverse port forwarding, use "coder ssh -R".
Aliases:
- tunnel
* tunnel
## Usage
@@ -45,7 +44,7 @@ machine:
### -p, --tcp
| | |
| ----------- | ------------------------------------ |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_TCP</code> |
@@ -54,7 +53,7 @@ Forward TCP port(s) from the workspace to the local machine.
### --udp
| | |
| ----------- | ------------------------------------ |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_UDP</code> |
@@ -63,7 +62,7 @@ Forward UDP port(s) from the workspace to the local machine. The UDP connection
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
docs/reference/cli/provisioner.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner
Manage provisioner daemons
Aliases:
- provisioners
* provisioners
## Usage
@@ -17,6 +16,6 @@ coder provisioner
## Subcommands
| Name | Purpose |
| -------------------------------------------- | ------------------------ |
|----------------------------------------------|--------------------------|
| [<code>start</code>](./provisioner_start.md) | Run a provisioner daemon |
| [<code>keys</code>](./provisioner_keys.md) | Manage provisioner keys |
docs/reference/cli/provisioner_keys.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys
Manage provisioner keys
Aliases:
- key
* key
## Usage
@@ -17,7 +16,7 @@ coder provisioner keys
## Subcommands
| Name | Purpose |
| --------------------------------------------------- | ---------------------------------------- |
|-----------------------------------------------------|------------------------------------------|
| [<code>create</code>](./provisioner_keys_create.md) | Create a new provisioner key |
| [<code>list</code>](./provisioner_keys_list.md) | List provisioner keys in an organization |
| [<code>delete</code>](./provisioner_keys_delete.md) | Delete a provisioner key |
docs/reference/cli/provisioner_keys_create.md
Generated
+2 -3
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys create
Create a new provisioner key
@@ -15,7 +14,7 @@ coder provisioner keys create [flags] <name>
### -t, --tag
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
@@ -24,7 +23,7 @@ Tags to filter provisioner jobs by.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner_keys_delete.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys delete
Delete a provisioner key
Aliases:
- rm
* rm
## Usage
@@ -19,7 +18,7 @@ coder provisioner keys delete [flags] <name>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -27,7 +26,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner_keys_list.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys list
List provisioner keys in an organization
Aliases:
- ls
* ls
## Usage
@@ -19,7 +18,7 @@ coder provisioner keys list [flags]
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/provisioner_start.md
Generated
+16 -17
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner start
Run a provisioner daemon
@@ -15,7 +14,7 @@ coder provisioner start [flags]
### -c, --cache-dir
| | |
| ----------- | ----------------------------------- |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
| Default | <code>~/.cache/coder</code> |
@@ -25,7 +24,7 @@ Directory to store cached data.
### -t, --tag
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
@@ -34,7 +33,7 @@ Tags to filter provisioner jobs by.
### --poll-interval
| | |
| ----------- | ---------------------------------------------- |
|-------------|------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
@@ -44,7 +43,7 @@ Deprecated and ignored.
### --poll-jitter
| | |
| ----------- | -------------------------------------------- |
|-------------|----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
| Default | <code>100ms</code> |
@@ -54,7 +53,7 @@ Deprecated and ignored.
### --psk
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
@@ -63,7 +62,7 @@ Pre-shared key to authenticate with Coder server.
### --key
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_KEY</code> |
@@ -72,7 +71,7 @@ Provisioner key to authenticate with Coder server.
### --name
| | |
| ----------- | ------------------------------------------- |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
@@ -81,7 +80,7 @@ Name of this provisioner daemon. Defaults to the current hostname without FQDN.
### --verbose
| | |
| ----------- | ---------------------------------------------- |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
| Default | <code>false</code> |
@@ -91,7 +90,7 @@ Output debug-level logs.
### --log-human
| | |
| ----------- | ---------------------------------------------------- |
|-------------|------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_HUMAN</code> |
| Default | <code>/dev/stderr</code> |
@@ -101,7 +100,7 @@ Output human-readable logs to a given file.
### --log-json
| | |
| ----------- | --------------------------------------------------- |
|-------------|-----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_JSON</code> |
@@ -110,7 +109,7 @@ Output JSON logs to a given file.
### --log-stackdriver
| | |
| ----------- | ---------------------------------------------------------- |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_STACKDRIVER</code> |
@@ -119,16 +118,16 @@ Output Stackdriver compatible logs to a given file.
### --log-filter
| | |
| ----------- | ------------------------------------------------- |
|-------------|---------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOG_FILTER</code> |
Filter debug logs by matching against a given regex. Use .\* to match all debug logs.
Filter debug logs by matching against a given regex. Use .* to match all debug logs.
### --prometheus-enable
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
| Default | <code>false</code> |
@@ -138,7 +137,7 @@ Serve prometheus metrics on the address defined by prometheus address.
### --prometheus-address
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROMETHEUS_ADDRESS</code> |
| Default | <code>127.0.0.1:2112</code> |
@@ -148,7 +147,7 @@ The bind address to serve prometheus metrics.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/publickey.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# publickey
Output your Coder public key used for Git operations
Aliases:
- pubkey
* pubkey
## Usage
@@ -19,7 +18,7 @@ coder publickey [flags]
### --reset
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Regenerate your public key. This will require updating the key on any services it's registered with.
@@ -27,7 +26,7 @@ Regenerate your public key. This will require updating the key on any services i
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/rename.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# rename
Rename a workspace
@@ -15,7 +14,7 @@ coder rename [flags] <workspace> <new name>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/reset-password.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# reset-password
Directly connect to the database to reset a user's password
@@ -15,7 +14,7 @@ coder reset-password [flags] <username>
### --postgres-url
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
docs/reference/cli/restart.md
Generated
+9 -10
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# restart
Restart a workspace
@@ -15,7 +14,7 @@ coder restart [flags] <workspace>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -23,7 +22,7 @@ Bypass prompts.
### --build-option
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -32,7 +31,7 @@ Build option value in the format "name=value".
### --build-options
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
@@ -40,7 +39,7 @@ Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -49,7 +48,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| ----------- | ----------------------------------------------- |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -58,7 +57,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| ----------- | ---------------------------------- |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -67,7 +66,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -76,7 +75,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -85,7 +84,7 @@ Rich parameter default values in the format "name=value".
### --always-prompt
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/reference/cli/schedule.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule
Schedule automated start and stop times for workspaces
@@ -13,7 +12,7 @@ coder schedule { show | start | stop | extend } <workspace>
## Subcommands
| Name | Purpose |
| ------------------------------------------- | --------------------------------------------------------------- |
|---------------------------------------------|-----------------------------------------------------------------|
| [<code>show</code>](./schedule_show.md) | Show workspace schedules |
| [<code>start</code>](./schedule_start.md) | Edit workspace start schedule |
| [<code>stop</code>](./schedule_stop.md) | Edit workspace stop schedule |
docs/reference/cli/schedule_extend.md
Generated
+1 -2
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule extend
Extend the stop time of a currently running workspace instance.
Aliases:
- override-stop
* override-stop
## Usage
docs/reference/cli/schedule_show.md
Generated
+4 -5
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule show
Show workspace schedules
@@ -26,7 +25,7 @@ Shows the following information for the given workspace(s):
### -a, --all
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
@@ -34,7 +33,7 @@ Specifies whether all workspaces will be listed or not.
### --search
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
@@ -43,7 +42,7 @@ Search for a workspace with a query.
### -c, --column
| | |
| ------- | ------------------------------------------------------------------------- |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
@@ -52,7 +51,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/schedule_start.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule start
Edit workspace start schedule
docs/reference/cli/schedule_stop.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule stop
Edit workspace stop schedule
docs/reference/cli/server.md
Generated
+156 -157
View File
File diff suppressed because it is too large Load Diff
docs/reference/cli/server_create-admin-user.md
Generated
+7 -8
View File
@@ -1,5 +1,4 @@
<!-- 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.
@@ -15,7 +14,7 @@ coder server create-admin-user [flags]
### --postgres-url
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -24,7 +23,7 @@ URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will
### --postgres-connection-auth
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
@@ -34,7 +33,7 @@ Type of auth to use when connecting to postgres.
### --ssh-keygen-algorithm
| | |
| ----------- | ---------------------------------------- |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_KEYGEN_ALGORITHM</code> |
| Default | <code>ed25519</code> |
@@ -44,7 +43,7 @@ The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ec
### --username
| | |
| ----------- | ---------------------------- |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_USERNAME</code> |
@@ -53,7 +52,7 @@ The username of the new user. If not specified, you will be prompted via stdin.
### --email
| | |
| ----------- | ------------------------- |
|-------------|---------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL</code> |
@@ -62,7 +61,7 @@ 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> |
@@ -71,7 +70,7 @@ The password of the new user. If not specified, you will be prompted via stdin.
### --raw-url
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/server_dbcrypt.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt
Manage database encryption.
@@ -13,7 +12,7 @@ coder server dbcrypt
## Subcommands
| Name | Purpose |
| --------------------------------------------------- | ----------------------------------------------------------------------------- |
|-----------------------------------------------------|-------------------------------------------------------------------------------|
| [<code>decrypt</code>](./server_dbcrypt_decrypt.md) | Decrypt a previously encrypted database. |
| [<code>delete</code>](./server_dbcrypt_delete.md) | Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION. |
| [<code>rotate</code>](./server_dbcrypt_rotate.md) | Rotate database encryption keys. |
docs/reference/cli/server_dbcrypt_decrypt.md
Generated
+4 -5
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt decrypt
Decrypt a previously encrypted database.
@@ -15,7 +14,7 @@ coder server dbcrypt decrypt [flags]
### --postgres-url
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -24,7 +23,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
@@ -34,7 +33,7 @@ Type of auth to use when connecting to postgres.
### --keys
| | |
| ----------- | ---------------------------------------------------------- |
|-------------|------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
@@ -43,7 +42,7 @@ Keys required to decrypt existing data. Must be a comma-separated list of base64
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/server_dbcrypt_delete.md
Generated
+4 -5
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt delete
Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.
Aliases:
- rm
* rm
## Usage
@@ -19,7 +18,7 @@ coder server dbcrypt delete [flags]
### --postgres-url
| | |
| ----------- | ---------------------------------------------------------- |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL</code> |
@@ -28,7 +27,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
@@ -38,7 +37,7 @@ Type of auth to use when connecting to postgres.
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/server_dbcrypt_rotate.md
Generated
+5 -6
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt rotate
Rotate database encryption keys.
@@ -15,7 +14,7 @@ coder server dbcrypt rotate [flags]
### --postgres-url
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
@@ -24,7 +23,7 @@ The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
@@ -34,7 +33,7 @@ Type of auth to use when connecting to postgres.
### --new-key
| | |
| ----------- | ------------------------------------------------------------- |
|-------------|---------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_NEW_KEY</code> |
@@ -43,7 +42,7 @@ The new external token encryption key. Must be base64-encoded.
### --old-keys
| | |
| ----------- | -------------------------------------------------------------- |
|-------------|----------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_ENCRYPT_OLD_KEYS</code> |
@@ -52,7 +51,7 @@ The old external token encryption keys. Must be a comma-separated list of base64
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/server_postgres-builtin-serve.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server postgres-builtin-serve
Run the built-in PostgreSQL deployment.
@@ -15,7 +14,7 @@ coder server postgres-builtin-serve [flags]
### --raw-url
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/server_postgres-builtin-url.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server postgres-builtin-url
Output the connection URL for the built-in PostgreSQL deployment.
@@ -15,7 +14,7 @@ coder server postgres-builtin-url [flags]
### --raw-url
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
docs/reference/cli/show.md
Generated
-1
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# show
Display details of a workspace's resources and agents
docs/reference/cli/speedtest.md
Generated
+6 -7
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# speedtest
Run upload and download tests from your machine to a workspace
@@ -15,7 +14,7 @@ coder speedtest [flags] <workspace>
### -d, --direct
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether to wait for a direct connection before testing speed.
@@ -23,7 +22,7 @@ Specifies whether to wait for a direct connection before testing speed.
### --direction
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>up\|down</code> |
| Default | <code>down</code> |
@@ -32,7 +31,7 @@ Specifies whether to run in reverse mode where the client receives and the serve
### -t, --time
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
@@ -41,7 +40,7 @@ Specifies the duration to monitor traffic.
### --pcap-file
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specifies a file to write a network capture to.
@@ -49,7 +48,7 @@ Specifies a file to write a network capture to.
### -c, --column
| | |
| ------- | ----------------------------------- |
|---------|-------------------------------------|
| Type | <code>[Interval\|Throughput]</code> |
| Default | <code>Interval,Throughput</code> |
@@ -58,7 +57,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/ssh.md
Generated
+11 -12
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ssh
Start a shell into a workspace
@@ -15,7 +14,7 @@ coder ssh [flags] <workspace>
### --stdio
| | |
| ----------- | ----------------------------- |
|-------------|-------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
@@ -24,7 +23,7 @@ Specifies whether to emit SSH output over stdin/stdout.
### -A, --forward-agent
| | |
| ----------- | ------------------------------------- |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_AGENT</code> |
@@ -33,7 +32,7 @@ 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> |
@@ -42,7 +41,7 @@ Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, b
### --identity-agent
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_IDENTITY_AGENT</code> |
@@ -51,7 +50,7 @@ Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent
### --workspace-poll-interval
| | |
| ----------- | ------------------------------------------- |
|-------------|---------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
@@ -61,7 +60,7 @@ Specifies how often to poll for workspace automated shutdown.
### --wait
| | |
| ----------- | ---------------------------- |
|-------------|------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
| Default | <code>auto</code> |
@@ -71,7 +70,7 @@ Specifies whether or not to wait for the startup script to finish executing. Aut
### --no-wait
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
@@ -80,7 +79,7 @@ Enter workspace immediately after the agent has connected. This is the default i
### -l, --log-dir
| | |
| ----------- | ------------------------------- |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
@@ -89,7 +88,7 @@ Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
| ----------- | -------------------------------------- |
|-------------|----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
@@ -98,7 +97,7 @@ Enable remote port forwarding (remote_port:local_address:local_port).
### -e, --env
| | |
| ----------- | --------------------------- |
|-------------|-----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_ENV</code> |
@@ -107,7 +106,7 @@ Set environment variable(s) for session (key1=value1,key2=value2,...).
### --disable-autostart
| | |
| ----------- | ----------------------------------------- |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
docs/reference/cli/start.md
Generated
+9 -10
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# start
Start a workspace
@@ -15,7 +14,7 @@ coder start [flags] <workspace>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -23,7 +22,7 @@ Bypass prompts.
### --build-option
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
@@ -32,7 +31,7 @@ Build option value in the format "name=value".
### --build-options
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
@@ -40,7 +39,7 @@ Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
@@ -49,7 +48,7 @@ Set the value of ephemeral parameters defined in the template. The format is "na
### --prompt-ephemeral-parameters
| | |
| ----------- | ----------------------------------------------- |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
@@ -58,7 +57,7 @@ Prompt to set values of ephemeral parameters defined in the template. If a value
### --parameter
| | |
| ----------- | ---------------------------------- |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
@@ -67,7 +66,7 @@ Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
| ----------- | --------------------------------------- |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
@@ -76,7 +75,7 @@ Specify a file path with values for rich parameters defined in the template. The
### --parameter-default
| | |
| ----------- | ------------------------------------------ |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
@@ -85,7 +84,7 @@ Rich parameter default values in the format "name=value".
### --always-prompt
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/reference/cli/stat.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stat
Show resource usage for the current workspace.
@@ -13,7 +12,7 @@ coder stat [flags]
## Subcommands
| Name | Purpose |
| ----------------------------------- | -------------------------------- |
|-------------------------------------|----------------------------------|
| [<code>cpu</code>](./stat_cpu.md) | Show CPU usage, in cores. |
| [<code>mem</code>](./stat_mem.md) | Show memory usage, in gigabytes. |
| [<code>disk</code>](./stat_disk.md) | Show disk usage, in gigabytes. |
@@ -23,7 +22,7 @@ coder stat [flags]
### -c, --column
| | |
| ------- | -------------------------------------------------------------------------------- |
|---------|----------------------------------------------------------------------------------|
| Type | <code>[host cpu\|host memory\|home disk\|container cpu\|container memory]</code> |
| Default | <code>host cpu,host memory,home disk,container cpu,container memory</code> |
@@ -32,7 +31,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/stat_cpu.md
Generated
+2 -3
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stat cpu
Show CPU usage, in cores.
@@ -15,7 +14,7 @@ coder stat cpu [flags]
### --host
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Force host CPU measurement.
@@ -23,7 +22,7 @@ Force host CPU measurement.
### -o, --output
| | |
| ------- | ----------------------- |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
docs/reference/cli/stat_disk.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stat disk
Show disk usage, in gigabytes.
@@ -15,7 +14,7 @@ coder stat disk [flags]
### --path
| | |
| ------- | ------------------- |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>/</code> |
@@ -24,7 +23,7 @@ Path for which to check disk usage.
### --prefix
| | |
| ------- | --------------------------- |
|---------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
@@ -33,7 +32,7 @@ SI Prefix for disk measurement.
### -o, --output
| | |
| ------- | ----------------------- |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
docs/reference/cli/stat_mem.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stat mem
Show memory usage, in gigabytes.
@@ -15,7 +14,7 @@ coder stat mem [flags]
### --host
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Force host memory measurement.
@@ -23,7 +22,7 @@ Force host memory measurement.
### --prefix
| | |
| ------- | --------------------------- |
|---------|-----------------------------|
| Type | <code>Ki\|Mi\|Gi\|Ti</code> |
| Default | <code>Gi</code> |
@@ -32,7 +31,7 @@ SI Prefix for memory measurement.
### -o, --output
| | |
| ------- | ----------------------- |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
docs/reference/cli/state.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state
Manually manage Terraform state to fix broken workspaces
@@ -13,6 +12,6 @@ coder state
## Subcommands
| Name | Purpose |
| ------------------------------------ | --------------------------------------------- |
|--------------------------------------|-----------------------------------------------|
| [<code>pull</code>](./state_pull.md) | Pull a Terraform state file from a workspace. |
| [<code>push</code>](./state_push.md) | Push a Terraform state file to a workspace. |
docs/reference/cli/state_pull.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state pull
Pull a Terraform state file from a workspace.
@@ -15,7 +14,7 @@ coder state pull [flags] <workspace> [file]
### -b, --build
| | |
| ---- | ---------------- |
|------|------------------|
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.
docs/reference/cli/state_push.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# state push
Push a Terraform state file to a workspace.
@@ -15,7 +14,7 @@ coder state push [flags] <workspace> <file>
### -b, --build
| | |
| ---- | ---------------- |
|------|------------------|
| Type | <code>int</code> |
Specify a workspace build to target by name. Defaults to latest.
docs/reference/cli/stop.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# stop
Stop a workspace
@@ -15,7 +14,7 @@ coder stop [flags] <workspace>
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
docs/reference/cli/support.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# support
Commands for troubleshooting issues with a Coder deployment.
@@ -13,5 +12,5 @@ coder support
## Subcommands
| Name | Purpose |
| ------------------------------------------ | --------------------------------------------------------------------------- |
|--------------------------------------------|-----------------------------------------------------------------------------|
| [<code>bundle</code>](./support_bundle.md) | Generate a support bundle to troubleshoot issues connecting to a workspace. |
docs/reference/cli/support_bundle.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# support bundle
Generate a support bundle to troubleshoot issues connecting to a workspace.
@@ -21,7 +20,7 @@ This command generates a file containing detailed troubleshooting information ab
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -29,7 +28,7 @@ Bypass prompts.
### -O, --output-file
| | |
| ----------- | ---------------------------------------------- |
|-------------|------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_OUTPUT_FILE</code> |
@@ -38,7 +37,7 @@ File path for writing the generated support bundle. Defaults to coder-support-$(
### --url-override
| | |
| ----------- | ----------------------------------------------- |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SUPPORT_BUNDLE_URL_OVERRIDE</code> |
docs/reference/cli/templates.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates
Manage templates
Aliases:
- template
* template
## Usage
@@ -27,7 +26,7 @@ workspaces:
## Subcommands
| Name | Purpose |
| ------------------------------------------------ | -------------------------------------------------------------------------------- |
|--------------------------------------------------|----------------------------------------------------------------------------------|
| [<code>create</code>](./templates_create.md) | DEPRECATED: Create a template from the current directory or as specified by flag |
| [<code>edit</code>](./templates_edit.md) | Edit the metadata of a template by name. |
| [<code>init</code>](./templates_init.md) | Get started with a templated template. |
docs/reference/cli/templates_archive.md
Generated
+4 -5
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates archive
Archive unused or failed template versions from a given template(s)
@@ -7,7 +6,7 @@ Archive unused or failed template versions from a given template(s)
## Usage
```console
coder templates archive [flags] [template-name...]
coder templates archive [flags] [template-name...]
```
## Options
@@ -15,7 +14,7 @@ coder templates archive [flags] [template-name...]
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -23,7 +22,7 @@ Bypass prompts.
### --all
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Include all unused template versions. By default, only failed template versions are archived.
@@ -31,7 +30,7 @@ Include all unused template versions. By default, only failed template versions
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates_create.md
Generated
+15 -16
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates create
DEPRECATED: Create a template from the current directory or as specified by flag
@@ -15,7 +14,7 @@ coder templates create [flags] [name]
### --private
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Disable the default behavior of granting template access to the 'everyone' group. The template permissions must be updated to allow non-admin users to use this template.
@@ -23,7 +22,7 @@ Disable the default behavior of granting template access to the 'everyone' group
### --variables-file
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
@@ -31,7 +30,7 @@ Specify a file path with values for Terraform-managed variables.
### --variable
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
@@ -39,7 +38,7 @@ Specify a set of values for Terraform-managed variables.
### --var
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Alias of --variable.
@@ -47,7 +46,7 @@ Alias of --variable.
### --provisioner-tag
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
@@ -55,7 +54,7 @@ Specify a set of tags to target provisioner daemons.
### --default-ttl
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>24h</code> |
@@ -64,7 +63,7 @@ Specify a default TTL for workspaces created from this template. It is the defau
### --failure-ttl
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -73,7 +72,7 @@ Specify a failure TTL for workspaces created from this template. It is the amoun
### --dormancy-threshold
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -82,7 +81,7 @@ Specify a duration workspaces may be inactive prior to being moved to the dorman
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -91,7 +90,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted
### --require-active-version
| | |
| ------- | ------------------ |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
@@ -100,7 +99,7 @@ Requires workspace builds to use the active template version. This setting does
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -108,7 +107,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
@@ -117,7 +116,7 @@ Select which organization (uuid or name) to use.
### -d, --directory
| | |
| ------- | ------------------- |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
@@ -126,7 +125,7 @@ Specify the directory to create from, use '-' to read tar from stdin.
### --ignore-lockfile
| | |
| ------- | ------------------ |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
@@ -135,7 +134,7 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
### -m, --message
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
docs/reference/cli/templates_delete.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates delete
Delete templates
Aliases:
- rm
* rm
## Usage
@@ -19,7 +18,7 @@ coder templates delete [flags] [name...]
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -27,7 +26,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates_edit.md
Generated
+20 -21
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates edit
Edit the metadata of a template by name.
@@ -15,7 +14,7 @@ coder templates edit [flags] <template>
### --name
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Edit the template name.
@@ -23,7 +22,7 @@ Edit the template name.
### --display-name
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Edit the template display name.
@@ -31,7 +30,7 @@ Edit the template display name.
### --description
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Edit the template description.
@@ -39,7 +38,7 @@ Edit the template description.
### --deprecated
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Sets the template as deprecated. Must be a message explaining why the template is deprecated.
@@ -47,7 +46,7 @@ Sets the template as deprecated. Must be a message explaining why the template i
### --icon
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Edit the template icon path.
@@ -55,7 +54,7 @@ Edit the template icon path.
### --default-ttl
| | |
| ---- | --------------------- |
|------|-----------------------|
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
@@ -63,7 +62,7 @@ Edit the template default time before shutdown - workspaces created from this te
### --activity-bump
| | |
| ---- | --------------------- |
|------|-----------------------|
| Type | <code>duration</code> |
Edit the template activity bump - workspaces created from this template will have their shutdown time bumped by this value when activity is detected. Maps to "Activity bump" in the UI.
@@ -71,7 +70,7 @@ Edit the template activity bump - workspaces created from this template will hav
### --autostart-requirement-weekdays
| | |
| ---- | ---------------------------------------------------------------------------------- |
|------|------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|all]</code> |
Edit the template autostart requirement weekdays - workspaces created from this template can only autostart on the given weekdays. To unset this value for the template (and allow autostart on all days), pass 'all'.
@@ -79,7 +78,7 @@ Edit the template autostart requirement weekdays - workspaces created from this
### --autostop-requirement-weekdays
| | |
| ---- | ----------------------------------------------------------------------------------- |
|------|-------------------------------------------------------------------------------------|
| Type | <code>[monday\|tuesday\|wednesday\|thursday\|friday\|saturday\|sunday\|none]</code> |
Edit the template autostop requirement weekdays - workspaces created from this template must be restarted on the given weekdays. To unset this value for the template (and disable the autostop requirement for the template), pass 'none'.
@@ -87,7 +86,7 @@ Edit the template autostop requirement weekdays - workspaces created from this t
### --autostop-requirement-weeks
| | |
| ---- | ---------------- |
|------|------------------|
| Type | <code>int</code> |
Edit the template autostop requirement weeks - workspaces created from this template must be restarted on an n-weekly basis.
@@ -95,7 +94,7 @@ Edit the template autostop requirement weeks - workspaces created from this temp
### --failure-ttl
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -104,7 +103,7 @@ Specify a failure TTL for workspaces created from this template. It is the amoun
### --dormancy-threshold
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -113,7 +112,7 @@ Specify a duration workspaces may be inactive prior to being moved to the dorman
### --dormancy-auto-deletion
| | |
| ------- | --------------------- |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>0h</code> |
@@ -122,7 +121,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted
### --allow-user-cancel-workspace-jobs
| | |
| ------- | ----------------- |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
@@ -131,7 +130,7 @@ Allow users to cancel in-progress workspace jobs.
### --allow-user-autostart
| | |
| ------- | ----------------- |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
@@ -140,7 +139,7 @@ Allow users to configure autostart for workspaces on this template. This can onl
### --allow-user-autostop
| | |
| ------- | ----------------- |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
@@ -149,7 +148,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This
### --require-active-version
| | |
| ------- | ------------------ |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
@@ -158,7 +157,7 @@ Requires workspace builds to use the active template version. This setting does
### --private
| | |
| ------- | ------------------ |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
@@ -167,7 +166,7 @@ Disable the default behavior of granting template access to the 'everyone' group
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -175,7 +174,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates_init.md
Generated
+1 -2
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates init
Get started with a templated template.
@@ -15,7 +14,7 @@ coder templates init [flags] [directory]
### --id
| | |
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>aws-devcontainer\|aws-linux\|aws-windows\|azure-linux\|digitalocean-linux\|docker\|docker-devcontainer\|gcp-devcontainer\|gcp-linux\|gcp-vm-container\|gcp-windows\|kubernetes\|kubernetes-devcontainer\|nomad-docker\|scratch</code> |
Specify a given example template by ID.
docs/reference/cli/templates_list.md
Generated
+3 -4
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates list
List all the templates available for the organization
Aliases:
- ls
* ls
## Usage
@@ -19,7 +18,7 @@ coder templates list [flags]
### -c, --column
| | |
| ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[name\|created at\|last updated\|organization id\|organization name\|provisioner\|active version id\|used by\|default ttl]</code> |
| Default | <code>name,organization name,last updated,used by</code> |
@@ -28,7 +27,7 @@ Columns to display in table output.
### -o, --output
| | |
| ------- | ------------------------ |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
docs/reference/cli/templates_pull.md
Generated
+5 -6
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates pull
Download the active, latest, or specified version of a template to a path.
@@ -15,7 +14,7 @@ coder templates pull [flags] <name> [destination]
### --tar
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output the template as a tar archive to stdout.
@@ -23,7 +22,7 @@ Output the template as a tar archive to stdout.
### --zip
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Output the template as a zip archive to stdout.
@@ -31,7 +30,7 @@ Output the template as a zip archive to stdout.
### --version
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
The name of the template version to pull. Use 'active' to pull the active version, 'latest' to pull the latest version, or the name of the template version to pull.
@@ -39,7 +38,7 @@ The name of the template version to pull. Use 'active' to pull the active versio
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -47,7 +46,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates_push.md
Generated
+12 -13
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates push
Create or update a template from the current directory or as specified by flag
@@ -15,7 +14,7 @@ coder templates push [flags] [template]
### --variables-file
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specify a file path with values for Terraform-managed variables.
@@ -23,7 +22,7 @@ Specify a file path with values for Terraform-managed variables.
### --variable
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of values for Terraform-managed variables.
@@ -31,7 +30,7 @@ Specify a set of values for Terraform-managed variables.
### --var
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Alias of --variable.
@@ -39,7 +38,7 @@ Alias of --variable.
### --provisioner-tag
| | |
| ---- | ------------------------- |
|------|---------------------------|
| Type | <code>string-array</code> |
Specify a set of tags to target provisioner daemons.
@@ -47,7 +46,7 @@ Specify a set of tags to target provisioner daemons.
### --name
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specify a name for the new template version. It will be automatically generated if not provided.
@@ -55,7 +54,7 @@ Specify a name for the new template version. It will be automatically generated
### --always-prompt
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Always prompt all parameters. Does not pull parameter values from active template version.
@@ -63,7 +62,7 @@ Always prompt all parameters. Does not pull parameter values from active templat
### --activate
| | |
| ------- | ----------------- |
|---------|-------------------|
| Type | <code>bool</code> |
| Default | <code>true</code> |
@@ -72,7 +71,7 @@ Whether the new template will be marked active.
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -80,7 +79,7 @@ Bypass prompts.
### -d, --directory
| | |
| ------- | ------------------- |
|---------|---------------------|
| Type | <code>string</code> |
| Default | <code>.</code> |
@@ -89,7 +88,7 @@ Specify the directory to create from, use '-' to read tar from stdin.
### --ignore-lockfile
| | |
| ------- | ------------------ |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
@@ -98,7 +97,7 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
### -m, --message
| | |
| ---- | ------------------- |
|------|---------------------|
| Type | <code>string</code> |
Specify a message describing the changes in this version of the template. Messages longer than 72 characters will be displayed as truncated.
@@ -106,7 +105,7 @@ Specify a message describing the changes in this version of the template. Messag
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
docs/reference/cli/templates_versions.md
Generated
+2 -3
View File
@@ -1,12 +1,11 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates versions
Manage different versions of the specified template
Aliases:
- version
* version
## Usage
@@ -25,7 +24,7 @@ coder templates versions
## Subcommands
| Name | Purpose |
| ----------------------------------------------------------- | ----------------------------------------------- |
|-------------------------------------------------------------|-------------------------------------------------|
| [<code>list</code>](./templates_versions_list.md) | List all the versions of the specified template |
| [<code>archive</code>](./templates_versions_archive.md) | Archive a template version(s). |
| [<code>unarchive</code>](./templates_versions_unarchive.md) | Unarchive a template version(s). |
docs/reference/cli/templates_versions_archive.md
Generated
+3 -4
View File
@@ -1,5 +1,4 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# templates versions archive
Archive a template version(s).
@@ -7,7 +6,7 @@ Archive a template version(s).
## Usage
```console
coder templates versions archive [flags] <template-name> [template-version-names...]
coder templates versions archive [flags] <template-name> [template-version-names...]
```
## Options
@@ -15,7 +14,7 @@ coder templates versions archive [flags] <template-name> [template-version-names
### -y, --yes
| | |
| ---- | ----------------- |
|------|-------------------|
| Type | <code>bool</code> |
Bypass prompts.
@@ -23,7 +22,7 @@ Bypass prompts.
### -O, --org
| | |
| ----------- | -------------------------------- |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |

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