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

Fix markdown formatting

Browse Source
This commit is contained in:
Kyle Carberry
2026-02-24 11:29:09 -05:00
parent 90eb503b99
commit 172ad03c36
151 changed files with 1112 additions and 1400 deletions
Download Patch File Download Diff File Expand all files Collapse all files
agent/agentsocket/proto/agentsocket_drpc.pb.go
+1 -1
View File
@@ -1,5 +1,5 @@
// Code generated by protoc-gen-go-drpc. DO NOT EDIT.
// protoc-gen-go-drpc version: v0.0.34
// protoc-gen-go-drpc version: (devel)
// source: agent/agentsocket/proto/agentsocket.proto
package proto
agent/proto/agent_drpc.pb.go
+1 -1
View File
@@ -1,5 +1,5 @@
// Code generated by protoc-gen-go-drpc. DO NOT EDIT.
// protoc-gen-go-drpc version: v0.0.34
// protoc-gen-go-drpc version: (devel)
// source: agent/proto/agent.proto
package proto
coderd/rbac/scopes_constants_gen.go
+12
View File
@@ -28,6 +28,10 @@ const (
ScopeBoundaryUsageDelete ScopeName = "boundary_usage:delete"
ScopeBoundaryUsageRead ScopeName = "boundary_usage:read"
ScopeBoundaryUsageUpdate ScopeName = "boundary_usage:update"
ScopeChatCreate ScopeName = "chat:create"
ScopeChatDelete ScopeName = "chat:delete"
ScopeChatRead ScopeName = "chat:read"
ScopeChatUpdate ScopeName = "chat:update"
ScopeConnectionLogRead ScopeName = "connection_log:read"
ScopeConnectionLogUpdate ScopeName = "connection_log:update"
ScopeCryptoKeyCreate ScopeName = "crypto_key:create"
@@ -188,6 +192,10 @@ func (e ScopeName) Valid() bool {
ScopeBoundaryUsageDelete,
ScopeBoundaryUsageRead,
ScopeBoundaryUsageUpdate,
ScopeChatCreate,
ScopeChatDelete,
ScopeChatRead,
ScopeChatUpdate,
ScopeConnectionLogRead,
ScopeConnectionLogUpdate,
ScopeCryptoKeyCreate,
@@ -349,6 +357,10 @@ func AllScopeNameValues() []ScopeName {
ScopeBoundaryUsageDelete,
ScopeBoundaryUsageRead,
ScopeBoundaryUsageUpdate,
ScopeChatCreate,
ScopeChatDelete,
ScopeChatRead,
ScopeChatUpdate,
ScopeConnectionLogRead,
ScopeConnectionLogUpdate,
ScopeCryptoKeyCreate,
docs/reference/cli/aibridge.md
Generated
+2 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# aibridge
Manage AI Bridge.
## Usage
```console
coder aibridge
```
## Subcommands
| Name | Purpose |
|-----------------------------------------------------------|---------------------------------|
| [<code>interceptions</code>](./aibridge_interceptions.md) | Manage AI Bridge interceptions. |
docs/reference/cli/aibridge_interceptions.md
Generated
+2 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# aibridge interceptions
Manage AI Bridge interceptions.
## Usage
```console
coder aibridge interceptions
```
## Subcommands
| Name | Purpose |
|-------------------------------------------------------|---------------------------------------|
| [<code>list</code>](./aibridge_interceptions_list.md) | List AI Bridge interceptions as JSON. |
docs/reference/cli/autoupdate.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# autoupdate
Toggle auto-update policy for a workspace
## Usage
```console
coder autoupdate [flags] <workspace> <always|never>
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/completion.md
Generated
+6 -8
View File
@@ -1,30 +1,28 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# completion
Install or update shell completion scripts for the detected or chosen shell.
## Usage
```console
coder completion [flags]
```
## Options
### -s, --shell
| | |
|------|------------------------------------------|
| Type | <code>bash\|fish\|zsh\|powershell</code> |
The shell to install completion for.
### -p, --print
| | |
|------|-------------------|
| Type | <code>bool</code> |
Print the completion script instead of installing it.
Print the completion script instead of installing it.
docs/reference/cli/config-ssh.md
Generated
+23 -22
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# config-ssh
Add an SSH Host entry for your workspaces "ssh workspace.coder"
## Usage
```console
coder config-ssh [flags]
```
## Description
```console
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
@@ -24,93 +22,96 @@ workspaces:
$ coder config-ssh --dry-run
```
## Options
### --ssh-config-file
| | |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_FILE</code> |
| Default | <code>~/.ssh/config</code> |
Specifies the path to an SSH config.
### --coder-binary-path
| | |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_CONFIG_BINARY_PATH</code> |
Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.
### -o, --ssh-option
| | |
|-------------|-------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_CONFIG_OPTS</code> |
Specifies additional SSH options to embed in each host stanza.
### -n, --dry-run
| | |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DRY_RUN</code> |
Perform a trial run with no changes made, showing a diff at the end.
### --use-previous-options
| | |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
Specifies whether or not to keep options from previous run of config-ssh.
### --ssh-host-prefix
| | |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_SSH_HOST_PREFIX</code> |
Override the default host prefix.
### --hostname-suffix
| | |
|-------------|-----------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CONFIGSSH_HOSTNAME_SUFFIX</code> |
Override the default hostname suffix.
### --wait
| | |
|-------------|------------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_CONFIGSSH_WAIT</code> |
| Default | <code>auto</code> |
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
### --disable-autostart
| | |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_CONFIGSSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/create.md
Generated
+29 -21
View File
@@ -1,129 +1,137 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# create
Create a workspace
## Usage
```console
coder create [flags] [workspace]
```
## Description
```console
- Create a workspace for another user (if you have permission):
$ coder create <username>/<workspace_name>
```
## Options
### -t, --template
| | |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify a template name.
### --template-version
| | |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
Specify a template version name.
### --preset
| | |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PRESET_NAME</code> |
Specify the name of a template version preset. Use 'none' to explicitly indicate that no preset should be used.
### --start-at
| | |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.
### --stop-after
| | |
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
| | |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
| | |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
### --use-parameter-defaults
| | |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
Automatically accept parameter defaults when no value is provided.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --parameter
| | |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.
### --parameter-default
| | |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/delete.md
Generated
+8 -8
View File
@@ -1,40 +1,40 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# delete
Delete a workspace
Aliases:
* rm
## Usage
```console
coder delete [flags] <workspace>
```
## Description
```console
- Delete a workspace for another user (if you have permission):
$ coder delete <username>/<workspace_name>
```
## Options
### --orphan
| | |
|------|-------------------|
| Type | <code>bool</code> |
Delete a workspace without deleting its resources. This can delete a workspace in a broken state, but may also lead to unaccounted cloud resources.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/dotfiles.md
Generated
+11 -12
View File
@@ -1,56 +1,55 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# dotfiles
Personalize your workspace by applying a canonical dotfiles repository
## Usage
```console
coder dotfiles [flags] <git_repo_url>
```
## Description
```console
- Check out and install a dotfiles repository without prompts:
$ coder dotfiles --yes git@github.com:example/dotfiles.git
```
## Options
### --symlink-dir
| | |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SYMLINK_DIR</code> |
Specifies the directory for the dotfiles symlink destinations. If empty, will use $HOME.
### -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.
### --repo-dir
| | |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DOTFILES_REPO_DIR</code> |
| Default | <code>dotfiles</code> |
Specifies the directory for the dotfiles repository, relative to global config directory.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/external-auth.md
Generated
+3 -4
View File
@@ -1,23 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth
Manage external authentication
## Usage
```console
coder external-auth
```
## Description
```console
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
+13 -13
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-auth access-token
Print auth for an external provider
## Usage
```console
coder external-auth access-token [flags] <provider>
```
## Description
```console
Print an access-token for an external auth provider. The access-token will be validated and sent to stdout with exit code 0. If a valid access-token cannot be obtained, the URL to authenticate will be sent to stdout with exit code 1
- Ensure that the user is authenticated with GitHub before cloning.:
@@ -33,47 +31,49 @@ fi
$ coder external-auth access-token slack --extra "authed_user.id"
```
## Options
### --extra
| | |
|------|---------------------|
| Type | <code>string</code> |
Extract a field from the "extra" properties of the OAuth token.
### --agent-token
| | |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_TOKEN</code> |
An agent authentication token.
### --agent-token-file
| | |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_TOKEN_FILE</code> |
A file containing an agent authentication token.
### --agent-url
| | |
|-------------|-------------------------------|
| Type | <code>url</code> |
| Environment | <code>$CODER_AGENT_URL</code> |
URL for an agent to access your deployment.
### --auth
| | |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AGENT_AUTH</code> |
| Default | <code>token</code> |
Specify the authentication type to use for the agent.
Specify the authentication type to use for the agent.
docs/reference/cli/external-workspaces.md
Generated
+5 -6
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces
Create or manage external workspaces
## Usage
```console
coder external-workspaces [flags] [subcommand]
```
## Subcommands
| Name | Purpose |
|--------------------------------------------------------------------------------|--------------------------------------------|
| [<code>create</code>](./external-workspaces_create.md) | Create a new external workspace |
@@ -20,11 +18,12 @@ coder external-workspaces [flags] [subcommand]
| [<code>list</code>](./external-workspaces_list.md) | List external workspaces |
## Options
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/external-workspaces_agent-instructions.md
Generated
+4 -9
View File
@@ -1,26 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces agent-instructions
Get the instructions for an external agent
## Usage
```console
coder external-workspaces agent-instructions [flags] [user/]workspace[.agent]
```
## Options
### -o, --output
| | |
|---------|-------------------------|
| Type | <code>text\|json</code> |
| Default | <code>text</code> |
Output format.
Output format.
docs/reference/cli/external-workspaces_create.md
Generated
+29 -21
View File
@@ -1,129 +1,137 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces create
Create a new external workspace
## Usage
```console
coder external-workspaces create [flags] [workspace]
```
## Description
```console
- Create a workspace for another user (if you have permission):
$ coder create <username>/<workspace_name>
```
## Options
### -t, --template
| | |
|-------------|-----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_NAME</code> |
Specify a template name.
### --template-version
| | |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_TEMPLATE_VERSION</code> |
Specify a template version name.
### --preset
| | |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PRESET_NAME</code> |
Specify the name of a template version preset. Use 'none' to explicitly indicate that no preset should be used.
### --start-at
| | |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_START_AT</code> |
Specify the workspace autostart schedule. Check coder schedule start --help for the syntax.
### --stop-after
| | |
|-------------|------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
Specify a duration after which the workspace should shut down (e.g. 8h).
### --automatic-updates
| | |
|-------------|-------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_AUTOMATIC_UPDATES</code> |
| Default | <code>never</code> |
Specify automatic updates setting for the workspace (accepts 'always' or 'never').
### --copy-parameters-from
| | |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_WORKSPACE_COPY_PARAMETERS_FROM</code> |
Specify the source workspace name to copy parameters from.
### --use-parameter-defaults
| | |
|-------------|------------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_WORKSPACE_USE_PARAMETER_DEFAULTS</code> |
Automatically accept parameter defaults when no value is provided.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --parameter
| | |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.
### --parameter-default
| | |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
Rich parameter default values in the format "name=value".
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/external-workspaces_list.md
Generated
+11 -16
View File
@@ -1,56 +1,51 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# external-workspaces list
List external workspaces
Aliases:
* ls
## Usage
```console
coder external-workspaces list [flags]
```
## Options
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|-----------------------|
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/favorite.md
Generated
+2 -5
View File
@@ -1,18 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# favorite
Add a workspace to your favorites
Aliases:
* fav
* favourite
## Usage
```console
coder favorite <workspace>
```
docs/reference/cli/features.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features
List Enterprise features
Aliases:
* feature
## Usage
```console
coder features
```
## Subcommands
| Name | Purpose |
|-----------------------------------------|---------|
| [<code>list</code>](./features_list.md) | |
docs/reference/cli/features_list.md
Generated
+7 -11
View File
@@ -1,36 +1,32 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# features list
Aliases:
* ls
## Usage
```console
coder features list [flags]
```
## Options
### -c, --column
| | |
|---------|----------------------------------------------------------|
| Type | <code>[name\|entitlement\|enabled\|limit\|actual]</code> |
| Default | <code>name,entitlement,enabled,limit,actual</code> |
Specify columns to filter in the table.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/groups.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups
Manage groups
Aliases:
* group
## Usage
```console
coder groups
```
## Subcommands
| Name | Purpose |
|-------------------------------------------|---------------------|
| [<code>create</code>](./groups_create.md) | Create a user group |
docs/reference/cli/groups_create.md
Generated
+8 -9
View File
@@ -1,40 +1,39 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups create
Create a user group
## Usage
```console
coder groups create [flags] <name>
```
## Options
### -u, --avatar-url
| | |
|-------------|--------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_AVATAR_URL</code> |
Set an avatar for a group.
### --display-name
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
Optional human friendly name for the group.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/groups_delete.md
Generated
+5 -7
View File
@@ -1,27 +1,25 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups delete
Delete a user group
Aliases:
* rm
## Usage
```console
coder groups delete [flags] <name>
```
## Options
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/groups_edit.md
Generated
+14 -12
View File
@@ -1,60 +1,62 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups edit
Edit a user group
## Usage
```console
coder groups edit [flags] <name>
```
## Options
### -n, --name
| | |
|------|---------------------|
| Type | <code>string</code> |
Update the group name.
### -u, --avatar-url
| | |
|------|---------------------|
| Type | <code>string</code> |
Update the group avatar.
### --display-name
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_DISPLAY_NAME</code> |
Optional human friendly name for the group.
### -a, --add-users
| | |
|------|---------------------------|
| Type | <code>string-array</code> |
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.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/groups_list.md
Generated
+8 -13
View File
@@ -1,44 +1,39 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# groups list
List user groups
## Usage
```console
coder groups list [flags]
```
## Options
### -c, --column
| | |
|---------|-------------------------------------------------------------------------|
| Type | <code>[name\|display name\|organization id\|members\|avatar url]</code> |
| Default | <code>name,display name,organization id,members,avatar url</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/licenses.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses
Add, delete, and list licenses
Aliases:
* license
## Usage
```console
coder licenses
```
## Subcommands
| Name | Purpose |
|---------------------------------------------|-----------------------------------|
| [<code>add</code>](./licenses_add.md) | Add license to Coder deployment |
docs/reference/cli/licenses_add.md
Generated
+8 -9
View File
@@ -1,37 +1,36 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses add
Add license to Coder deployment
## Usage
```console
coder licenses add [flags] [-f file | -l license]
```
## Options
### -f, --file
| | |
|------|---------------------|
| Type | <code>string</code> |
Load license from file.
### -l, --license
| | |
|------|---------------------|
| Type | <code>string</code> |
License string.
### --debug
| | |
|------|-------------------|
| Type | <code>bool</code> |
Output license claims for debugging.
Output license claims for debugging.
docs/reference/cli/licenses_delete.md
Generated
+2 -5
View File
@@ -1,18 +1,15 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses delete
Delete license by ID
Aliases:
* del
* rm
## Usage
```console
coder licenses delete <id>
```
docs/reference/cli/licenses_list.md
Generated
+7 -12
View File
@@ -1,39 +1,34 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# licenses list
List licenses (including expired)
Aliases:
* ls
## Usage
```console
coder licenses list [flags]
```
## Options
### -c, --column
| | |
|---------|-------------------------------------------------------------------|
| Type | <code>[id\|uuid\|uploaded at\|features\|expires at\|trial]</code> |
| Default | <code>ID,UUID,Expires At,Uploaded At,Features</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/list.md
Generated
+11 -16
View File
@@ -1,56 +1,51 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# list
List workspaces
Aliases:
* ls
## Usage
```console
coder list [flags]
```
## Options
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|-----------------------|
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[favorite\|workspace\|organization id\|organization name\|template\|status\|healthy\|last built\|current version\|outdated\|starts at\|starts next\|stops after\|stops next\|daily cost]</code> |
| Default | <code>workspace,template,status,healthy,last built,current version,outdated,starts at,stops after</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/login.md
Generated
+16 -11
View File
@@ -1,72 +1,77 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login
Authenticate with Coder deployment
## Usage
```console
coder login [flags] [<url>]
```
## Description
```console
By default, the session token is stored in the operating system keyring on macOS and Windows and a plain text file on Linux. Use the --use-keyring flag or CODER_USE_KEYRING environment variable to change the storage mechanism.
```
## Subcommands
| Name | Purpose |
|----------------------------------------|---------------------------------|
| [<code>token</code>](./login_token.md) | Print the current session token |
## Options
### --first-user-email
| | |
|-------------|--------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_EMAIL</code> |
Specifies an email address to use if creating the first user for the deployment.
### --first-user-username
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_USERNAME</code> |
Specifies a username to use if creating the first user for the deployment.
### --first-user-full-name
| | |
|-------------|------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_FIRST_USER_FULL_NAME</code> |
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> |
Specifies a password to use if creating the first user for the deployment.
### --first-user-trial
| | |
|-------------|--------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_FIRST_USER_TRIAL</code> |
Specifies whether a trial license should be provisioned for the Coder deployment or not.
### --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.
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/login_token.md
Generated
+2 -5
View File
@@ -1,19 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# login token
Print the current session token
## Usage
```console
coder login token
```
## Description
```console
Print the session token for use in scripts and automation.
```
docs/reference/cli/logout.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logout
Unauthenticate your local session
## Usage
```console
coder logout [flags]
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/logs.md
Generated
+7 -12
View File
@@ -1,41 +1,36 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# logs
View logs for a workspace
## Usage
```console
coder logs [flags] <workspace>
```
## Description
```console
View logs for a workspace
```
## Options
### -n, --build-number
| | |
|---------|------------------|
| Type | <code>int</code> |
| Default | <code>0</code> |
Only show logs for a specific build number. Defaults to 0, which maps to the most recent build (build numbers start at 1). Negative values are treated as offsets—for example, -1 refers to the previous build.
### -f, --follow
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Follow logs as they are emitted.
Follow logs as they are emitted.
docs/reference/cli/netcheck.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# netcheck
Print network debug information for DERP and STUN
## Usage
```console
coder netcheck
```
docs/reference/cli/notifications.md
Generated
+4 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications
Manage Coder notifications
Aliases:
* notification
## Usage
```console
coder notifications
```
## Description
```console
Administrators can use these commands to change notification settings.
- Pause Coder notifications. Administrators can temporarily stop notifiers from
@@ -40,6 +39,7 @@ targeting other users or groups is currently not supported:
```
## Subcommands
| Name | Purpose |
|--------------------------------------------------|----------------------------|
| [<code>pause</code>](./notifications_pause.md) | Pause notifications |
docs/reference/cli/notifications_custom.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications custom
Send a custom notification
## Usage
```console
coder notifications custom <title> <message>
```
docs/reference/cli/notifications_pause.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications pause
Pause notifications
## Usage
```console
coder notifications pause
```
docs/reference/cli/notifications_resume.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications resume
Resume notifications
## Usage
```console
coder notifications resume
```
docs/reference/cli/notifications_test.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# notifications test
Send a test notification
## Usage
```console
coder notifications test
```
docs/reference/cli/open.md
Generated
+2 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open
Open a workspace
## Usage
```console
coder open
```
## Subcommands
| Name | Purpose |
|-----------------------------------------|-------------------------------------|
| [<code>vscode</code>](./open_vscode.md) | Open a workspace in VS Code Desktop |
docs/reference/cli/open_app.md
Generated
+4 -9
View File
@@ -1,27 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open app
Open a workspace application.
## Usage
```console
coder open app [flags] <workspace> <app slug>
```
## Options
### --region
| | |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_OPEN_APP_REGION</code> |
| Default | <code>primary</code> |
Region to use when opening the app. By default, the app will be opened using the main Coder deployment (a.k.a. "primary").
Region to use when opening the app. By default, the app will be opened using the main Coder deployment (a.k.a. "primary").
docs/reference/cli/open_vscode.md
Generated
+4 -7
View File
@@ -1,24 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# open vscode
Open a workspace in VS Code Desktop
## Usage
```console
coder open vscode [flags] <workspace> [<directory in workspace>]
```
## Options
### --generate-token
| | |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_OPEN_VSCODE_GENERATE_TOKEN</code> |
Generate an auth token and include it in the vscode:// URI. This is for automagical configuration of VS Code Desktop and not needed if already configured. This flag does not need to be specified when running this command on a local machine unless automatic open fails.
Generate an auth token and include it in the vscode:// URI. This is for automagical configuration of VS Code Desktop and not needed if already configured. This flag does not need to be specified when running this command on a local machine unless automatic open fails.
docs/reference/cli/organizations.md
Generated
+6 -6
View File
@@ -1,23 +1,22 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations
Organization related commands
Aliases:
* organization
* org
* orgs
## Usage
```console
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. |
@@ -29,11 +28,12 @@ coder organizations [flags] [subcommand]
| [<code>settings</code>](./organizations_settings.md) | Manage organization settings. |
## Options
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/organizations_create.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations create
Create a new organization.
## Usage
```console
coder organizations create [flags] <organization name>
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/organizations_members.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members
Manage organization members
Aliases:
* member
## Usage
```console
coder organizations members
```
## Subcommands
| Name | Purpose |
|------------------------------------------------------------------|-------------------------------------------------|
| [<code>list</code>](./organizations_members_list.md) | List all organization members |
docs/reference/cli/organizations_members_add.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members add
Add a new member to the current organization
## Usage
```console
coder organizations members add <username | user_id>
```
docs/reference/cli/organizations_members_edit-roles.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members edit-roles
Edit organization member's roles
Aliases:
* edit-role
## Usage
```console
coder organizations members edit-roles <username | user_id> [roles...]
```
docs/reference/cli/organizations_members_list.md
Generated
+6 -12
View File
@@ -1,36 +1,30 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members list
List all organization members
## Usage
```console
coder organizations members list [flags]
```
## Options
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------------------------|
| Type | <code>[username\|name\|user id\|organization id\|created at\|updated at\|organization roles]</code> |
| Default | <code>username,organization roles</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/organizations_members_remove.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations members remove
Remove a new member to the current organization
Aliases:
* rm
## Usage
```console
coder organizations members remove <username | user_id>
```
docs/reference/cli/organizations_roles.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles
Manage organization roles.
Aliases:
* role
## Usage
```console
coder organizations roles
```
## Subcommands
| Name | Purpose |
|--------------------------------------------------------|---------------------------------------|
| [<code>show</code>](./organizations_roles_show.md) | Show role(s) |
docs/reference/cli/organizations_roles_create.md
Generated
+9 -9
View File
@@ -1,44 +1,44 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles create
Create a new organization custom role
## Usage
```console
coder organizations roles create [flags] <role_name>
```
## Description
```console
- Run with an input.json file:
$ coder organization -O <organization_name> roles create --stdin < role.json
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --dry-run
| | |
|------|-------------------|
| Type | <code>bool</code> |
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.
Reads stdin for the json role definition to upload.
docs/reference/cli/organizations_roles_show.md
Generated
+6 -12
View File
@@ -1,36 +1,30 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles show
Show role(s)
## Usage
```console
coder organizations roles show [flags] [role_names ...]
```
## Options
### -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> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/organizations_roles_update.md
Generated
+13 -15
View File
@@ -1,64 +1,62 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations roles update
Update an organization custom role
## Usage
```console
coder organizations roles update [flags] <role_name>
```
## Description
```console
- Run with an input.json file:
$ coder roles update --stdin < role.json
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --dry-run
| | |
|------|-------------------|
| Type | <code>bool</code> |
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.
### -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> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/organizations_settings.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings
Manage organization settings.
Aliases:
* setting
## Usage
```console
coder organizations settings
```
## Subcommands
| Name | Purpose |
|-------------------------------------------------------|-----------------------------------------|
| [<code>show</code>](./organizations_settings_show.md) | Outputs specified organization setting. |
docs/reference/cli/organizations_settings_set.md
Generated
+3 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set
Update specified organization setting.
## Usage
```console
coder organizations settings set
```
## Description
```console
- Update group sync settings.:
@@ -20,6 +18,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. |
docs/reference/cli/organizations_settings_set_group-sync.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set group-sync
Group sync settings to sync groups from an IdP.
Aliases:
* groupsync
## Usage
```console
coder organizations settings set group-sync
```
docs/reference/cli/organizations_settings_set_organization-sync.md
Generated
+2 -5
View File
@@ -1,19 +1,16 @@
<!-- 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
## Usage
```console
coder organizations settings set organization-sync
```
docs/reference/cli/organizations_settings_set_role-sync.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set role-sync
Role sync settings to sync organization roles from an IdP.
Aliases:
* rolesync
## Usage
```console
coder organizations settings set role-sync
```
docs/reference/cli/organizations_settings_set_workspace-sharing.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings set workspace-sharing
Workspace sharing settings for the organization.
Aliases:
* workspacesharing
## Usage
```console
coder organizations settings set workspace-sharing
```
docs/reference/cli/organizations_settings_show.md
Generated
+3 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show
Outputs specified organization setting.
## Usage
```console
coder organizations settings show
```
## Description
```console
- Output group sync settings.:
@@ -20,6 +18,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. |
docs/reference/cli/organizations_settings_show_group-sync.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show group-sync
Group sync settings to sync groups from an IdP.
Aliases:
* groupsync
## Usage
```console
coder organizations settings show group-sync
```
docs/reference/cli/organizations_settings_show_organization-sync.md
Generated
+2 -5
View File
@@ -1,19 +1,16 @@
<!-- 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
## Usage
```console
coder organizations settings show organization-sync
```
docs/reference/cli/organizations_settings_show_role-sync.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show role-sync
Role sync settings to sync organization roles from an IdP.
Aliases:
* rolesync
## Usage
```console
coder organizations settings show role-sync
```
docs/reference/cli/organizations_settings_show_workspace-sharing.md
Generated
+2 -5
View File
@@ -1,17 +1,14 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# organizations settings show workspace-sharing
Workspace sharing settings for the organization.
Aliases:
* workspacesharing
## Usage
```console
coder organizations settings show workspace-sharing
```
docs/reference/cli/organizations_show.md
Generated
+9 -13
View File
@@ -1,18 +1,16 @@
<!-- 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.
## Usage
```console
coder organizations show [flags] ["selected"|"me"|uuid|org_name]
```
## Description
```console
- coder org show selected:
@@ -31,32 +29,30 @@ coder organizations show [flags] ["selected"|"me"|uuid|org_name]
$ Show organization with the given ID.
```
## Options
### --only-id
| | |
|------|-------------------|
| Type | <code>bool</code> |
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> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------------|
| Type | <code>text\|table\|json</code> |
| Default | <code>text</code> |
Output format.
Output format.
docs/reference/cli/ping.md
Generated
+12 -15
View File
@@ -1,57 +1,54 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ping
Ping a workspace
## Usage
```console
coder ping [flags] <workspace>
```
## Options
### --wait
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>1s</code> |
Specifies how long to wait between pings.
### -t, --timeout
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
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.
### --time
| | |
|------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in local time.
### --utc
| | |
|------|-------------------|
| Type | <code>bool</code> |
Show the response time of each pong in UTC (implies --time).
Show the response time of each pong in UTC (implies --time).
docs/reference/cli/port-forward.md
Generated
+10 -11
View File
@@ -1,21 +1,20 @@
<!-- 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
## Usage
```console
coder port-forward [flags] <workspace>
```
## Description
```console
- Port forward a single TCP port from 1234 in the workspace to port 5678 on your
local machine:
@@ -40,32 +39,32 @@ machine:
$ coder port-forward <workspace> --tcp 1.2.3.4:8080:8080
```
## Options
### -p, --tcp
| | |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_TCP</code> |
Forward TCP port(s) from the workspace to the local machine.
### --udp
| | |
|-------------|--------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PORT_FORWARD_UDP</code> |
Forward UDP port(s) from the workspace to the local machine. The UDP connection has TCP-like semantics to support stateful UDP protocols.
### --disable-autostart
| | |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
Disable starting the workspace automatically when connecting via SSH.
docs/reference/cli/prebuilds.md
Generated
+4 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# prebuilds
Manage Coder prebuilds
Aliases:
* prebuild
## Usage
```console
coder prebuilds
```
## Description
```console
Administrators can use these commands to manage prebuilt workspace settings.
- Pause Coder prebuilt workspace reconciliation.:
@@ -28,6 +27,7 @@ Administrators can use these commands to manage prebuilt workspace settings.
```
## Subcommands
| Name | Purpose |
|----------------------------------------------|------------------|
| [<code>pause</code>](./prebuilds_pause.md) | Pause prebuilds |
docs/reference/cli/prebuilds_pause.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# prebuilds pause
Pause prebuilds
## Usage
```console
coder prebuilds pause
```
docs/reference/cli/prebuilds_resume.md
Generated
+1 -5
View File
@@ -1,14 +1,10 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# prebuilds resume
Resume prebuilds
## Usage
```console
coder prebuilds resume
```
docs/reference/cli/provisioner.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner
View and manage provisioner daemons and jobs
Aliases:
* provisioners
## Usage
```console
coder provisioner
```
## Subcommands
| Name | Purpose |
|----------------------------------------------|---------------------------------------------|
| [<code>list</code>](./provisioner_list.md) | List provisioner daemons in an organization |
docs/reference/cli/provisioner_jobs.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner jobs
View and manage provisioner jobs
Aliases:
* job
## Usage
```console
coder provisioner jobs
```
## Subcommands
| Name | Purpose |
|-----------------------------------------------------|--------------------------|
| [<code>cancel</code>](./provisioner_jobs_cancel.md) | Cancel a provisioner job |
docs/reference/cli/provisioner_jobs_cancel.md
Generated
+4 -7
View File
@@ -1,24 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner jobs cancel
Cancel a provisioner job
## Usage
```console
coder provisioner jobs cancel [flags] <job_id>
```
## Options
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/provisioner_jobs_list.md
Generated
+15 -18
View File
@@ -1,74 +1,71 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner jobs list
List provisioner jobs
Aliases:
* ls
## Usage
```console
coder provisioner jobs list [flags]
```
## Options
### -s, --status
| | |
|-------------|----------------------------------------------------------------------------------|
| Type | <code>[pending\|running\|succeeded\|canceling\|canceled\|failed\|unknown]</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_STATUS</code> |
Filter by job status.
### -l, --limit
| | |
|-------------|------------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_LIMIT</code> |
| Default | <code>50</code> |
Limit the number of jobs returned.
### -i, --initiator
| | |
|-------------|----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_JOB_LIST_INITIATOR</code> |
Filter by initiator (user ID or username).
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|created at\|started at\|completed at\|canceled at\|error\|error code\|status\|worker id\|worker name\|file id\|tags\|queue position\|queue size\|organization id\|initiator id\|template version id\|workspace build id\|type\|available workers\|template version name\|template id\|template name\|template display name\|template icon\|workspace id\|workspace name\|logs overflowed\|organization\|queue]</code> |
| Default | <code>created at,id,type,template display name,status,queue,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/provisioner_keys.md
Generated
+3 -4
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys
Manage provisioner keys
Aliases:
* key
## Usage
```console
coder provisioner keys
```
## Subcommands
| Name | Purpose |
|-----------------------------------------------------|------------------------------------------|
| [<code>create</code>](./provisioner_keys_create.md) | Create a new provisioner key |
docs/reference/cli/provisioner_keys_create.md
Generated
+6 -8
View File
@@ -1,32 +1,30 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys create
Create a new provisioner key
## Usage
```console
coder provisioner keys create [flags] <name>
```
## Options
### -t, --tag
| | |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Tags to filter provisioner jobs by.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/provisioner_keys_delete.md
Generated
+7 -8
View File
@@ -1,34 +1,33 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys delete
Delete a provisioner key
Aliases:
* rm
## Usage
```console
coder provisioner keys delete [flags] <name>
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/provisioner_keys_list.md
Generated
+9 -13
View File
@@ -1,47 +1,43 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner keys list
List provisioner keys in an organization
Aliases:
* ls
## Usage
```console
coder provisioner keys list [flags]
```
## Options
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|---------------------------------------|
| Type | <code>[created at\|name\|tags]</code> |
| Default | <code>created at,name,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/provisioner_list.md
Generated
+17 -19
View File
@@ -1,82 +1,80 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner list
List provisioner daemons in an organization
Aliases:
* ls
## Usage
```console
coder provisioner list [flags]
```
## Options
### -l, --limit
| | |
|-------------|--------------------------------------------|
| Type | <code>int</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_LIMIT</code> |
| Default | <code>50</code> |
Limit the number of provisioners returned.
### -f, --show-offline
| | |
|-------------|----------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_SHOW_OFFLINE</code> |
Show offline provisioners.
### -s, --status
| | |
|-------------|---------------------------------------------|
| Type | <code>[offline\|idle\|busy]</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_STATUS</code> |
Filter by provisioner status.
### -m, --max-age
| | |
|-------------|----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONER_LIST_MAX_AGE</code> |
Filter provisioners by maximum age.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
### -c, --column
| | |
|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Type | <code>[id\|organization id\|created at\|last seen at\|name\|version\|api version\|tags\|key name\|status\|current job id\|current job status\|current job template name\|current job template icon\|current job template display name\|previous job id\|previous job status\|previous job template name\|previous job template icon\|previous job template display name\|organization]</code> |
| Default | <code>created at,last seen at,key name,name,version,status,tags</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/provisioner_start.md
Generated
+34 -36
View File
@@ -1,154 +1,151 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# provisioner start
Run a provisioner daemon
## Usage
```console
coder provisioner start [flags]
```
## Options
### -c, --cache-dir
| | |
|-------------|-------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_CACHE_DIRECTORY</code> |
| Default | <code>~/.cache/coder</code> |
Directory to store cached data.
### -t, --tag
| | |
|-------------|---------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_PROVISIONERD_TAGS</code> |
Tags to filter provisioner jobs by.
### --poll-interval
| | |
|-------------|------------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_INTERVAL</code> |
| Default | <code>1s</code> |
Deprecated and ignored.
### --poll-jitter
| | |
|-------------|----------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_PROVISIONERD_POLL_JITTER</code> |
| Default | <code>100ms</code> |
Deprecated and ignored.
### --psk
| | |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_PSK</code> |
Pre-shared key to authenticate with Coder server.
### --key
| | |
|-------------|--------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_KEY</code> |
Provisioner key to authenticate with Coder server.
### --name
| | |
|-------------|---------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_NAME</code> |
Name of this provisioner daemon. Defaults to the current hostname without FQDN.
### --verbose
| | |
|-------------|------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_VERBOSE</code> |
| Default | <code>false</code> |
Output debug-level logs.
### --log-human
| | |
|-------------|------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_HUMAN</code> |
| Default | <code>/dev/stderr</code> |
Output human-readable logs to a given file.
### --log-json
| | |
|-------------|-----------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_JSON</code> |
Output JSON logs to a given file.
### --log-stackdriver
| | |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PROVISIONER_DAEMON_LOGGING_STACKDRIVER</code> |
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.
### --prometheus-enable
| | |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMETHEUS_ENABLE</code> |
| Default | <code>false</code> |
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> |
The bind address to serve prometheus metrics.
### --experiments
| | |
|-------------|---------------------------------|
| Type | <code>string-array</code> |
@@ -156,11 +153,12 @@ The bind address to serve prometheus metrics.
| YAML | <code>experiments</code> |
Enable one or more experiments. These are not ready for production. Separate multiple experiments with commas, or enter '*' to opt-in to all available experiments.
### -O, --org
| | |
|-------------|----------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_ORGANIZATION</code> |
Select which organization (uuid or name) to use.
Select which organization (uuid or name) to use.
docs/reference/cli/publickey.md
Generated
+7 -8
View File
@@ -1,33 +1,32 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# publickey
Output your Coder public key used for Git operations
Aliases:
* pubkey
## Usage
```console
coder publickey [flags]
```
## Options
### --reset
| | |
|------|-------------------|
| Type | <code>bool</code> |
Regenerate your public key. This will require updating the key on any services it's registered with.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/rename.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# rename
Rename a workspace
## Usage
```console
coder rename [flags] <workspace> <new name>
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/reset-password.md
Generated
+6 -10
View File
@@ -1,35 +1,31 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# reset-password
Directly connect to the database to reset a user's password
## Usage
```console
coder reset-password [flags] <username>
```
## Options
### --postgres-url
| | |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
URL of a PostgreSQL database to connect to.
### --postgres-connection-auth
| | |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
Type of auth to use when connecting to postgres.
Type of auth to use when connecting to postgres.
docs/reference/cli/restart.md
Generated
+20 -15
View File
@@ -1,85 +1,90 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# restart
Restart a workspace
## Usage
```console
coder restart [flags] <workspace>
```
## Options
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
### --build-option
| | |
|-------------|----------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_BUILD_OPTION</code> |
Build option value in the format "name=value".
### --build-options
| | |
|------|-------------------|
| Type | <code>bool</code> |
Prompt for one-time build options defined with ephemeral parameters.
### --ephemeral-parameter
| | |
|-------------|-----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EPHEMERAL_PARAMETER</code> |
Set the value of ephemeral parameters defined in the template. The format is "name=value".
### --prompt-ephemeral-parameters
| | |
|-------------|-------------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_PROMPT_EPHEMERAL_PARAMETERS</code> |
Prompt to set values of ephemeral parameters defined in the template. If a value has been set via --ephemeral-parameter, it will not be prompted for.
### --parameter
| | |
|-------------|------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER</code> |
Rich parameter value in the format "name=value".
### --rich-parameter-file
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_RICH_PARAMETER_FILE</code> |
Specify a file path with values for rich parameters defined in the template. The file should be in YAML format, containing key-value pairs for the parameters.
### --parameter-default
| | |
|-------------|--------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_RICH_PARAMETER_DEFAULT</code> |
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.
Always prompt all parameters. Does not pull parameter values from existing workspace.
docs/reference/cli/schedule.md
Generated
+2 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule
Schedule automated start and stop times for workspaces
## Usage
```console
coder schedule { show | start | stop | extend } <workspace>
```
## Subcommands
| Name | Purpose |
|---------------------------------------------|-----------------------------------------------------------------|
| [<code>show</code>](./schedule_show.md) | Show workspace schedules |
docs/reference/cli/schedule_extend.md
Generated
+3 -5
View File
@@ -1,21 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule extend
Extend the stop time of a currently running workspace instance.
Aliases:
* override-stop
## Usage
```console
coder schedule extend <workspace-name> <duration from now>
```
## Description
```console
Extends the workspace deadline.
* The new stop time is calculated from *now*.
@@ -24,4 +23,3 @@ Extends the workspace deadline.
$ coder schedule extend my-workspace 90m
```
docs/reference/cli/schedule_show.md
Generated
+11 -16
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule show
Show workspace schedules
## Usage
```console
coder schedule show [flags] <workspace | --search <query> | --all>
```
## Description
```console
Shows the following information for the given workspace(s):
* The automatic start schedule
@@ -22,42 +20,39 @@ Shows the following information for the given workspace(s):
```
## Options
### -a, --all
| | |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether all workspaces will be listed or not.
### --search
| | |
|---------|-----------------------|
| Type | <code>string</code> |
| Default | <code>owner:me</code> |
Search for a workspace with a query.
### -c, --column
| | |
|---------|---------------------------------------------------------------------------|
| Type | <code>[workspace\|starts at\|starts next\|stops after\|stops next]</code> |
| Default | <code>workspace,starts at,starts next,stops after,stops next</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/schedule_start.md
Generated
+2 -5
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule start
Edit workspace start schedule
## Usage
```console
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual }
```
## Description
```console
Schedules a workspace to regularly start at a specific time.
Schedule format: <start-time> [day-of-week] [location].
@@ -28,4 +26,3 @@ Schedule format: <start-time> [day-of-week] [location].
$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin
```
docs/reference/cli/schedule_stop.md
Generated
+2 -5
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# schedule stop
Edit workspace stop schedule
## Usage
```console
coder schedule stop <workspace-name> { <duration> | manual }
```
## Description
```console
Schedules a workspace to stop after a given duration has elapsed.
* Workspace runtime is measured from the time that the workspace build completed.
@@ -29,4 +27,3 @@ When enabling scheduled stop, enter a duration in one of the following formats:
$ coder schedule stop my-workspace 2h30m
```
docs/reference/cli/server_create-admin-user.md
Generated
+16 -17
View File
@@ -1,77 +1,76 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server create-admin-user
Create a new admin user with the given username, email and password and adds it to every organization.
## Usage
```console
coder server create-admin-user [flags]
```
## Options
### --postgres-url
| | |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
URL of a PostgreSQL database. If empty, the built-in PostgreSQL deployment will be used (Coder must not be already running in this case).
### --postgres-connection-auth
| | |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
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> |
The algorithm to use for generating ssh keys. Accepted values are "ed25519", "ecdsa", or "rsa4096".
### --username
| | |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_USERNAME</code> |
The username of the new user. If not specified, you will be prompted via stdin.
### --email
| | |
|-------------|---------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EMAIL</code> |
The email of the new user. If not specified, you will be prompted via stdin.
### --password
| | |
|-------------|------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PASSWORD</code> |
The password of the new user. If not specified, you will be prompted via stdin.
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
Output the raw connection URL instead of a psql command.
docs/reference/cli/server_dbcrypt.md
Generated
+2 -4
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt
Manage database encryption.
## Usage
```console
coder server dbcrypt
```
## Subcommands
| Name | Purpose |
|-----------------------------------------------------|-------------------------------------------------------------------------------|
| [<code>decrypt</code>](./server_dbcrypt_decrypt.md) | Decrypt a previously encrypted database. |
docs/reference/cli/server_dbcrypt_decrypt.md
Generated
+10 -12
View File
@@ -1,50 +1,48 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt decrypt
Decrypt a previously encrypted database.
## Usage
```console
coder server dbcrypt decrypt [flags]
```
## Options
### --postgres-url
| | |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
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> |
Type of auth to use when connecting to postgres.
### --keys
| | |
|-------------|------------------------------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_DECRYPT_KEYS</code> |
Keys required to decrypt existing data. Must be a comma-separated list of base64-encoded keys.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/server_dbcrypt_delete.md
Generated
+9 -11
View File
@@ -1,45 +1,43 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt delete
Delete all encrypted data from the database. THIS IS A DESTRUCTIVE OPERATION.
Aliases:
* rm
## Usage
```console
coder server dbcrypt delete [flags]
```
## Options
### --postgres-url
| | |
|-------------|------------------------------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_EXTERNAL_TOKEN_ENCRYPTION_POSTGRES_URL</code> |
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> |
Type of auth to use when connecting to postgres.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/server_dbcrypt_rotate.md
Generated
+12 -13
View File
@@ -1,58 +1,57 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server dbcrypt rotate
Rotate database encryption keys.
## Usage
```console
coder server dbcrypt rotate [flags]
```
## Options
### --postgres-url
| | |
|-------------|---------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_PG_CONNECTION_URL</code> |
The connection URL for the Postgres database.
### --postgres-connection-auth
| | |
|-------------|----------------------------------------|
| Type | <code>password\|awsiamrds</code> |
| Environment | <code>$CODER_PG_CONNECTION_AUTH</code> |
| Default | <code>password</code> |
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> |
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> |
The old external token encryption keys. Must be a comma-separated list of base64-encoded keys.
### -y, --yes
| | |
|------|-------------------|
| Type | <code>bool</code> |
Bypass confirmation prompts.
Bypass confirmation prompts.
docs/reference/cli/server_postgres-builtin-serve.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server postgres-builtin-serve
Run the built-in PostgreSQL deployment.
## Usage
```console
coder server postgres-builtin-serve [flags]
```
## Options
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
Output the raw connection URL instead of a psql command.
docs/reference/cli/server_postgres-builtin-url.md
Generated
+4 -7
View File
@@ -1,23 +1,20 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# server postgres-builtin-url
Output the connection URL for the built-in PostgreSQL deployment.
## Usage
```console
coder server postgres-builtin-url [flags]
```
## Options
### --raw-url
| | |
|------|-------------------|
| Type | <code>bool</code> |
Output the raw connection URL instead of a psql command.
Output the raw connection URL instead of a psql command.
docs/reference/cli/show.md
Generated
+4 -9
View File
@@ -1,26 +1,21 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# show
Display details of a workspace's resources and agents
## Usage
```console
coder show [flags] <workspace>
```
## Options
### --details
| | |
|---------|--------------------|
| Type | <code>bool</code> |
| Default | <code>false</code> |
Show full error messages and additional details.
Show full error messages and additional details.
docs/reference/cli/speedtest.md
Generated
+14 -20
View File
@@ -1,70 +1,64 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# speedtest
Run upload and download tests from your machine to a workspace
## Usage
```console
coder speedtest [flags] <workspace>
```
## Options
### -d, --direct
| | |
|------|-------------------|
| Type | <code>bool</code> |
Specifies whether to wait for a direct connection before testing speed.
### --direction
| | |
|---------|-----------------------|
| Type | <code>up\|down</code> |
| Default | <code>down</code> |
Specifies whether to run in reverse mode where the client receives and the server sends.
### -t, --time
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies the duration to monitor traffic.
### --pcap-file
| | |
|------|---------------------|
| Type | <code>string</code> |
Specifies a file to write a network capture to.
### -c, --column
| | |
|---------|-------------------------------------|
| Type | <code>[Interval\|Throughput]</code> |
| Default | <code>Interval,Throughput</code> |
Columns to display in table output.
### -o, --output
| | |
|---------|--------------------------|
| Type | <code>table\|json</code> |
| Default | <code>table</code> |
Output format.
Output format.
docs/reference/cli/ssh.md
Generated
+33 -29
View File
@@ -1,18 +1,16 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# ssh
Start a shell into a workspace or run a command
## Usage
```console
coder ssh [flags] <workspace> [command]
```
## Description
```console
This command does not have full parity with the standard SSH command. For users who need the full functionality of SSH, create an ssh configuration with `coder config-ssh`.
@@ -21,135 +19,141 @@ This command does not have full parity with the standard SSH command. For users
$ coder ssh <workspace> -- ls -la
```
## Options
### --stdio
| | |
|-------------|-------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_STDIO</code> |
Specifies whether to emit SSH output over stdin/stdout.
### --ssh-host-prefix
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_SSH_HOST_PREFIX</code> |
Strip this prefix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command.
### --hostname-suffix
| | |
|-------------|-----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_HOSTNAME_SUFFIX</code> |
Strip this suffix from the provided hostname to determine the workspace name. This is useful when used as part of an OpenSSH proxy command. The suffix must be specified without a leading . character.
### -A, --forward-agent
| | |
|-------------|---------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_AGENT</code> |
Specifies whether to forward the SSH agent specified in $SSH_AUTH_SOCK.
### -G, --forward-gpg
| | |
|-------------|-------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_FORWARD_GPG</code> |
Specifies whether to forward the GPG agent. Unsupported on Windows workspaces, but supports all clients. Requires gnupg (gpg, gpgconf) on both the client and workspace. The GPG agent must already be running locally and will not be started for you. If a GPG agent is already running in the workspace, it will be attempted to be killed.
### --identity-agent
| | |
|-------------|----------------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_IDENTITY_AGENT</code> |
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK), forward agent must also be enabled.
### --workspace-poll-interval
| | |
|-------------|---------------------------------------------|
| Type | <code>duration</code> |
| Environment | <code>$CODER_WORKSPACE_POLL_INTERVAL</code> |
| Default | <code>1m</code> |
Specifies how often to poll for workspace automated shutdown.
### --wait
| | |
|-------------|------------------------------|
| Type | <code>yes\|no\|auto</code> |
| Environment | <code>$CODER_SSH_WAIT</code> |
| Default | <code>auto</code> |
Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.
### --no-wait
| | |
|-------------|---------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_NO_WAIT</code> |
Enter workspace immediately after the agent has connected. This is the default if the template has configured the agent startup script behavior as non-blocking.
### -l, --log-dir
| | |
|-------------|---------------------------------|
| Type | <code>string</code> |
| Environment | <code>$CODER_SSH_LOG_DIR</code> |
Specify the directory containing SSH diagnostic log files.
### -R, --remote-forward
| | |
|-------------|----------------------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_REMOTE_FORWARD</code> |
Enable remote port forwarding (remote_port:local_address:local_port).
### -e, --env
| | |
|-------------|-----------------------------|
| Type | <code>string-array</code> |
| Environment | <code>$CODER_SSH_ENV</code> |
Set environment variable(s) for session (key1=value1,key2=value2,...).
### --network-info-dir
| | |
|------|---------------------|
| Type | <code>string</code> |
Specifies a directory to write network information periodically.
### --network-info-interval
| | |
|---------|-----------------------|
| Type | <code>duration</code> |
| Default | <code>5s</code> |
Specifies the interval to update network information.
### --disable-autostart
| | |
|-------------|-------------------------------------------|
| Type | <code>bool</code> |
| Environment | <code>$CODER_SSH_DISABLE_AUTOSTART</code> |
| Default | <code>false</code> |
Disable starting the workspace automatically when connecting via SSH.
Disable starting the workspace automatically when connecting via SSH.

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