Skip to content

docs: Add CLI docs #5879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Jan 27, 2023
Merged

docs: Add CLI docs #5879

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
8862b9d
docs: Add CLI docs
BrunoQuaresma Jan 26, 2023
6504518
Fix command
BrunoQuaresma Jan 26, 2023
6b5f959
Format files
BrunoQuaresma Jan 26, 2023
343dfbd
Update CLI title on docs
BrunoQuaresma Jan 26, 2023
891454a
Fix ANSI
BrunoQuaresma Jan 26, 2023
df263d4
Fix format
BrunoQuaresma Jan 26, 2023
7608821
Update icon
BrunoQuaresma Jan 26, 2023
0618d2f
Apply PR suggestions
BrunoQuaresma Jan 27, 2023
d1f6b36
Fix makefile
BrunoQuaresma Jan 27, 2023
4a0d4cb
Merge branch 'main' of github.com:coder/coder into bq/add-cli-docs
BrunoQuaresma Jan 27, 2023
fa86719
Fix default values
BrunoQuaresma Jan 27, 2023
df26b83
Remove coder version from the docs
BrunoQuaresma Jan 27, 2023
c93bcb8
Fix variable values
BrunoQuaresma Jan 27, 2023
38163c9
Merge branch 'main' of github.com:coder/coder into bq/add-cli-docs
BrunoQuaresma Jan 27, 2023
9ac5887
Add nowait
BrunoQuaresma Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix ANSI
  • Loading branch information
@BrunoQuaresma
BrunoQuaresma committed Jan 26, 2023
commit 891454a5cd5bb1e435a13c9f3dc930f2be7e240a
77 changes: 40 additions & 37 deletions docs/cli/coder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,72 +1,75 @@
## coder



### Synopsis

Coder v0.0.0-devel — A tool for provisioning self-hosted development environments with Terraform.


```
coder [flags]
```

### Examples

```
- Start a Coder server:
- Start a Coder server:

 $ coder server 
$ coder server

- Get started by creating a template from an example:
- Get started by creating a template from an example:

 $ coder templates init 
$ coder templates init
```

