mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
Ammar Bandukwala
Vendored
+63
-57
@@ -1,68 +1,74 @@
|
||||
Usage: coder [global-flags] <subcommand>
|
||||
|
||||
Coder v0.0.0-devel — A tool for provisioning self-hosted development environments with Terraform.
|
||||
|
||||
Usage:
|
||||
coder [flags]
|
||||
|
||||
coder [command]
|
||||
|
||||
Get Started:
|
||||
- Start a Coder server:
|
||||
|
||||
[;m$ coder server[0m
|
||||
|
||||
- Get started by creating a template from an example:
|
||||
|
||||
[;m$ coder templates init[0m
|
||||
[;m$ coder templates init[0m
|
||||
|
||||
Commands:
|
||||
completion Generate the autocompletion script for the specified shell
|
||||
dotfiles Checkout and install a dotfiles repository from a Git URL
|
||||
help Help about any command
|
||||
login Authenticate with Coder deployment
|
||||
logout Unauthenticate your local session
|
||||
port-forward Forward ports from machine to a workspace
|
||||
publickey Output your Coder public key used for Git operations
|
||||
reset-password Directly connect to the database to reset a user's password
|
||||
scaletest Run a scale test against the Coder API
|
||||
server Start a Coder server
|
||||
state Manually manage Terraform state to fix broken workspaces
|
||||
templates Manage templates
|
||||
tokens Manage personal access tokens
|
||||
users Manage users
|
||||
version Show coder version
|
||||
[1mSubcommands[0m
|
||||
config-ssh Add an SSH Host entry for your workspaces "ssh
|
||||
coder.workspace"
|
||||
create Create a workspace
|
||||
delete Delete a workspace
|
||||
dotfiles Personalize your workspace by applying a canonical
|
||||
dotfiles repository
|
||||
list List workspaces
|
||||
login Authenticate with Coder deployment
|
||||
logout Unauthenticate your local session
|
||||
ping Ping a workspace
|
||||
port-forward Forward ports from machine to a workspace
|
||||
publickey Output your Coder public key used for Git operations
|
||||
rename Rename a workspace
|
||||
reset-password Directly connect to the database to reset a user's
|
||||
password
|
||||
restart Restart a workspace
|
||||
scaletest Run a scale test against the Coder API
|
||||
schedule Schedule automated start and stop times for workspaces
|
||||
server Start a Coder server
|
||||
show Display details of a workspace's resources and agents
|
||||
speedtest Run upload and download tests from your machine to a
|
||||
workspace
|
||||
ssh Start a shell into a workspace
|
||||
start Start a workspace
|
||||
state Manually manage Terraform state to fix broken workspaces
|
||||
stop Stop a workspace
|
||||
templates Manage templates
|
||||
tokens Manage personal access tokens
|
||||
update Will update and start a given workspace if it is out of
|
||||
date
|
||||
users Manage users
|
||||
version Show coder version
|
||||
|
||||
Workspace Commands:
|
||||
config-ssh Add an SSH Host entry for your workspaces "ssh coder.workspace"
|
||||
create Create a workspace
|
||||
delete Delete a workspace
|
||||
list List workspaces
|
||||
ping Ping a workspace
|
||||
rename Rename a workspace
|
||||
restart Restart a workspace
|
||||
schedule Schedule automated start and stop times for workspaces
|
||||
show Display details of a workspace's resources and agents
|
||||
speedtest Run upload and download tests from your machine to a workspace
|
||||
ssh Start a shell into a workspace
|
||||
start Start a workspace
|
||||
stop Stop a workspace
|
||||
update Will update and start a given workspace if it is out of date.
|
||||
[1mGlobal Options[0m
|
||||
Global options are applied to all commands. They can be set using environment
|
||||
variables or flags.
|
||||
|
||||
Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
-h, --help help for coder
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--global-config string, $CODER_CONFIG_DIR (default: ~/.config/coderv2)
|
||||
Path to the global `coder` config directory.
|
||||
|
||||
Use "coder [command] --help" for more information about a command.
|
||||
--header string-array, $CODER_HEADER
|
||||
Additional HTTP headers added to all requests. Provide as key=value.
|
||||
Can be specified multiple times.
|
||||
|
||||
--no-feature-warning bool, $CODER_NO_FEATURE_WARNING
|
||||
Suppress warnings about unlicensed features.
|
||||
|
||||
--no-version-warning bool, $CODER_NO_VERSION_WARNING
|
||||
Suppress warning when client and server versions do not match.
|
||||
|
||||
--token string, $CODER_SESSION_TOKEN
|
||||
Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
|
||||
--url url, $CODER_URL
|
||||
URL to a deployment.
|
||||
|
||||
-v, --verbose bool, $CODER_VERBOSE
|
||||
Enable verbose output.
|
||||
|
||||
---
|
||||
Report bugs and request features at https://github.com/coder/coder/issues/new
|
||||
|
||||
+20
-29
@@ -1,31 +1,22 @@
|
||||
Usage:
|
||||
coder agent [flags]
|
||||
Usage: coder agent [flags]
|
||||
|
||||
Flags:
|
||||
--auth string Specify the authentication type to use for the agent.
|
||||
Consumes $CODER_AGENT_AUTH (default "token")
|
||||
-h, --help help for agent
|
||||
--log-dir string Specify the location for the agent log files.
|
||||
Consumes $CODER_AGENT_LOG_DIR (default "/tmp")
|
||||
--no-reap Do not start a process reaper.
|
||||
--pprof-address string The address to serve pprof.
|
||||
Consumes $CODER_AGENT_PPROF_ADDRESS (default "127.0.0.1:6060")
|
||||
--ssh-max-timeout duration Specify the max timeout for a SSH connection.
|
||||
Consumes $CODER_AGENT_SSH_MAX_TIMEOUT
|
||||
Starts the Coder workspace agent.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
[1mOptions[0m
|
||||
--auth string, $CODER_AGENT_AUTH (default: token)
|
||||
Specify the authentication type to use for the agent.
|
||||
|
||||
--log-dir string, $CODER_AGENT_LOG_DIR (default: /tmp)
|
||||
Specify the location for the agent log files.
|
||||
|
||||
--no-reap bool
|
||||
Do not start a process reaper.
|
||||
|
||||
--pprof-address string, $CODER_AGENT_PPROF_ADDRESS (default: 127.0.0.1:6060)
|
||||
The address to serve pprof.
|
||||
|
||||
--ssh-max-timeout duration, $CODER_AGENT_SSH_MAX_TIMEOUT (default: 0)
|
||||
Specify the max timeout for a SSH connection.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+25
-34
@@ -1,44 +1,35 @@
|
||||
Usage: coder config-ssh [flags]
|
||||
|
||||
Add an SSH Host entry for your workspaces "ssh coder.workspace"
|
||||
|
||||
Usage:
|
||||
coder config-ssh [flags]
|
||||
|
||||
Get Started:
|
||||
- You can use -o (or --ssh-option) so set SSH options to be used for all your
|
||||
- You can use -o (or --ssh-option) so set SSH options to be used for all your
|
||||
workspaces:
|
||||
|
||||
[;m$ coder config-ssh -o ForwardAgent=yes[0m
|
||||
|
||||
- You can use --dry-run (or -n) to see the changes that would be made:
|
||||
|
||||
[;m$ coder config-ssh --dry-run[0m
|
||||
[;m$ coder config-ssh --dry-run[0m
|
||||
|
||||
Flags:
|
||||
-n, --dry-run Perform a trial run with no changes made, showing a diff at
|
||||
the end.
|
||||
-h, --help help for config-ssh
|
||||
--ssh-config-file string Specifies the path to an SSH config.
|
||||
Consumes $CODER_SSH_CONFIG_FILE (default "~/.ssh/config")
|
||||
--ssh-host-prefix string Override the default host prefix.
|
||||
-o, --ssh-option stringArray Specifies additional SSH options to embed in each host stanza.
|
||||
--use-previous-options Specifies whether or not to keep options from previous run of
|
||||
config-ssh.
|
||||
Consumes $CODER_SSH_USE_PREVIOUS_OPTIONS
|
||||
-y, --yes Bypass prompts
|
||||
[1mOptions[0m
|
||||
-n, --dry-run bool, $CODER_SSH_DRY_RUN
|
||||
Perform a trial run with no changes made, showing a diff at the end.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--ssh-config-file string, $CODER_SSH_CONFIG_FILE (default: ~/.ssh/config)
|
||||
Specifies the path to an SSH config.
|
||||
|
||||
--ssh-host-prefix string
|
||||
Override the default host prefix.
|
||||
|
||||
-o, --ssh-option string-array, $CODER_SSH_CONFIG_OPTS
|
||||
Specifies additional SSH options to embed in each host stanza.
|
||||
|
||||
--use-previous-options bool, $CODER_SSH_USE_PREVIOUS_OPTIONS
|
||||
Specifies whether or not to keep options from previous run of
|
||||
config-ssh.
|
||||
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+24
-34
@@ -1,38 +1,28 @@
|
||||
Usage: coder create [flags] [name]
|
||||
|
||||
Create a workspace
|
||||
|
||||
Usage:
|
||||
coder create [name] [flags]
|
||||
[1mOptions[0m
|
||||
--parameter-file string, $CODER_PARAMETER_FILE
|
||||
Specify a file path with parameter values.
|
||||
|
||||
Flags:
|
||||
-h, --help help for create
|
||||
--parameter-file string Specify a file path with parameter values.
|
||||
Consumes $CODER_PARAMETER_FILE
|
||||
--rich-parameter-file string Specify a file path with values for rich
|
||||
parameters defined in the template.
|
||||
Consumes $CODER_RICH_PARAMETER_FILE
|
||||
--start-at coder schedule start --help Specify the workspace autostart schedule. Check
|
||||
coder schedule start --help for the syntax.
|
||||
Consumes $CODER_WORKSPACE_START_AT
|
||||
--stop-after duration Specify a duration after which the workspace
|
||||
should shut down (e.g. 8h).
|
||||
Consumes $CODER_WORKSPACE_STOP_AFTER
|
||||
-t, --template string Specify a template name.
|
||||
Consumes $CODER_TEMPLATE_NAME
|
||||
-y, --yes Bypass prompts
|
||||
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
|
||||
Specify a file path with values for rich parameters defined in the
|
||||
template.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--start-at string, $CODER_WORKSPACE_START_AT
|
||||
Specify the workspace autostart schedule. Check coder schedule start
|
||||
--help for the syntax.
|
||||
|
||||
--stop-after duration, $CODER_WORKSPACE_STOP_AFTER
|
||||
Specify a duration after which the workspace should shut down (e.g.
|
||||
8h).
|
||||
|
||||
-t, --template string, $CODER_TEMPLATE_NAME
|
||||
Specify a template name.
|
||||
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+12
-25
@@ -1,30 +1,17 @@
|
||||
Usage: coder delete [flags] <workspace>
|
||||
|
||||
Delete a workspace
|
||||
|
||||
Usage:
|
||||
coder delete <workspace> [flags]
|
||||
Aliases: rm
|
||||
|
||||
Aliases:
|
||||
delete, rm
|
||||
[1mOptions[0m
|
||||
--orphan bool
|
||||
Delete a workspace without deleting its resources. This can delete a
|
||||
workspace in a broken state, but may also lead to unaccounted cloud
|
||||
resources.
|
||||
|
||||
Flags:
|
||||
-h, --help help for delete
|
||||
--orphan 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 Bypass prompts
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+13
-28
@@ -1,33 +1,18 @@
|
||||
Checkout and install a dotfiles repository from a Git URL
|
||||
Usage: coder dotfiles [flags] <git_repo_url>
|
||||
|
||||
Usage:
|
||||
coder dotfiles [git_repo_url] [flags]
|
||||
Personalize your workspace by applying a canonical dotfiles repository
|
||||
|
||||
Get Started:
|
||||
- Check out and install a dotfiles repository without prompts:
|
||||
- Check out and install a dotfiles repository without prompts:
|
||||
|
||||
[;m$ coder dotfiles --yes git@github.com:example/dotfiles.git[0m
|
||||
[;m$ coder dotfiles --yes git@github.com:example/dotfiles.git[0m
|
||||
|
||||
Flags:
|
||||
-h, --help help for dotfiles
|
||||
--symlink-dir string Specifies the directory for the dotfiles symlink destinations. If
|
||||
empty will use $HOME.
|
||||
Consumes $CODER_SYMLINK_DIR
|
||||
-y, --yes Bypass prompts
|
||||
[1mOptions[0m
|
||||
--symlink-dir string, $CODER_SYMLINK_DIR
|
||||
Specifies the directory for the dotfiles symlink destinations. If
|
||||
empty, will use $HOME.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+17
-29
@@ -1,34 +1,22 @@
|
||||
Usage: coder list [flags]
|
||||
|
||||
List workspaces
|
||||
|
||||
Usage:
|
||||
coder list [flags]
|
||||
Aliases: ls
|
||||
|
||||
Aliases:
|
||||
list, ls
|
||||
[1mOptions[0m
|
||||
-a, --all bool
|
||||
Specifies whether all workspaces will be listed or not.
|
||||
|
||||
Flags:
|
||||
-a, --all Specifies whether all workspaces will be listed or not.
|
||||
-c, --column strings Columns to display in table output. Available columns: workspace,
|
||||
template, status, last built, outdated, starts at, stops after
|
||||
(default [workspace,template,status,last built,outdated,starts
|
||||
at,stops after])
|
||||
-h, --help help for list
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
--search string Search for a workspace with a query. (default "owner:me")
|
||||
-c, --column string-array (default: workspace,template,status,last built,outdated,starts at,stops after)
|
||||
Columns to display in table output. Available columns: workspace,
|
||||
template, status, last built, outdated, starts at, stops after.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
--search string (default: owner:me)
|
||||
Search for a workspace with a query.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+19
-32
@@ -1,36 +1,23 @@
|
||||
Usage: coder login [flags] <url>
|
||||
|
||||
Authenticate with Coder deployment
|
||||
|
||||
Usage:
|
||||
coder login <url> [flags]
|
||||
[1mOptions[0m
|
||||
--first-user-email string, $CODER_FIRST_USER_EMAIL
|
||||
Specifies an email address to use if creating the first user for the
|
||||
deployment.
|
||||
|
||||
Flags:
|
||||
--first-user-email string Specifies an email address to use if creating the first
|
||||
user for the deployment.
|
||||
Consumes $CODER_FIRST_USER_EMAIL
|
||||
--first-user-password string Specifies a password to use if creating the first user
|
||||
for the deployment.
|
||||
Consumes $CODER_FIRST_USER_PASSWORD
|
||||
--first-user-trial Specifies whether a trial license should be provisioned
|
||||
for the Coder deployment or not.
|
||||
Consumes $CODER_FIRST_USER_TRIAL
|
||||
--first-user-username string Specifies a username to use if creating the first user
|
||||
for the deployment.
|
||||
Consumes $CODER_FIRST_USER_USERNAME
|
||||
-h, --help help for login
|
||||
--first-user-password string, $CODER_FIRST_USER_PASSWORD
|
||||
Specifies a password to use if creating the first user for the
|
||||
deployment.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--first-user-trial bool, $CODER_FIRST_USER_TRIAL
|
||||
Specifies whether a trial license should be provisioned for the Coder
|
||||
deployment or not.
|
||||
|
||||
--first-user-username string, $CODER_FIRST_USER_USERNAME
|
||||
Specifies a username to use if creating the first user for the
|
||||
deployment.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder logout [flags]
|
||||
|
||||
Unauthenticate your local session
|
||||
|
||||
Usage:
|
||||
coder logout [flags]
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Flags:
|
||||
-h, --help help for logout
|
||||
-y, --yes Bypass prompts
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+12
-22
@@ -1,26 +1,16 @@
|
||||
Usage: coder ping [flags] <workspace>
|
||||
|
||||
Ping a workspace
|
||||
|
||||
Usage:
|
||||
coder ping <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-n, --num int (default: 10)
|
||||
Specifies the number of pings to perform.
|
||||
|
||||
Flags:
|
||||
-h, --help help for ping
|
||||
-n, --num int Specifies the number of pings to perform. (default 10)
|
||||
-t, --timeout duration Specifies how long to wait for a ping to complete. (default 5s)
|
||||
-v, --verbose Enables verbose logging.
|
||||
--wait duration Specifies how long to wait between pings. (default 1s)
|
||||
-t, --timeout duration (default: 5s)
|
||||
Specifies how long to wait for a ping to complete.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
--wait duration (default: 1s)
|
||||
Specifies how long to wait between pings.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+14
-31
@@ -1,13 +1,10 @@
|
||||
Usage: coder port-forward [flags] <workspace>
|
||||
|
||||
Forward ports from machine to a workspace
|
||||
|
||||
Usage:
|
||||
coder port-forward <workspace> [flags]
|
||||
Aliases: tunnel
|
||||
|
||||
Aliases:
|
||||
port-forward, tunnel
|
||||
|
||||
Get Started:
|
||||
- Port forward a single TCP port from 1234 in the workspace to port 5678 on
|
||||
- Port forward a single TCP port from 1234 in the workspace to port 5678 on
|
||||
your local machine:
|
||||
|
||||
[;m$ coder port-forward <workspace> --tcp 5678:1234[0m
|
||||
@@ -23,29 +20,15 @@ Get Started:
|
||||
|
||||
- Port forward multiple ports (TCP or UDP) in condensed syntax:
|
||||
|
||||
[;m$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012[0m
|
||||
[;m$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012[0m
|
||||
|
||||
Flags:
|
||||
-h, --help help for port-forward
|
||||
-p, --tcp stringArray Forward TCP port(s) from the workspace to the local machine.
|
||||
Consumes $CODER_PORT_FORWARD_TCP
|
||||
--udp stringArray Forward UDP port(s) from the workspace to the local machine. The UDP
|
||||
connection has TCP-like semantics to support stateful UDP protocols.
|
||||
Consumes $CODER_PORT_FORWARD_UDP
|
||||
[1mOptions[0m
|
||||
-p, --tcp string-array, $CODER_PORT_FORWARD_TCP
|
||||
Forward TCP port(s) from the workspace to the local machine.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--udp string-array, $CODER_PORT_FORWARD_UDP
|
||||
Forward UDP port(s) from the workspace to the local machine. The UDP
|
||||
connection has TCP-like semantics to support stateful UDP protocols.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+11
-25
@@ -1,30 +1,16 @@
|
||||
Usage: coder publickey [flags]
|
||||
|
||||
Output your Coder public key used for Git operations
|
||||
|
||||
Usage:
|
||||
coder publickey [flags]
|
||||
Aliases: pubkey
|
||||
|
||||
Aliases:
|
||||
publickey, pubkey
|
||||
[1mOptions[0m
|
||||
--reset bool
|
||||
Regenerate your public key. This will require updating the key on any
|
||||
services it's registered with.
|
||||
|
||||
Flags:
|
||||
-h, --help help for publickey
|
||||
--reset Regenerate your public key. This will require updating the key on any services
|
||||
it's registered with.
|
||||
-y, --yes Bypass prompts
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder rename [flags] <workspace> <new name>
|
||||
|
||||
Rename a workspace
|
||||
|
||||
Usage:
|
||||
coder rename <workspace> <new name> [flags]
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Flags:
|
||||
-h, --help help for rename
|
||||
-y, --yes Bypass prompts
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-23
@@ -1,26 +1,10 @@
|
||||
Usage: coder reset-password [flags] <username>
|
||||
|
||||
Directly connect to the database to reset a user's password
|
||||
|
||||
Usage:
|
||||
coder reset-password <username> [flags]
|
||||
[1mOptions[0m
|
||||
--postgres-url string, $CODER_PG_CONNECTION_URL
|
||||
URL of a PostgreSQL database to connect to.
|
||||
|
||||
Flags:
|
||||
-h, --help help for reset-password
|
||||
--postgres-url string URL of a PostgreSQL database to connect to.
|
||||
Consumes $CODER_PG_CONNECTION_URL
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder restart [flags] <workspace>
|
||||
|
||||
Restart a workspace
|
||||
|
||||
Usage:
|
||||
coder restart <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Flags:
|
||||
-h, --help help for restart
|
||||
-y, --yes Bypass prompts
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+12
-29
@@ -1,32 +1,15 @@
|
||||
Perform scale tests against the Coder server.
|
||||
Usage: coder scaletest
|
||||
|
||||
Usage:
|
||||
coder scaletest [flags]
|
||||
Run a scale test against the Coder API
|
||||
|
||||
coder scaletest [command]
|
||||
[1mSubcommands[0m
|
||||
cleanup Cleanup scaletest workspaces, then cleanup scaletest
|
||||
users.
|
||||
create-workspaces Creates many users, then creates a workspace for each
|
||||
user and waits for them finish building and fully come
|
||||
online. Optionally runs a command inside each
|
||||
workspace, and connects to the workspace over
|
||||
WireGuard.
|
||||
|
||||
Commands:
|
||||
cleanup Cleanup any orphaned scaletest resources
|
||||
create-workspaces Creates many workspaces and waits for them to be ready
|
||||
|
||||
Flags:
|
||||
-h, --help help for scaletest
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder scaletest [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+16
-29
@@ -1,32 +1,19 @@
|
||||
Cleanup scaletest workspaces, then cleanup scaletest users. The strategy flags will apply to each stage of the cleanup process.
|
||||
Usage: coder scaletest cleanup [flags]
|
||||
|
||||
Usage:
|
||||
coder scaletest cleanup [flags]
|
||||
Cleanup scaletest workspaces, then cleanup scaletest users.
|
||||
|
||||
Flags:
|
||||
--cleanup-concurrency int Number of concurrent cleanup jobs to run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_CONCURRENCY (default 1)
|
||||
--cleanup-job-timeout duration Timeout per job. Jobs may take longer to complete under
|
||||
higher concurrency limits.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_JOB_TIMEOUT (default 5m0s)
|
||||
--cleanup-timeout duration Timeout for the entire cleanup run. 0 means unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_TIMEOUT (default 30m0s)
|
||||
-h, --help help for cleanup
|
||||
The strategy flags will apply to each stage of the cleanup process.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
[1mOptions[0m
|
||||
--cleanup-concurrency int, $CODER_SCALETEST_CLEANUP_CONCURRENCY (default: 1)
|
||||
Number of concurrent cleanup jobs to run. 0 means unlimited.
|
||||
|
||||
--cleanup-job-timeout duration, $CODER_SCALETEST_CLEANUP_JOB_TIMEOUT (default: 5m)
|
||||
Timeout per job. Jobs may take longer to complete under higher
|
||||
concurrency limits.
|
||||
|
||||
--cleanup-timeout duration, $CODER_SCALETEST_CLEANUP_TIMEOUT (default: 30m)
|
||||
Timeout for the entire cleanup run. 0 means unlimited.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+115
-126
@@ -1,131 +1,120 @@
|
||||
Creates many users, then creates a workspace for each user and waits for them finish building and fully come online. Optionally runs a command inside each workspace, and connects to the workspace over WireGuard.
|
||||
Usage: coder scaletest create-workspaces [flags]
|
||||
|
||||
Creates many users, then creates a workspace for each user and waits for them
|
||||
finish building and fully come online. Optionally runs a command inside each
|
||||
workspace, and connects to the workspace over WireGuard.
|
||||
|
||||
It is recommended that all rate limits are disabled on the server before running this scaletest. This test generates many login events which will be rate limited against the (most likely single) IP.
|
||||
|
||||
Usage:
|
||||
coder scaletest create-workspaces [flags]
|
||||
[1mOptions[0m
|
||||
--cleanup-concurrency int, $CODER_SCALETEST_CLEANUP_CONCURRENCY (default: 1)
|
||||
Number of concurrent cleanup jobs to run. 0 means unlimited.
|
||||
|
||||
Flags:
|
||||
--cleanup-concurrency int Number of concurrent cleanup jobs to run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_CONCURRENCY
|
||||
(default 1)
|
||||
--cleanup-job-timeout duration Timeout per job. Jobs may take longer to complete
|
||||
under higher concurrency limits.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_JOB_TIMEOUT
|
||||
(default 5m0s)
|
||||
--cleanup-timeout duration Timeout for the entire cleanup run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CLEANUP_TIMEOUT (default
|
||||
30m0s)
|
||||
--concurrency int Number of concurrent jobs to run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_CONCURRENCY (default 1)
|
||||
--connect-hold duration How long to hold the WireGuard connection open
|
||||
for.
|
||||
Consumes $CODER_LOADTEST_CONNECT_HOLD (default 30s)
|
||||
--connect-interval duration How long to wait between making requests to the
|
||||
--connect-url once the connection is established.
|
||||
Consumes $CODER_LOADTEST_CONNECT_INTERVAL (default 1s)
|
||||
--connect-mode string Mode to use for connecting to the workspace. Can
|
||||
be 'derp' or 'direct'.
|
||||
Consumes $CODER_LOADTEST_CONNECT_MODE (default "derp")
|
||||
--connect-timeout duration Timeout for each request to the --connect-url.
|
||||
Consumes $CODER_LOADTEST_CONNECT_TIMEOUT (default 5s)
|
||||
--connect-url string URL to connect to inside the the workspace over
|
||||
WireGuard. If not specified, no connections will
|
||||
be made over WireGuard.
|
||||
Consumes $CODER_LOADTEST_CONNECT_URL
|
||||
-c, --count int Required: Number of workspaces to create.
|
||||
Consumes $CODER_LOADTEST_COUNT (default 1)
|
||||
-h, --help help for create-workspaces
|
||||
--job-timeout duration Timeout per job. Jobs may take longer to complete
|
||||
under higher concurrency limits.
|
||||
Consumes $CODER_LOADTEST_JOB_TIMEOUT (default 5m0s)
|
||||
--no-cleanup coder scaletest cleanup Do not clean up resources after the test
|
||||
completes. You can cleanup manually using coder
|
||||
scaletest cleanup.
|
||||
Consumes $CODER_LOADTEST_NO_CLEANUP
|
||||
--no-plan Skip the dry-run step to plan the workspace
|
||||
creation. This step ensures that the given
|
||||
parameters are valid for the given template.
|
||||
Consumes $CODER_LOADTEST_NO_PLAN
|
||||
--no-wait-for-agents Do not wait for agents to start before marking
|
||||
the test as succeeded. This can be useful if you
|
||||
are running the test against a template that does
|
||||
not start the agent quickly.
|
||||
Consumes $CODER_LOADTEST_NO_WAIT_FOR_AGENTS
|
||||
--output stringArray Output format specs in the format
|
||||
"<format>[:<path>]". Not specifying a path will
|
||||
default to stdout. Available formats: text, json.
|
||||
Consumes $CODER_SCALETEST_OUTPUTS (default [text])
|
||||
--parameter stringArray Parameters to use for each workspace. Can be
|
||||
specified multiple times. Overrides any existing
|
||||
parameters with the same name from
|
||||
--parameters-file. Format: key=value.
|
||||
Consumes $CODER_LOADTEST_PARAMETERS
|
||||
--parameters-file string Path to a YAML file containing the parameters to
|
||||
use for each workspace.
|
||||
Consumes $CODER_LOADTEST_PARAMETERS_FILE
|
||||
--run-command string Command to run inside each workspace using
|
||||
reconnecting-pty (i.e. web terminal protocol). If
|
||||
not specified, no command will be run.
|
||||
Consumes $CODER_LOADTEST_RUN_COMMAND
|
||||
--run-expect-output string Expect the command to output the given string (on
|
||||
a single line). If the command does not output
|
||||
the given string, it will be marked as failed.
|
||||
Consumes $CODER_LOADTEST_RUN_EXPECT_OUTPUT
|
||||
--run-expect-timeout Expect the command to timeout. If the command
|
||||
does not finish within the given --run-timeout,
|
||||
it will be marked as succeeded. If the command
|
||||
finishes before the timeout, it will be marked as
|
||||
failed.
|
||||
Consumes $CODER_LOADTEST_RUN_EXPECT_TIMEOUT
|
||||
--run-log-output Log the output of the command to the test logs.
|
||||
This should be left off unless you expect small
|
||||
amounts of output. Large amounts of output will
|
||||
cause high memory usage.
|
||||
Consumes $CODER_LOADTEST_RUN_LOG_OUTPUT
|
||||
--run-timeout duration Timeout for the command to complete.
|
||||
Consumes $CODER_LOADTEST_RUN_TIMEOUT (default 5s)
|
||||
-t, --template string Required: Name or ID of the template to use for
|
||||
workspaces.
|
||||
Consumes $CODER_LOADTEST_TEMPLATE
|
||||
--timeout duration Timeout for the entire test run. 0 means
|
||||
unlimited.
|
||||
Consumes $CODER_LOADTEST_TIMEOUT (default 30m0s)
|
||||
--trace Whether application tracing data is collected. It
|
||||
exports to a backend configured by environment
|
||||
variables. See:
|
||||
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
|
||||
Consumes $CODER_LOADTEST_TRACE
|
||||
--trace-coder Whether opentelemetry traces are sent to Coder.
|
||||
We recommend keeping this disabled unless we
|
||||
advise you to enable it.
|
||||
Consumes $CODER_LOADTEST_TRACE_CODER
|
||||
--trace-honeycomb-api-key string Enables trace exporting to Honeycomb.io using the
|
||||
provided API key.
|
||||
Consumes $CODER_LOADTEST_TRACE_HONEYCOMB_API_KEY
|
||||
--trace-propagate Enables trace propagation to the Coder backend,
|
||||
which will be used to correlate server-side spans
|
||||
with client-side spans. Only enable this if the
|
||||
server is configured with the exact same tracing
|
||||
configuration as the client.
|
||||
Consumes $CODER_LOADTEST_TRACE_PROPAGATE
|
||||
--cleanup-job-timeout duration, $CODER_SCALETEST_CLEANUP_JOB_TIMEOUT (default: 5m)
|
||||
Timeout per job. Jobs may take longer to complete under higher
|
||||
concurrency limits.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--cleanup-timeout duration, $CODER_SCALETEST_CLEANUP_TIMEOUT (default: 30m)
|
||||
Timeout for the entire cleanup run. 0 means unlimited.
|
||||
|
||||
--concurrency int, $CODER_SCALETEST_CONCURRENCY (default: 1)
|
||||
Number of concurrent jobs to run. 0 means unlimited.
|
||||
|
||||
--connect-hold duration, $CODER_SCALETEST_CONNECT_HOLD (default: 30s)
|
||||
How long to hold the WireGuard connection open for.
|
||||
|
||||
--connect-interval duration, $CODER_SCALETEST_CONNECT_INTERVAL (default: 1s)
|
||||
How long to wait between making requests to the --connect-url once the
|
||||
connection is established.
|
||||
|
||||
--connect-mode derp|direct, $CODER_SCALETEST_CONNECT_MODE (default: derp)
|
||||
Mode to use for connecting to the workspace.
|
||||
|
||||
--connect-timeout duration, $CODER_SCALETEST_CONNECT_TIMEOUT (default: 5s)
|
||||
Timeout for each request to the --connect-url.
|
||||
|
||||
--connect-url string, $CODER_SCALETEST_CONNECT_URL
|
||||
URL to connect to inside the the workspace over WireGuard. If not
|
||||
specified, no connections will be made over WireGuard.
|
||||
|
||||
-c, --count int, $CODER_SCALETEST_COUNT (default: 1)
|
||||
Required: Number of workspaces to create.
|
||||
|
||||
--job-timeout duration, $CODER_SCALETEST_JOB_TIMEOUT (default: 5m)
|
||||
Timeout per job. Jobs may take longer to complete under higher
|
||||
concurrency limits.
|
||||
|
||||
--no-cleanup bool, $CODER_SCALETEST_NO_CLEANUP
|
||||
Do not clean up resources after the test completes. You can cleanup
|
||||
manually using coder scaletest cleanup.
|
||||
|
||||
--no-plan bool, $CODER_SCALETEST_NO_PLAN
|
||||
Skip the dry-run step to plan the workspace creation. This step
|
||||
ensures that the given parameters are valid for the given template.
|
||||
|
||||
--no-wait-for-agents bool, $CODER_SCALETEST_NO_WAIT_FOR_AGENTS
|
||||
Do not wait for agents to start before marking the test as succeeded.
|
||||
This can be useful if you are running the test against a template that
|
||||
does not start the agent quickly.
|
||||
|
||||
--output string-array, $CODER_SCALETEST_OUTPUTS (default: text)
|
||||
Output format specs in the format "<format>[:<path>]". Not specifying
|
||||
a path will default to stdout. Available formats: text, json.
|
||||
|
||||
--parameter string-array, $CODER_SCALETEST_PARAMETERS
|
||||
Parameters to use for each workspace. Can be specified multiple times.
|
||||
Overrides any existing parameters with the same name from
|
||||
--parameters-file. Format: key=value.
|
||||
|
||||
--parameters-file string, $CODER_SCALETEST_PARAMETERS_FILE
|
||||
Path to a YAML file containing the parameters to use for each
|
||||
workspace.
|
||||
|
||||
--run-command string, $CODER_SCALETEST_RUN_COMMAND
|
||||
Command to run inside each workspace using reconnecting-pty (i.e. web
|
||||
terminal protocol). If not specified, no command will be run.
|
||||
|
||||
--run-expect-output string, $CODER_SCALETEST_RUN_EXPECT_OUTPUT
|
||||
Expect the command to output the given string (on a single line). If
|
||||
the command does not output the given string, it will be marked as
|
||||
failed.
|
||||
|
||||
--run-expect-timeout bool, $CODER_SCALETEST_RUN_EXPECT_TIMEOUT
|
||||
Expect the command to timeout. If the command does not finish within
|
||||
the given --run-timeout, it will be marked as succeeded. If the
|
||||
command finishes before the timeout, it will be marked as failed.
|
||||
|
||||
--run-log-output bool, $CODER_SCALETEST_RUN_LOG_OUTPUT
|
||||
Log the output of the command to the test logs. This should be left
|
||||
off unless you expect small amounts of output. Large amounts of output
|
||||
will cause high memory usage.
|
||||
|
||||
--run-timeout duration, $CODER_SCALETEST_RUN_TIMEOUT (default: 5s)
|
||||
Timeout for the command to complete.
|
||||
|
||||
-t, --template string, $CODER_SCALETEST_TEMPLATE
|
||||
Required: Name or ID of the template to use for workspaces.
|
||||
|
||||
--timeout duration, $CODER_SCALETEST_TIMEOUT (default: 30m)
|
||||
Timeout for the entire test run. 0 means unlimited.
|
||||
|
||||
--trace bool, $CODER_SCALETEST_TRACE
|
||||
Whether application tracing data is collected. It exports to a backend
|
||||
configured by environment variables. See:
|
||||
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
|
||||
|
||||
--trace-coder bool, $CODER_SCALETEST_TRACE_CODER
|
||||
Whether opentelemetry traces are sent to Coder. We recommend keeping
|
||||
this disabled unless we advise you to enable it.
|
||||
|
||||
--trace-honeycomb-api-key string, $CODER_SCALETEST_TRACE_HONEYCOMB_API_KEY
|
||||
Enables trace exporting to Honeycomb.io using the provided API key.
|
||||
|
||||
--trace-propagate bool, $CODER_SCALETEST_TRACE_PROPAGATE
|
||||
Enables trace propagation to the Coder backend, which will be used to
|
||||
correlate server-side spans with client-side spans. Only enable this
|
||||
if the server is configured with the exact same tracing configuration
|
||||
as the client.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+10
-31
@@ -1,34 +1,13 @@
|
||||
Usage: coder schedule { show | start | stop | override } <workspace>
|
||||
|
||||
Schedule automated start and stop times for workspaces
|
||||
|
||||
Usage:
|
||||
coder schedule { show | start | stop | override } <workspace> [flags]
|
||||
[1mSubcommands[0m
|
||||
override-stop Override the stop time of a currently running workspace
|
||||
instance.
|
||||
show Show workspace schedule
|
||||
start Edit workspace start schedule
|
||||
stop Edit workspace stop schedule
|
||||
|
||||
coder schedule [command]
|
||||
|
||||
Commands:
|
||||
override-stop Edit stop time of active workspace
|
||||
show Show workspace schedule
|
||||
start Edit workspace start schedule
|
||||
stop Edit workspace stop schedule
|
||||
|
||||
Flags:
|
||||
-h, --help help for schedule
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder schedule [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-25
@@ -1,30 +1,12 @@
|
||||
Usage: coder schedule override-stop <workspace-name> <duration from now>
|
||||
|
||||
Override the stop time of a currently running workspace instance.
|
||||
* The new stop time is calculated from *now*.
|
||||
|
||||
* The new stop time is calculated from *now*.
|
||||
* The new stop time must be at least 30 minutes in the future.
|
||||
* The workspace template may restrict the maximum workspace runtime.
|
||||
|
||||
Usage:
|
||||
coder schedule override-stop <workspace-name> <duration from now> [flags]
|
||||
[;m$ coder schedule override-stop my-workspace 90m[0m
|
||||
|
||||
Get Started:
|
||||
[;m$ coder schedule override-stop my-workspace 90m[0m
|
||||
|
||||
Flags:
|
||||
-h, --help help for override-stop
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+6
-22
@@ -1,28 +1,12 @@
|
||||
Usage: coder schedule show <workspace-name>
|
||||
|
||||
Show workspace schedule
|
||||
|
||||
Shows the following information for the given workspace:
|
||||
* The automatic start schedule
|
||||
* The next scheduled start time
|
||||
* The duration after which it will stop
|
||||
* The next scheduled stop time
|
||||
|
||||
Usage:
|
||||
coder schedule show <workspace-name> [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for show
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-24
@@ -1,3 +1,7 @@
|
||||
Usage: coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual }
|
||||
|
||||
Edit workspace start schedule
|
||||
|
||||
Schedules a workspace to regularly start at a specific time.
|
||||
Schedule format: <start-time> [day-of-week] [location].
|
||||
* Start-time (required) is accepted either in 12-hour (hh:mm{am|pm}) format, or 24-hour format hh:mm.
|
||||
@@ -8,30 +12,9 @@ Schedule format: <start-time> [day-of-week] [location].
|
||||
If omitted, we will fall back to either the TZ environment variable or /etc/localtime.
|
||||
You can check your corresponding location by visiting https://ipinfo.io - it shows in the demo widget on the right.
|
||||
|
||||
Usage:
|
||||
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual } [flags]
|
||||
|
||||
Get Started:
|
||||
- Set the workspace to start at 9:30am (in Dublin) from Monday to Friday:
|
||||
|
||||
[;m$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin[0m
|
||||
[;m$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin[0m
|
||||
|
||||
Flags:
|
||||
-h, --help help for start
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-24
@@ -1,3 +1,7 @@
|
||||
Usage: coder schedule stop <workspace-name> { <duration> | manual }
|
||||
|
||||
Edit workspace stop schedule
|
||||
|
||||
Schedules a workspace to stop after a given duration has elapsed.
|
||||
* Workspace runtime is measured from the time that the workspace build completed.
|
||||
* The minimum scheduled stop time is 1 minute.
|
||||
@@ -11,28 +15,7 @@ When enabling scheduled stop, enter a duration in one of the following formats:
|
||||
* 2m (2 minutes)
|
||||
* 2 (2 minutes)
|
||||
|
||||
Usage:
|
||||
coder schedule stop <workspace-name> { <duration> | manual } [flags]
|
||||
[;m$ coder schedule stop my-workspace 2h30m[0m
|
||||
|
||||
Get Started:
|
||||
[;m$ coder schedule stop my-workspace 2h30m[0m
|
||||
|
||||
Flags:
|
||||
-h, --help help for stop
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+365
@@ -0,0 +1,365 @@
|
||||
Usage: coder server [flags]
|
||||
|
||||
Start a Coder server
|
||||
|
||||
[1mSubcommands[0m
|
||||
create-admin-user Create a new admin user with the given username,
|
||||
email and password and adds it to every
|
||||
organization.
|
||||
postgres-builtin-serve Run the built-in PostgreSQL deployment.
|
||||
postgres-builtin-url Output the connection URL for the built-in
|
||||
PostgreSQL deployment.
|
||||
|
||||
[1mOptions[0m
|
||||
--cache-dir string, $CODER_CACHE_DIRECTORY (default: [cache dir])
|
||||
The directory to cache temporary files. If unspecified and
|
||||
$CACHE_DIRECTORY is set, it will be used for compatibility with
|
||||
systemd.
|
||||
|
||||
--disable-path-apps bool, $CODER_DISABLE_PATH_APPS
|
||||
Disable workspace apps that are not served from subdomains. Path-based
|
||||
apps can make requests to the Coder API and pose a security risk when
|
||||
the workspace serves malicious JavaScript. This is recommended for
|
||||
security purposes if a --wildcard-access-url is configured.
|
||||
|
||||
--swagger-enable bool, $CODER_SWAGGER_ENABLE
|
||||
Expose the swagger endpoint via /swagger.
|
||||
|
||||
--experiments string-array, $CODER_EXPERIMENTS
|
||||
Enable one or more experiments. These are not ready for production.
|
||||
Separate multiple experiments with commas, or enter '*' to opt-in to
|
||||
all available experiments.
|
||||
|
||||
--postgres-url string, $CODER_PG_CONNECTION_URL
|
||||
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
|
||||
downloaded from Maven (https://repo1.maven.org/maven2) and store all
|
||||
data in the config root. Access the built-in database with "coder
|
||||
server postgres-builtin-url".
|
||||
|
||||
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
|
||||
The algorithm to use for generating ssh keys. Accepted values are
|
||||
"ed25519", "ecdsa", or "rsa4096".
|
||||
|
||||
--update-check bool, $CODER_UPDATE_CHECK (default: false)
|
||||
Periodically check for new releases of Coder and inform the owner. The
|
||||
check is performed once per day.
|
||||
|
||||
[1mClient Options[0m
|
||||
These options change the behavior of how clients interact with the Coder.
|
||||
Clients include the coder cli, vs code extension, and the web UI.
|
||||
|
||||
--ssh-config-options string-array, $CODER_SSH_CONFIG_OPTIONS
|
||||
These SSH config options will override the default SSH config options.
|
||||
Provide options in "key=value" or "key value" format separated by
|
||||
commas.Using this incorrectly can break SSH to your deployment, use
|
||||
cautiously.
|
||||
|
||||
--ssh-hostname-prefix string, $CODER_SSH_HOSTNAME_PREFIX (default: coder.)
|
||||
The SSH deployment prefix is used in the Host of the ssh config.
|
||||
|
||||
[1mIntrospection / Logging Options[0m
|
||||
--log-human string, $CODER_LOGGING_HUMAN (default: /dev/stderr)
|
||||
Output human-readable logs to a given file.
|
||||
|
||||
--log-json string, $CODER_LOGGING_JSON
|
||||
Output JSON logs to a given file.
|
||||
|
||||
--log-stackdriver string, $CODER_LOGGING_STACKDRIVER
|
||||
Output Stackdriver compatible logs to a given file.
|
||||
|
||||
-v, --verbose bool, $CODER_VERBOSE
|
||||
Output debug-level logs.
|
||||
|
||||
[1mIntrospection / Prometheus Options[0m
|
||||
--prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
|
||||
The bind address to serve prometheus metrics.
|
||||
|
||||
--prometheus-enable bool, $CODER_PROMETHEUS_ENABLE
|
||||
Serve prometheus metrics on the address defined by prometheus address.
|
||||
|
||||
[1mIntrospection / Tracing Options[0m
|
||||
--trace-logs bool, $CODER_TRACE_LOGS
|
||||
Enables capturing of logs as events in traces. This is useful for
|
||||
debugging, but may result in a very large amount of events being sent
|
||||
to the tracing backend which may incur significant costs. If the
|
||||
verbose flag was supplied, debug-level logs will be included.
|
||||
|
||||
--trace bool, $CODER_TRACE_ENABLE
|
||||
Whether application tracing data is collected. It exports to a backend
|
||||
configured by environment variables. See:
|
||||
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
|
||||
|
||||
--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
|
||||
Enables trace exporting to Honeycomb.io using the provided API Key.
|
||||
|
||||
[1mIntrospection / pprof Options[0m
|
||||
--pprof-address host:port, $CODER_PPROF_ADDRESS (default: 127.0.0.1:6060)
|
||||
The bind address to serve pprof.
|
||||
|
||||
--pprof-enable bool, $CODER_PPROF_ENABLE
|
||||
Serve pprof metrics on the address defined by pprof address.
|
||||
|
||||
[1mNetworking Options[0m
|
||||
--access-url url, $CODER_ACCESS_URL
|
||||
The URL that users will use to access the Coder deployment.
|
||||
|
||||
--proxy-trusted-headers string-array, $CODER_PROXY_TRUSTED_HEADERS
|
||||
Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
|
||||
True-Client-Ip, X-Forwarded-For.
|
||||
|
||||
--proxy-trusted-origins string-array, $CODER_PROXY_TRUSTED_ORIGINS
|
||||
Origin addresses to respect "proxy-trusted-headers". e.g.
|
||||
192.168.1.0/24.
|
||||
|
||||
--redirect-to-access-url bool, $CODER_REDIRECT_TO_ACCESS_URL
|
||||
Specifies whether to redirect requests that do not match the access
|
||||
URL host.
|
||||
|
||||
--secure-auth-cookie bool, $CODER_SECURE_AUTH_COOKIE
|
||||
Controls if the 'Secure' property is set on browser session cookies.
|
||||
|
||||
--wildcard-access-url url, $CODER_WILDCARD_ACCESS_URL
|
||||
Specifies the wildcard hostname to use for workspace applications in
|
||||
the form "*.example.com".
|
||||
|
||||
[1mNetworking / DERP Options[0m
|
||||
Most Coder deployments never have to think about DERP because all connections
|
||||
between workspaces and users are peer-to-peer. However, when Coder cannot
|
||||
establish a peer to peer connection, Coder uses a distributed relay network
|
||||
backed by Tailscale and WireGuard.
|
||||
|
||||
--derp-config-path string, $CODER_DERP_CONFIG_PATH
|
||||
Path to read a DERP mapping from. See:
|
||||
https://tailscale.com/kb/1118/custom-derp-servers/.
|
||||
|
||||
--derp-config-url string, $CODER_DERP_CONFIG_URL
|
||||
URL to fetch a DERP mapping on startup. See:
|
||||
https://tailscale.com/kb/1118/custom-derp-servers/.
|
||||
|
||||
--derp-server-enable bool, $CODER_DERP_SERVER_ENABLE (default: true)
|
||||
Whether to enable or disable the embedded DERP relay server.
|
||||
|
||||
--derp-server-region-code string, $CODER_DERP_SERVER_REGION_CODE (default: coder)
|
||||
Region code to use for the embedded DERP server.
|
||||
|
||||
--derp-server-region-id int, $CODER_DERP_SERVER_REGION_ID (default: 999)
|
||||
Region ID to use for the embedded DERP server.
|
||||
|
||||
--derp-server-region-name string, $CODER_DERP_SERVER_REGION_NAME (default: Coder Embedded Relay)
|
||||
Region name that for the embedded DERP server.
|
||||
|
||||
--derp-server-stun-addresses string-array, $CODER_DERP_SERVER_STUN_ADDRESSES (default: stun.l.google.com:19302)
|
||||
Addresses for STUN servers to establish P2P connections. Set empty to
|
||||
disable P2P connections.
|
||||
|
||||
[1mNetworking / HTTP Options[0m
|
||||
--disable-password-auth bool, $CODER_DISABLE_PASSWORD_AUTH
|
||||
Disable password authentication. This is recommended for security
|
||||
purposes in production deployments that rely on an identity provider.
|
||||
Any user with the owner role will be able to sign in with their
|
||||
password regardless of this setting to avoid potential lock out. If
|
||||
you are locked out of your account, you can use the `coder server
|
||||
create-admin` command to create a new admin user directly in the
|
||||
database.
|
||||
|
||||
--disable-session-expiry-refresh bool, $CODER_DISABLE_SESSION_EXPIRY_REFRESH
|
||||
Disable automatic session expiry bumping due to activity. This forces
|
||||
all sessions to become invalid after the session expiry duration has
|
||||
been reached.
|
||||
|
||||
--http-address string, $CODER_HTTP_ADDRESS (default: 127.0.0.1:3000)
|
||||
HTTP bind address of the server. Unset to disable the HTTP endpoint.
|
||||
|
||||
--max-token-lifetime duration, $CODER_MAX_TOKEN_LIFETIME (default: 2562047h47m16.854775807s)
|
||||
The maximum lifetime duration users can specify when creating an API
|
||||
token.
|
||||
|
||||
--session-duration duration, $CODER_SESSION_DURATION (default: 24h0m0s)
|
||||
The token expiry duration for browser sessions. Sessions may last
|
||||
longer if they are actively making requests, but this functionality
|
||||
can be disabled via --disable-session-expiry-refresh.
|
||||
|
||||
[1mNetworking / TLS Options[0m
|
||||
Configure TLS / HTTPS for your Coder deployment. If you're running Coder behind
|
||||
a TLS-terminating reverse proxy or are accessing Coder over a secure link, you
|
||||
can safely ignore these settings.
|
||||
|
||||
--strict-transport-security int, $CODER_STRICT_TRANSPORT_SECURITY (default: 0)
|
||||
Controls if the 'Strict-Transport-Security' header is set on all
|
||||
static file responses. This header should only be set if the server is
|
||||
accessed via HTTPS. This value is the MaxAge in seconds of the header.
|
||||
|
||||
--strict-transport-security-options string-array, $CODER_STRICT_TRANSPORT_SECURITY_OPTIONS
|
||||
Two optional fields can be set in the Strict-Transport-Security
|
||||
header; 'includeSubDomains' and 'preload'. The
|
||||
'strict-transport-security' flag must be set to a non-zero value for
|
||||
these options to be used.
|
||||
|
||||
--tls-address host:port, $CODER_TLS_ADDRESS (default: 127.0.0.1:3443)
|
||||
HTTPS bind address of the server.
|
||||
|
||||
--tls-cert-file string-array, $CODER_TLS_CERT_FILE
|
||||
Path to each certificate for TLS. It requires a PEM-encoded file. To
|
||||
configure the listener to use a CA certificate, concatenate the
|
||||
primary certificate and the CA certificate together. The primary
|
||||
certificate should appear first in the combined file.
|
||||
|
||||
--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
|
||||
Policy the server will follow for TLS Client Authentication. Accepted
|
||||
values are "none", "request", "require-any", "verify-if-given", or
|
||||
"require-and-verify".
|
||||
|
||||
--tls-client-ca-file string, $CODER_TLS_CLIENT_CA_FILE
|
||||
PEM-encoded Certificate Authority file used for checking the
|
||||
authenticity of client.
|
||||
|
||||
--tls-client-cert-file string, $CODER_TLS_CLIENT_CERT_FILE
|
||||
Path to certificate for client TLS authentication. It requires a
|
||||
PEM-encoded file.
|
||||
|
||||
--tls-client-key-file string, $CODER_TLS_CLIENT_KEY_FILE
|
||||
Path to key for client TLS authentication. It requires a PEM-encoded
|
||||
file.
|
||||
|
||||
--tls-enable bool, $CODER_TLS_ENABLE
|
||||
Whether TLS will be enabled.
|
||||
|
||||
--tls-key-file string-array, $CODER_TLS_KEY_FILE
|
||||
Paths to the private keys for each of the certificates. It requires a
|
||||
PEM-encoded file.
|
||||
|
||||
--tls-min-version string, $CODER_TLS_MIN_VERSION (default: tls12)
|
||||
Minimum supported version of TLS. Accepted values are "tls10",
|
||||
"tls11", "tls12" or "tls13".
|
||||
|
||||
[1mOAuth2 / GitHub Options[0m
|
||||
--oauth2-github-allow-everyone bool, $CODER_OAUTH2_GITHUB_ALLOW_EVERYONE
|
||||
Allow all logins, setting this option means allowed orgs and teams
|
||||
must be empty.
|
||||
|
||||
--oauth2-github-allow-signups bool, $CODER_OAUTH2_GITHUB_ALLOW_SIGNUPS
|
||||
Whether new users can sign up with GitHub.
|
||||
|
||||
--oauth2-github-allowed-orgs string-array, $CODER_OAUTH2_GITHUB_ALLOWED_ORGS
|
||||
Organizations the user must be a member of to Login with GitHub.
|
||||
|
||||
--oauth2-github-allowed-teams string-array, $CODER_OAUTH2_GITHUB_ALLOWED_TEAMS
|
||||
Teams inside organizations the user must be a member of to Login with
|
||||
GitHub. Structured as: <organization-name>/<team-slug>.
|
||||
|
||||
--oauth2-github-client-id string, $CODER_OAUTH2_GITHUB_CLIENT_ID
|
||||
Client ID for Login with GitHub.
|
||||
|
||||
--oauth2-github-client-secret string, $CODER_OAUTH2_GITHUB_CLIENT_SECRET
|
||||
Client secret for Login with GitHub.
|
||||
|
||||
--oauth2-github-enterprise-base-url string, $CODER_OAUTH2_GITHUB_ENTERPRISE_BASE_URL
|
||||
Base URL of a GitHub Enterprise deployment to use for Login with
|
||||
GitHub.
|
||||
|
||||
[1mOIDC Options[0m
|
||||
--oidc-allow-signups bool, $CODER_OIDC_ALLOW_SIGNUPS (default: true)
|
||||
Whether new users can sign up with OIDC.
|
||||
|
||||
--oidc-client-id string, $CODER_OIDC_CLIENT_ID
|
||||
Client ID to use for Login with OIDC.
|
||||
|
||||
--oidc-client-secret string, $CODER_OIDC_CLIENT_SECRET
|
||||
Client secret to use for Login with OIDC.
|
||||
|
||||
--oidc-email-domain string-array, $CODER_OIDC_EMAIL_DOMAIN
|
||||
Email domains that clients logging in with OIDC must match.
|
||||
|
||||
--oidc-group-field string, $CODER_OIDC_GROUP_FIELD
|
||||
Change the OIDC default 'groups' claim field. By default, will be
|
||||
'groups' if present in the oidc scopes argument.
|
||||
|
||||
--oidc-group-mapping struct[map[string]string], $OIDC_GROUP_MAPPING (default: {})
|
||||
A map of OIDC group IDs and the group in Coder it should map to. This
|
||||
is useful for when OIDC providers only return group IDs.
|
||||
|
||||
--oidc-ignore-email-verified bool, $CODER_OIDC_IGNORE_EMAIL_VERIFIED
|
||||
Ignore the email_verified claim from the upstream provider.
|
||||
|
||||
--oidc-issuer-url string, $CODER_OIDC_ISSUER_URL
|
||||
Issuer URL to use for Login with OIDC.
|
||||
|
||||
--oidc-scopes string-array, $CODER_OIDC_SCOPES (default: openid,profile,email)
|
||||
Scopes to grant when authenticating with OIDC.
|
||||
|
||||
--oidc-username-field string, $CODER_OIDC_USERNAME_FIELD (default: preferred_username)
|
||||
OIDC claim field to use as the username.
|
||||
|
||||
--oidc-sign-in-text string, $CODER_OIDC_SIGN_IN_TEXT (default: OpenID Connect)
|
||||
The text to show on the OpenID Connect sign in button.
|
||||
|
||||
--oidc-icon-url url, $CODER_OIDC_ICON_URL
|
||||
URL pointing to the icon to use on the OepnID Connect login button.
|
||||
|
||||
[1mProvisioning Options[0m
|
||||
Tune the behavior of the provisioner, which is responsible for creating,
|
||||
updating, and deleting workspace resources.
|
||||
|
||||
--provisioner-force-cancel-interval duration, $CODER_PROVISIONER_FORCE_CANCEL_INTERVAL (default: 10m0s)
|
||||
Time to force cancel provisioning tasks that are stuck.
|
||||
|
||||
--provisioner-daemon-poll-interval duration, $CODER_PROVISIONER_DAEMON_POLL_INTERVAL (default: 1s)
|
||||
Time to wait before polling for a new job.
|
||||
|
||||
--provisioner-daemon-poll-jitter duration, $CODER_PROVISIONER_DAEMON_POLL_JITTER (default: 100ms)
|
||||
Random jitter added to the poll interval.
|
||||
|
||||
--provisioner-daemons int, $CODER_PROVISIONER_DAEMONS (default: 3)
|
||||
Number of provisioner daemons to create on start. If builds are stuck
|
||||
in queued state for a long time, consider increasing this.
|
||||
|
||||
[1mTelemetry Options[0m
|
||||
Telemetry is critical to our ability to improve Coder. We strip all
|
||||
personalinformation before sending data to our servers. Please only disable
|
||||
telemetrywhen required by your organization's security policy.
|
||||
|
||||
--telemetry bool, $CODER_TELEMETRY_ENABLE (default: false)
|
||||
Whether telemetry is enabled or not. Coder collects anonymized usage
|
||||
data to help improve our product.
|
||||
|
||||
--telemetry-trace bool, $CODER_TELEMETRY_TRACE (default: false)
|
||||
Whether Opentelemetry traces are sent to Coder. Coder collects
|
||||
anonymized application tracing to help improve our product. Disabling
|
||||
telemetry also disables this option.
|
||||
|
||||
[1m⚠️ Dangerous Options[0m
|
||||
--dangerous-allow-path-app-sharing bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SHARING
|
||||
Allow workspace apps that are not served from subdomains to be shared.
|
||||
Path-based app sharing is DISABLED by default for security purposes.
|
||||
Path-based apps can make requests to the Coder API and pose a security
|
||||
risk when the workspace serves malicious JavaScript. Path-based apps
|
||||
can be disabled entirely with --disable-path-apps for further
|
||||
security.
|
||||
|
||||
--dangerous-allow-path-app-site-owner-access bool, $CODER_DANGEROUS_ALLOW_PATH_APP_SITE_OWNER_ACCESS
|
||||
Allow site-owners to access workspace apps from workspaces they do not
|
||||
own. Owners cannot access path-based apps they do not own by default.
|
||||
Path-based apps can make requests to the Coder API and pose a security
|
||||
risk when the workspace serves malicious JavaScript. Path-based apps
|
||||
can be disabled entirely with --disable-path-apps for further
|
||||
security.
|
||||
|
||||
[1mEnterprise Options[0m
|
||||
These options are only available in the Enterprise Edition.
|
||||
|
||||
--audit-logging bool, $CODER_AUDIT_LOGGING (default: true)
|
||||
Specifies whether audit logging is enabled.
|
||||
|
||||
--browser-only bool, $CODER_BROWSER_ONLY
|
||||
Whether Coder only allows connections to workspaces via the browser.
|
||||
|
||||
--derp-server-relay-url url, $CODER_DERP_SERVER_RELAY_URL
|
||||
An HTTP URL that is accessible by other replicas to relay DERP
|
||||
traffic. Required for high availability.
|
||||
|
||||
--scim-auth-header string, $CODER_SCIM_AUTH_HEADER
|
||||
Enables SCIM and sets the authentication header for the built-in SCIM
|
||||
server. New users are automatically created with OIDC authentication.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
@@ -0,0 +1,32 @@
|
||||
Usage: coder server create-admin-user [flags]
|
||||
|
||||
Create a new admin user with the given username, email and password and adds it
|
||||
to every organization.
|
||||
|
||||
[1mOptions[0m
|
||||
--email string, $CODER_EMAIL
|
||||
The email of the new user. If not specified, you will be prompted via
|
||||
stdin.
|
||||
|
||||
--password string, $CODER_PASSWORD
|
||||
The password of the new user. If not specified, you will be prompted
|
||||
via stdin.
|
||||
|
||||
--postgres-url string, $CODER_POSTGRES_URL
|
||||
URL of a PostgreSQL database. If empty, the built-in PostgreSQL
|
||||
deployment will be used (Coder must not be already running in this
|
||||
case).
|
||||
|
||||
--raw-url bool
|
||||
Output the raw connection URL instead of a psql command.
|
||||
|
||||
--ssh-keygen-algorithm string, $CODER_SSH_KEYGEN_ALGORITHM (default: ed25519)
|
||||
The algorithm to use for generating ssh keys. Accepted values are
|
||||
"ed25519", "ecdsa", or "rsa4096".
|
||||
|
||||
--username string, $CODER_USERNAME
|
||||
The username of the new user. If not specified, you will be prompted
|
||||
via stdin.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
Usage: coder server postgres-builtin-serve [flags]
|
||||
|
||||
Run the built-in PostgreSQL deployment.
|
||||
|
||||
[1mOptions[0m
|
||||
--raw-url bool
|
||||
Output the raw connection URL instead of a psql command.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
Usage: coder server postgres-builtin-url [flags]
|
||||
|
||||
Output the connection URL for the built-in PostgreSQL deployment.
|
||||
|
||||
[1mOptions[0m
|
||||
--raw-url bool
|
||||
Output the raw connection URL instead of a psql command.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+4
-22
@@ -1,24 +1,6 @@
|
||||
Usage: coder show <workspace>
|
||||
|
||||
Display details of a workspace's resources and agents
|
||||
|
||||
Usage:
|
||||
coder show <workspace> [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for show
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+14
-24
@@ -1,28 +1,18 @@
|
||||
Usage: coder speedtest [flags] <workspace>
|
||||
|
||||
Run upload and download tests from your machine to a workspace
|
||||
|
||||
Usage:
|
||||
coder speedtest <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-d, --direct bool
|
||||
Specifies whether to wait for a direct connection before testing
|
||||
speed.
|
||||
|
||||
Flags:
|
||||
-d, --direct Specifies whether to wait for a direct connection before testing speed.
|
||||
--direction string Specifies whether to run in reverse mode where the client receives
|
||||
and the server sends. (up|down) (default "down")
|
||||
-h, --help help for speedtest
|
||||
-t, --time duration Specifies the duration to monitor traffic. (default 5s)
|
||||
--direction up|down (default: down)
|
||||
Specifies whether to run in reverse mode where the client receives and
|
||||
the server sends.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-t, --time duration (default: 5s)
|
||||
Specifies the duration to monitor traffic.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
Vendored
+31
-48
@@ -1,52 +1,35 @@
|
||||
Usage: coder ssh [flags] <workspace>
|
||||
|
||||
Start a shell into a workspace
|
||||
|
||||
Usage:
|
||||
coder ssh <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-A, --forward-agent bool, $CODER_SSH_FORWARD_AGENT
|
||||
Specifies whether to forward the SSH agent specified in
|
||||
$SSH_AUTH_SOCK.
|
||||
|
||||
Flags:
|
||||
-A, --forward-agent Specifies whether to forward the SSH agent
|
||||
specified in $SSH_AUTH_SOCK.
|
||||
Consumes $CODER_SSH_FORWARD_AGENT
|
||||
-G, --forward-gpg 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.
|
||||
Consumes $CODER_SSH_FORWARD_GPG
|
||||
-h, --help help for ssh
|
||||
--identity-agent string Specifies which identity agent to use (overrides
|
||||
$SSH_AUTH_SOCK), forward agent must also be
|
||||
enabled.
|
||||
Consumes $CODER_SSH_IDENTITY_AGENT
|
||||
--no-wait Specifies whether to wait for a workspace to become
|
||||
ready before logging in (only applicable when the
|
||||
login before ready option has not been enabled).
|
||||
Note that the workspace agent may still be in the
|
||||
process of executing the startup script and the
|
||||
workspace may be in an incomplete state.
|
||||
Consumes $CODER_SSH_NO_WAIT
|
||||
--stdio Specifies whether to emit SSH output over
|
||||
stdin/stdout.
|
||||
Consumes $CODER_SSH_STDIO
|
||||
--workspace-poll-interval duration Specifies how often to poll for workspace automated
|
||||
shutdown.
|
||||
Consumes $CODER_WORKSPACE_POLL_INTERVAL (default 1m0s)
|
||||
-G, --forward-gpg bool, $CODER_SSH_FORWARD_GPG
|
||||
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.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--identity-agent string, $CODER_SSH_IDENTITY_AGENT
|
||||
Specifies which identity agent to use (overrides $SSH_AUTH_SOCK),
|
||||
forward agent must also be enabled.
|
||||
|
||||
--no-wait bool, $CODER_SSH_NO_WAIT
|
||||
Specifies whether to wait for a workspace to become ready before
|
||||
logging in (only applicable when the login before ready option has not
|
||||
been enabled). Note that the workspace agent may still be in the
|
||||
process of executing the startup script and the workspace may be in an
|
||||
incomplete state.
|
||||
|
||||
--stdio bool, $CODER_SSH_STDIO
|
||||
Specifies whether to emit SSH output over stdin/stdout.
|
||||
|
||||
--workspace-poll-interval duration, $CODER_WORKSPACE_POLL_INTERVAL (default: 1m)
|
||||
Specifies how often to poll for workspace automated shutdown.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder start [flags] <workspace>
|
||||
|
||||
Start a workspace
|
||||
|
||||
Usage:
|
||||
coder start <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Flags:
|
||||
-h, --help help for start
|
||||
-y, --yes Bypass prompts
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-29
@@ -1,32 +1,10 @@
|
||||
Usage: coder state
|
||||
|
||||
Manually manage Terraform state to fix broken workspaces
|
||||
|
||||
Usage:
|
||||
coder state [flags]
|
||||
[1mSubcommands[0m
|
||||
pull Pull a Terraform state file from a workspace.
|
||||
push Push a Terraform state file to a workspace.
|
||||
|
||||
coder state [command]
|
||||
|
||||
Commands:
|
||||
pull Pull a Terraform state file from a workspace.
|
||||
push Push a Terraform state file to a workspace.
|
||||
|
||||
Flags:
|
||||
-h, --help help for state
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder state [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder state pull [flags] <workspace> [file]
|
||||
|
||||
Pull a Terraform state file from a workspace.
|
||||
|
||||
Usage:
|
||||
coder state pull <workspace> [file] [flags]
|
||||
[1mOptions[0m
|
||||
-b, --build int
|
||||
Specify a workspace build to target by name. Defaults to latest.
|
||||
|
||||
Flags:
|
||||
-b, --build int Specify a workspace build to target by name.
|
||||
-h, --help help for pull
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder state push [flags] <workspace> <file>
|
||||
|
||||
Push a Terraform state file to a workspace.
|
||||
|
||||
Usage:
|
||||
coder state push <workspace> <file> [flags]
|
||||
[1mOptions[0m
|
||||
-b, --build int
|
||||
Specify a workspace build to target by name. Defaults to latest.
|
||||
|
||||
Flags:
|
||||
-b, --build int Specify a workspace build to target by name.
|
||||
-h, --help help for push
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+7
-22
@@ -1,25 +1,10 @@
|
||||
Usage: coder stop [flags] <workspace>
|
||||
|
||||
Stop a workspace
|
||||
|
||||
Usage:
|
||||
coder stop <workspace> [flags]
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Flags:
|
||||
-h, --help help for stop
|
||||
-y, --yes Bypass prompts
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+21
-41
@@ -1,14 +1,10 @@
|
||||
Usage: coder templates
|
||||
|
||||
Manage templates
|
||||
|
||||
Aliases: template
|
||||
|
||||
Templates are written in standard Terraform and describe the infrastructure for workspaces
|
||||
|
||||
Usage:
|
||||
coder templates [flags]
|
||||
|
||||
coder templates [command]
|
||||
|
||||
Aliases:
|
||||
templates, template
|
||||
|
||||
Get Started:
|
||||
- Create a template for developers to create workspaces:
|
||||
|
||||
[;m$ coder templates create[0m
|
||||
@@ -19,36 +15,20 @@ Get Started:
|
||||
|
||||
- Push an update to the template. Your developers can update their workspaces:
|
||||
|
||||
[;m$ coder templates push my-template[0m
|
||||
[;m$ coder templates push my-template[0m
|
||||
|
||||
Commands:
|
||||
create Create a template from the current directory or as specified by flag
|
||||
delete Delete templates
|
||||
edit Edit the metadata of a template by name.
|
||||
init Get started with a templated template.
|
||||
list List all the templates available for the organization
|
||||
pull Download the latest version of a template to a path.
|
||||
push Push a new template version from the current directory or as specified by flag
|
||||
versions Manage different versions of the specified template
|
||||
[1mSubcommands[0m
|
||||
create Create a template from the current directory or as specified by
|
||||
flag
|
||||
delete Delete templates
|
||||
edit Edit the metadata of a template by name.
|
||||
init Get started with a templated template.
|
||||
list List all the templates available for the organization
|
||||
plan Plan a template push from the current directory
|
||||
pull Download the latest version of a template to a path.
|
||||
push Push a new template version from the current directory or as
|
||||
specified by flag
|
||||
versions Manage different versions of the specified template
|
||||
|
||||
Flags:
|
||||
-h, --help help for templates
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder templates [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+24
-30
@@ -1,34 +1,28 @@
|
||||
Usage: coder templates create [flags] [name]
|
||||
|
||||
Create a template from the current directory or as specified by flag
|
||||
|
||||
Usage:
|
||||
coder templates create [name] [flags]
|
||||
[1mOptions[0m
|
||||
--default-ttl duration (default: 24h)
|
||||
Specify a default TTL for workspaces created from this template.
|
||||
|
||||
Flags:
|
||||
--default-ttl duration Specify a default TTL for workspaces created from this
|
||||
template. (default 24h0m0s)
|
||||
-d, --directory string Specify the directory to create from, use '-' to read
|
||||
tar from stdin (default "[current directory]")
|
||||
-h, --help help for create
|
||||
--parameter-file string Specify a file path with parameter values.
|
||||
--provisioner-tag stringArray Specify a set of tags to target provisioner daemons.
|
||||
--variable stringArray Specify a set of values for Terraform-managed variables.
|
||||
--variables-file string Specify a file path with values for Terraform-managed
|
||||
variables.
|
||||
-y, --yes Bypass prompts
|
||||
-d, --directory string (default: .)
|
||||
Specify the directory to create from, use '-' to read tar from stdin.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--parameter-file string
|
||||
Specify a file path with parameter values.
|
||||
|
||||
--provisioner-tag string-array
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
--variable string-array
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
--variables-file string
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+8
-21
@@ -1,25 +1,12 @@
|
||||
Usage: coder templates delete [flags] [name...]
|
||||
|
||||
Delete templates
|
||||
|
||||
Usage:
|
||||
coder templates delete [name...] [flags]
|
||||
Aliases: rm
|
||||
|
||||
Flags:
|
||||
-h, --help help for delete
|
||||
-y, --yes Bypass prompts
|
||||
[1mOptions[0m
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+30
-34
@@ -1,38 +1,34 @@
|
||||
Usage: coder templates edit [flags] <template>
|
||||
|
||||
Edit the metadata of a template by name.
|
||||
|
||||
Usage:
|
||||
coder templates edit <template> [flags]
|
||||
[1mOptions[0m
|
||||
--allow-user-cancel-workspace-jobs bool (default: true)
|
||||
Allow users to cancel in-progress workspace jobs.
|
||||
|
||||
Flags:
|
||||
--allow-user-cancel-workspace-jobs Allow users to cancel in-progress workspace jobs.
|
||||
(default true)
|
||||
--default-ttl duration Edit the template default time before shutdown -
|
||||
workspaces created from this template default to
|
||||
this value.
|
||||
--description string Edit the template description.
|
||||
--display-name string Edit the template display name.
|
||||
-h, --help help for edit
|
||||
--icon string Edit the template icon path.
|
||||
--max-ttl duration Edit the template maximum time before shutdown -
|
||||
workspaces created from this template must shutdown
|
||||
within the given duration after starting. This is
|
||||
an enterprise-only feature.
|
||||
--name string Edit the template name.
|
||||
-y, --yes Bypass prompts
|
||||
--default-ttl duration
|
||||
Edit the template default time before shutdown - workspaces created
|
||||
from this template default to this value.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--description string
|
||||
Edit the template description.
|
||||
|
||||
--display-name string
|
||||
Edit the template display name.
|
||||
|
||||
--icon string
|
||||
Edit the template icon path.
|
||||
|
||||
--max-ttl duration
|
||||
Edit the template maximum time before shutdown - workspaces created
|
||||
from this template must shutdown within the given duration after
|
||||
starting. This is an enterprise-only feature.
|
||||
|
||||
--name string
|
||||
Edit the template name.
|
||||
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+4
-22
@@ -1,24 +1,6 @@
|
||||
Usage: coder templates init [directory]
|
||||
|
||||
Get started with a templated template.
|
||||
|
||||
Usage:
|
||||
coder templates init [directory] [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for init
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+12
-26
@@ -1,31 +1,17 @@
|
||||
Usage: coder templates list [flags]
|
||||
|
||||
List all the templates available for the organization
|
||||
|
||||
Usage:
|
||||
coder templates list [flags]
|
||||
Aliases: ls
|
||||
|
||||
Aliases:
|
||||
list, ls
|
||||
[1mOptions[0m
|
||||
-c, --column string-array (default: name,last updated,used by)
|
||||
Columns to display in table output. Available columns: name, created
|
||||
at, last updated, organization id, provisioner, active version id,
|
||||
used by, default ttl.
|
||||
|
||||
Flags:
|
||||
-c, --column strings Columns to display in table output. Available columns: name, created
|
||||
at, last updated, organization id, provisioner, active version id,
|
||||
used by, default ttl (default [name,last updated,used by])
|
||||
-h, --help help for list
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+4
-22
@@ -1,24 +1,6 @@
|
||||
Usage: coder templates plan <directory>
|
||||
|
||||
Plan a template push from the current directory
|
||||
|
||||
Usage:
|
||||
coder templates plan <directory> [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for plan
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+9
-22
@@ -1,26 +1,13 @@
|
||||
Usage: coder templates pull [flags] <name> [destination]
|
||||
|
||||
Download the latest version of a template to a path.
|
||||
|
||||
Usage:
|
||||
coder templates pull <name> [destination] [flags]
|
||||
[1mOptions[0m
|
||||
--tar bool
|
||||
Output the template as a tar archive to stdout.
|
||||
|
||||
Flags:
|
||||
-h, --help help for pull
|
||||
--tar output the template as a tar archive to stdout
|
||||
-y, --yes Bypass prompts
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+29
-32
@@ -1,36 +1,33 @@
|
||||
Usage: coder templates push [flags] [template]
|
||||
|
||||
Push a new template version from the current directory or as specified by flag
|
||||
|
||||
Usage:
|
||||
coder templates push [template] [flags]
|
||||
[1mOptions[0m
|
||||
--always-prompt bool
|
||||
Always prompt all parameters. Does not pull parameter values from
|
||||
active template version.
|
||||
|
||||
Flags:
|
||||
--always-prompt Always prompt all parameters. Does not pull parameter
|
||||
values from active template version
|
||||
-d, --directory string Specify the directory to create from, use '-' to read
|
||||
tar from stdin (default "[current directory]")
|
||||
-h, --help help for push
|
||||
--name string Specify a name for the new template version. It will be
|
||||
automatically generated if not provided.
|
||||
--parameter-file string Specify a file path with parameter values.
|
||||
--provisioner-tag stringArray Specify a set of tags to target provisioner daemons.
|
||||
--variable stringArray Specify a set of values for Terraform-managed variables.
|
||||
--variables-file string Specify a file path with values for Terraform-managed
|
||||
variables.
|
||||
-y, --yes Bypass prompts
|
||||
-d, --directory string (default: .)
|
||||
Specify the directory to create from, use '-' to read tar from stdin.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
--name string
|
||||
Specify a name for the new template version. It will be automatically
|
||||
generated if not provided.
|
||||
|
||||
--parameter-file string
|
||||
Specify a file path with parameter values.
|
||||
|
||||
--provisioner-tag string-array
|
||||
Specify a set of tags to target provisioner daemons.
|
||||
|
||||
--variable string-array
|
||||
Specify a set of values for Terraform-managed variables.
|
||||
|
||||
--variables-file string
|
||||
Specify a file path with values for Terraform-managed variables.
|
||||
|
||||
-y, --yes bool
|
||||
Bypass prompts.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+9
-33
@@ -1,39 +1,15 @@
|
||||
Usage: coder templates versions
|
||||
|
||||
Manage different versions of the specified template
|
||||
|
||||
Usage:
|
||||
coder templates versions [flags]
|
||||
Aliases: version
|
||||
|
||||
coder templates versions [command]
|
||||
- List versions of a specific template:
|
||||
|
||||
Aliases:
|
||||
versions, version
|
||||
[;m$ coder templates versions list my-template[0m
|
||||
|
||||
Get Started:
|
||||
- List versions of a specific template:
|
||||
[1mSubcommands[0m
|
||||
list List all the versions of the specified template
|
||||
|
||||
[;m$ coder templates versions list my-template[0m
|
||||
|
||||
Commands:
|
||||
list List all the versions of the specified template
|
||||
|
||||
Flags:
|
||||
-h, --help help for versions
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder templates versions [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+10
-24
@@ -1,28 +1,14 @@
|
||||
Usage: coder templates versions list [flags] <template>
|
||||
|
||||
List all the versions of the specified template
|
||||
|
||||
Usage:
|
||||
coder templates versions list <template> [flags]
|
||||
[1mOptions[0m
|
||||
-c, --column string-array (default: name,created at,created by,status,active)
|
||||
Columns to display in table output. Available columns: name, created
|
||||
at, created by, status, active.
|
||||
|
||||
Flags:
|
||||
-c, --column strings Columns to display in table output. Available columns: name, created
|
||||
at, created by, status, active (default [name,created at,created
|
||||
by,status,active])
|
||||
-h, --help help for list
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+13
-36
@@ -1,14 +1,10 @@
|
||||
Usage: coder tokens
|
||||
|
||||
Manage personal access tokens
|
||||
|
||||
Aliases: token
|
||||
|
||||
Tokens are used to authenticate automated clients to Coder.
|
||||
|
||||
Usage:
|
||||
coder tokens [flags]
|
||||
|
||||
coder tokens [command]
|
||||
|
||||
Aliases:
|
||||
tokens, token
|
||||
|
||||
Get Started:
|
||||
- Create a token for automation:
|
||||
|
||||
[;m$ coder tokens create[0m
|
||||
@@ -19,31 +15,12 @@ Get Started:
|
||||
|
||||
- Remove a token by ID:
|
||||
|
||||
[;m$ coder tokens rm WuoWs4ZsMX[0m
|
||||
[;m$ coder tokens rm WuoWs4ZsMX[0m
|
||||
|
||||
Commands:
|
||||
create Create a token
|
||||
list List tokens
|
||||
remove Delete a token
|
||||
[1mSubcommands[0m
|
||||
create Create a token
|
||||
list List tokens
|
||||
remove Delete a token
|
||||
|
||||
Flags:
|
||||
-h, --help help for tokens
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder tokens [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+9
-23
@@ -1,27 +1,13 @@
|
||||
Usage: coder tokens create [flags]
|
||||
|
||||
Create a token
|
||||
|
||||
Usage:
|
||||
coder tokens create [flags]
|
||||
[1mOptions[0m
|
||||
--lifetime duration, $CODER_TOKEN_LIFETIME (default: 720h0m0s)
|
||||
Specify a duration for the lifetime of the token.
|
||||
|
||||
Flags:
|
||||
-h, --help help for create
|
||||
--lifetime duration Specify a duration for the lifetime of the token.
|
||||
Consumes $CODER_TOKEN_LIFETIME (default 720h0m0s)
|
||||
-n, --name string Specify a human-readable name.
|
||||
-n, --name string, $CODER_TOKEN_NAME
|
||||
Specify a human-readable name.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+15
-28
@@ -1,33 +1,20 @@
|
||||
Usage: coder tokens list [flags]
|
||||
|
||||
List tokens
|
||||
|
||||
Usage:
|
||||
coder tokens list [flags]
|
||||
Aliases: ls
|
||||
|
||||
Aliases:
|
||||
list, ls
|
||||
[1mOptions[0m
|
||||
-a, --all bool
|
||||
Specifies whether all users' tokens will be listed or not (must have
|
||||
Owner role to see all tokens).
|
||||
|
||||
Flags:
|
||||
-a, --all Specifies whether all users' tokens will be listed or not (must have
|
||||
Owner role to see all tokens).
|
||||
-c, --column strings Columns to display in table output. Available columns: id, name, last
|
||||
used, expires at, created at, owner (default [id,name,last
|
||||
used,expires at,created at])
|
||||
-h, --help help for list
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
-c, --column string-array (default: id,name,last used,expires at,created at)
|
||||
Columns to display in table output. Available columns: id, name, last
|
||||
used, expires at, created at, owner.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+5
-24
@@ -1,27 +1,8 @@
|
||||
Usage: coder tokens remove <name>
|
||||
|
||||
Delete a token
|
||||
|
||||
Usage:
|
||||
coder tokens remove [name] [flags]
|
||||
Aliases: delete, rm
|
||||
|
||||
Aliases:
|
||||
remove, rm
|
||||
|
||||
Flags:
|
||||
-h, --help help for remove
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+17
-28
@@ -1,31 +1,20 @@
|
||||
Will update and start a given workspace if it is out of date. Use --always-prompt to change the parameter values of the workspace.
|
||||
Usage: coder update [flags] <workspace>
|
||||
|
||||
Usage:
|
||||
coder update <workspace> [flags]
|
||||
Will update and start a given workspace if it is out of date
|
||||
|
||||
Flags:
|
||||
--always-prompt Always prompt all parameters. Does not pull parameter
|
||||
values from existing workspace
|
||||
-h, --help help for update
|
||||
--parameter-file string Specify a file path with parameter values.
|
||||
Consumes $CODER_PARAMETER_FILE
|
||||
--rich-parameter-file string Specify a file path with values for rich parameters
|
||||
defined in the template.
|
||||
Consumes $CODER_RICH_PARAMETER_FILE
|
||||
Use --always-prompt to change the parameter values of the workspace.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
[1mOptions[0m
|
||||
--always-prompt bool
|
||||
Always prompt all parameters. Does not pull parameter values from
|
||||
existing workspace.
|
||||
|
||||
--parameter-file string, $CODER_PARAMETER_FILE
|
||||
Specify a file path with parameter values.
|
||||
|
||||
--rich-parameter-file string, $CODER_RICH_PARAMETER_FILE
|
||||
Specify a file path with values for rich parameters defined in the
|
||||
template.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+14
-34
@@ -1,38 +1,18 @@
|
||||
Usage: coder users [subcommand]
|
||||
|
||||
Manage users
|
||||
|
||||
Usage:
|
||||
coder users [flags]
|
||||
Aliases: user
|
||||
|
||||
coder users [command]
|
||||
[1mSubcommands[0m
|
||||
activate Update a user's status to 'active'. Active users can fully
|
||||
interact with the platform
|
||||
create
|
||||
list
|
||||
show Show a single user. Use 'me' to indicate the currently
|
||||
authenticated user.
|
||||
suspend Update a user's status to 'suspended'. A suspended user cannot
|
||||
log into the platform
|
||||
|
||||
Aliases:
|
||||
users, user
|
||||
|
||||
Commands:
|
||||
activate Update a user's status to 'active'. Active users can fully interact with the platform
|
||||
create
|
||||
list
|
||||
show Show a single user. Use 'me' to indicate the currently authenticated user.
|
||||
suspend Update a user's status to 'suspended'. A suspended user cannot log into the platform
|
||||
|
||||
Flags:
|
||||
-h, --help help for users
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
|
||||
Use "coder users [command] --help" for more information about a command.
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+10
-27
@@ -1,32 +1,15 @@
|
||||
Update a user's status to 'active'. Active users can fully interact with the platform
|
||||
Usage: coder users activate [flags] <username|user_id>
|
||||
|
||||
Usage:
|
||||
coder users activate <username|user_id> [flags]
|
||||
Update a user's status to 'active'. Active users can fully interact with the
|
||||
platform
|
||||
|
||||
Aliases:
|
||||
activate, active
|
||||
Aliases: active
|
||||
|
||||
Get Started:
|
||||
[;m$ coder users activate example_user[0m
|
||||
[;m$ coder users activate example_user[0m
|
||||
|
||||
Flags:
|
||||
-c, --column stringArray Specify a column to filter in the table. (default
|
||||
[username,email,created_at,status])
|
||||
-h, --help help for activate
|
||||
[1mOptions[0m
|
||||
-c, --column string-array (default: username,email,created_at,status)
|
||||
Specify a column to filter in the table.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+12
-23
@@ -1,25 +1,14 @@
|
||||
Usage:
|
||||
coder users create [flags]
|
||||
Usage: coder users create [flags]
|
||||
|
||||
Flags:
|
||||
-e, --email string Specifies an email address for the new user.
|
||||
-h, --help help for create
|
||||
-p, --password string Specifies a password for the new user.
|
||||
-u, --username string Specifies a username for the new user.
|
||||
[1mOptions[0m
|
||||
-e, --email string
|
||||
Specifies an email address for the new user.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-p, --password string
|
||||
Specifies a password for the new user.
|
||||
|
||||
-u, --username string
|
||||
Specifies a username for the new user.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+11
-25
@@ -1,28 +1,14 @@
|
||||
Usage:
|
||||
coder users list [flags]
|
||||
Usage: coder users list [flags]
|
||||
|
||||
Aliases:
|
||||
list, ls
|
||||
Aliases: ls
|
||||
|
||||
Flags:
|
||||
-c, --column strings Columns to display in table output. Available columns: id, username,
|
||||
email, created at, status (default [username,email,created_at,status])
|
||||
-h, --help help for list
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
[1mOptions[0m
|
||||
-c, --column string-array (default: username,email,created_at,status)
|
||||
Columns to display in table output. Available columns: id, username,
|
||||
email, created at, status.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+8
-24
@@ -1,28 +1,12 @@
|
||||
Usage: coder users show [flags] <username|user_id|'me'>
|
||||
|
||||
Show a single user. Use 'me' to indicate the currently authenticated user.
|
||||
|
||||
Usage:
|
||||
coder users show <username|user_id|'me'> [flags]
|
||||
[;m$ coder users show me[0m
|
||||
|
||||
Get Started:
|
||||
[;m$ coder users show me[0m
|
||||
[1mOptions[0m
|
||||
-o, --output string (default: table)
|
||||
Output format. Available formats: table, json.
|
||||
|
||||
Flags:
|
||||
-h, --help help for show
|
||||
-o, --output string Output format. Available formats: table, json (default "table")
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+10
-27
@@ -1,32 +1,15 @@
|
||||
Update a user's status to 'suspended'. A suspended user cannot log into the platform
|
||||
Usage: coder users suspend [flags] <username|user_id>
|
||||
|
||||
Usage:
|
||||
coder users suspend <username|user_id> [flags]
|
||||
Update a user's status to 'suspended'. A suspended user cannot log into the
|
||||
platform
|
||||
|
||||
Aliases:
|
||||
suspend, rm, delete
|
||||
Aliases: rm, delete
|
||||
|
||||
Get Started:
|
||||
[;m$ coder users suspend example_user[0m
|
||||
[;m$ coder users suspend example_user[0m
|
||||
|
||||
Flags:
|
||||
-c, --column stringArray Specify a column to filter in the table. (default
|
||||
[username,email,created_at,status])
|
||||
-h, --help help for suspend
|
||||
[1mOptions[0m
|
||||
-c, --column string-array (default: username,email,created_at,status)
|
||||
Specify a column to filter in the table.
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
+4
-22
@@ -1,24 +1,6 @@
|
||||
Usage: coder version
|
||||
|
||||
Show coder version
|
||||
|
||||
Usage:
|
||||
coder version [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for version
|
||||
|
||||
Global Flags:
|
||||
--global-config coder Path to the global coder config directory.
|
||||
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
|
||||
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
|
||||
Consumes $CODER_HEADER
|
||||
--no-feature-warning Suppress warnings about unlicensed features.
|
||||
Consumes $CODER_NO_FEATURE_WARNING
|
||||
--no-version-warning Suppress warning when client and server versions do not match.
|
||||
Consumes $CODER_NO_VERSION_WARNING
|
||||
--token string Specify an authentication token. For security reasons setting
|
||||
CODER_SESSION_TOKEN is preferred.
|
||||
Consumes $CODER_SESSION_TOKEN
|
||||
--url string URL to a deployment.
|
||||
Consumes $CODER_URL
|
||||
-v, --verbose Enable verbose output.
|
||||
Consumes $CODER_VERBOSE
|
||||
---
|
||||
Run `coder --help` for a list of global options.
|
||||
|
||||
Reference in New Issue
Block a user