### Options

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
-h, --help help for coder
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder config-ssh](coder_config-ssh.md) - Add an SSH Host entry for your workspaces "ssh coder.workspace"
- [coder create](coder_create.md) - Create a workspace
- [coder delete](coder_delete.md) - Delete a workspace
- [coder dotfiles](coder_dotfiles.md) - Checkout and install a dotfiles repository from a Git URL
- [coder list](coder_list.md) - List workspaces
- [coder login](coder_login.md) - Authenticate with Coder deployment
- [coder logout](coder_logout.md) - Unauthenticate your local session
- [coder port-forward](coder_port-forward.md) - Forward ports from machine to a workspace
- [coder publickey](coder_publickey.md) - Output your Coder public key used for Git operations
- [coder rename](coder_rename.md) - Rename a workspace
- [coder reset-password](coder_reset-password.md) - Directly connect to the database to reset a user's password
- [coder restart](coder_restart.md) - Restart a workspace
- [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API
- [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
- [coder server](coder_server.md) - Start a Coder server
- [coder show](coder_show.md) - Display details of a workspace's resources and agents
- [coder speedtest](coder_speedtest.md) - Run upload and download tests from your machine to a workspace
- [coder ssh](coder_ssh.md) - Start a shell into a workspace
- [coder start](coder_start.md) - Start a workspace
- [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces
- [coder stop](coder_stop.md) - Stop a workspace
- [coder templates](coder_templates.md) - Manage templates
- [coder tokens](coder_tokens.md) - Manage personal access tokens
- [coder update](coder_update.md) - Update a workspace
- [coder users](coder_users.md) - Manage users
- [coder version](coder_version.md) - Show coder version
* [coder config-ssh](coder_config-ssh.md) - Add an SSH Host entry for your workspaces "ssh coder.workspace"
* [coder create](coder_create.md) - Create a workspace
* [coder delete](coder_delete.md) - Delete a workspace
* [coder dotfiles](coder_dotfiles.md) - Checkout and install a dotfiles repository from a Git URL
* [coder list](coder_list.md) - List workspaces
* [coder login](coder_login.md) - Authenticate with Coder deployment
* [coder logout](coder_logout.md) - Unauthenticate your local session
* [coder port-forward](coder_port-forward.md) - Forward ports from machine to a workspace
* [coder publickey](coder_publickey.md) - Output your Coder public key used for Git operations
* [coder rename](coder_rename.md) - Rename a workspace
* [coder reset-password](coder_reset-password.md) - Directly connect to the database to reset a user's password
* [coder restart](coder_restart.md) - Restart a workspace
* [coder scaletest](coder_scaletest.md) - Run a scale test against the Coder API
* [coder schedule](coder_schedule.md) - Schedule automated start and stop times for workspaces
* [coder server](coder_server.md) - Start a Coder server
* [coder show](coder_show.md) - Display details of a workspace's resources and agents
* [coder speedtest](coder_speedtest.md) - Run upload and download tests from your machine to a workspace
* [coder ssh](coder_ssh.md) - Start a shell into a workspace
* [coder start](coder_start.md) - Start a workspace
* [coder state](coder_state.md) - Manually manage Terraform state to fix broken workspaces
* [coder stop](coder_stop.md) - Stop a workspace
* [coder templates](coder_templates.md) - Manage templates
* [coder tokens](coder_tokens.md) - Manage personal access tokens
* [coder update](coder_update.md) - Update a workspace
* [coder users](coder_users.md) - Manage users
* [coder version](coder_version.md) - Show coder version

###### Auto generated by spf13/cobra on 26-Jan-2023
30 changes: 15 additions & 15 deletions docs/cli/coder_config-ssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ coder config-ssh [flags]
### Examples

```
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:
- You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:

 $ coder config-ssh -o ForwardAgent=yes 
$ coder config-ssh -o ForwardAgent=yes

- You can use --dry-run (or -n) to see the changes that would be made:
- You can use --dry-run (or -n) to see the changes that would be made:

 $ coder config-ssh --dry-run 
$ coder config-ssh --dry-run
```

### Options
Expand All @@ -25,34 +25,34 @@ coder config-ssh [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")
Consumes $CODER_SSH_CONFIG_FILE (default "~/.ssh/config")
-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
Consumes $CODER_SSH_USE_PREVIOUS_OPTIONS
-y, --yes Bypass prompts
```

### Options inherited from parent commands

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder](coder.md) -
* [coder](coder.md) -

###### Auto generated by spf13/cobra on 26-Jan-2023
26 changes: 13 additions & 13 deletions docs/cli/coder_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,39 @@ coder create [name] [flags]
```
-h, --help help for create
--parameter-file string Specify a file path with parameter values.
Consumes $CODER_PARAMETER_FILE
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
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
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 (default 8h0m0s)
Consumes $CODER_WORKSPACE_STOP_AFTER (default 8h0m0s)
-t, --template string Specify a template name.
Consumes $CODER_TEMPLATE_NAME
Consumes $CODER_TEMPLATE_NAME
-y, --yes Bypass prompts
```

### Options inherited from parent commands

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder](coder.md) -
* [coder](coder.md) -

###### Auto generated by spf13/cobra on 26-Jan-2023
16 changes: 8 additions & 8 deletions docs/cli/coder_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,23 @@ coder delete <workspace> [flags]

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder](coder.md) -
* [coder](coder.md) -

###### Auto generated by spf13/cobra on 26-Jan-2023
22 changes: 11 additions & 11 deletions docs/cli/coder_dotfiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,41 +9,41 @@ coder dotfiles [git_repo_url] [flags]
### Examples

```
- Check out and install a dotfiles repository without prompts:
- Check out and install a dotfiles repository without prompts:

 $ coder dotfiles --yes git@github.com:example/dotfiles.git 
$ coder dotfiles --yes git@github.com:example/dotfiles.git
```

### Options

```
-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
Consumes $CODER_SYMLINK_DIR
-y, --yes Bypass prompts
```

### Options inherited from parent commands

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder](coder.md) -
* [coder](coder.md) -

###### Auto generated by spf13/cobra on 26-Jan-2023
16 changes: 8 additions & 8 deletions docs/cli/coder_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,23 @@ coder list [flags]

```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
Consumes $CODER_CONFIG_DIR (default "/home/coder/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
Consumes $CODER_VERBOSE
```

### SEE ALSO

- [coder](coder.md) -
* [coder](coder.md) -

###### Auto generated by spf13/cobra on 26-Jan-2023
Loading