|
1 | 1 | <!-- DO NOT EDIT | GENERATED CONTENT --> |
2 | | -# coder |
3 | 2 |
|
| 3 | +# coder |
4 | 4 |
|
5 | 5 | Coder v0.0.0-devel — A tool for provisioning self-hosted development environments with Terraform. |
6 | 6 |
|
7 | | - |
8 | 7 | ## Usage |
| 8 | + |
9 | 9 | ```console |
10 | 10 | coder [flags] |
11 | 11 | ``` |
12 | 12 |
|
13 | 13 | ## Examples |
| 14 | + |
14 | 15 | ```console |
15 | | - - Start a Coder server: |
| 16 | + - Start a Coder server: |
16 | 17 |
|
17 | | - $ coder server |
| 18 | + $ coder server |
18 | 19 |
|
19 | | - - Get started by creating a template from an example: |
| 20 | + - Get started by creating a template from an example: |
20 | 21 |
|
21 | | - $ coder templates init |
| 22 | + $ coder templates init |
22 | 23 | ``` |
23 | 24 |
|
24 | 25 | ## Subcommands |
25 | | -| Name | Purpose | |
26 | | -| ---- | ----- | |
27 | | -| [<code>config-ssh</code>](./cli/coder_config-ssh) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | |
28 | | -| [<code>create</code>](./cli/coder_create) | Create a workspace | |
29 | | -| [<code>delete</code>](./cli/coder_delete) | Delete a workspace | |
30 | | -| [<code>dotfiles</code>](./cli/coder_dotfiles) | Checkout and install a dotfiles repository from a Git URL | |
31 | | -| [<code>list</code>](./cli/coder_list) | List workspaces | |
32 | | -| [<code>login</code>](./cli/coder_login) | Authenticate with Coder deployment | |
33 | | -| [<code>logout</code>](./cli/coder_logout) | Unauthenticate your local session | |
34 | | -| [<code>ping</code>](./cli/coder_ping) | Ping a workspace | |
35 | | -| [<code>port-forward</code>](./cli/coder_port-forward) | Forward ports from machine to a workspace | |
36 | | -| [<code>publickey</code>](./cli/coder_publickey) | Output your Coder public key used for Git operations | |
37 | | -| [<code>rename</code>](./cli/coder_rename) | Rename a workspace | |
38 | | -| [<code>reset-password</code>](./cli/coder_reset-password) | Directly connect to the database to reset a user's password | |
39 | | -| [<code>restart</code>](./cli/coder_restart) | Restart a workspace | |
40 | | -| [<code>scaletest</code>](./cli/coder_scaletest) | Run a scale test against the Coder API | |
41 | | -| [<code>schedule</code>](./cli/coder_schedule) | Schedule automated start and stop times for workspaces | |
42 | | -| [<code>server</code>](./cli/coder_server) | Start a Coder server | |
43 | | -| [<code>show</code>](./cli/coder_show) | Display details of a workspace's resources and agents | |
44 | | -| [<code>speedtest</code>](./cli/coder_speedtest) | Run upload and download tests from your machine to a workspace | |
45 | | -| [<code>ssh</code>](./cli/coder_ssh) | Start a shell into a workspace | |
46 | | -| [<code>start</code>](./cli/coder_start) | Start a workspace | |
47 | | -| [<code>state</code>](./cli/coder_state) | Manually manage Terraform state to fix broken workspaces | |
48 | | -| [<code>stop</code>](./cli/coder_stop) | Stop a workspace | |
49 | | -| [<code>templates</code>](./cli/coder_templates) | Manage templates | |
50 | | -| [<code>tokens</code>](./cli/coder_tokens) | Manage personal access tokens | |
51 | | -| [<code>update</code>](./cli/coder_update) | Update a workspace | |
52 | | -| [<code>users</code>](./cli/coder_users) | Manage users | |
53 | | -| [<code>version</code>](./cli/coder_version) | Show coder version | |
| 26 | + |
| 27 | +| Name | Purpose | |
| 28 | +| --------------------------------------------------------- | --------------------------------------------------------------- | |
| 29 | +| [<code>config-ssh</code>](./cli/coder_config-ssh) | Add an SSH Host entry for your workspaces "ssh coder.workspace" | |
| 30 | +| [<code>create</code>](./cli/coder_create) | Create a workspace | |
| 31 | +| [<code>delete</code>](./cli/coder_delete) | Delete a workspace | |
| 32 | +| [<code>dotfiles</code>](./cli/coder_dotfiles) | Checkout and install a dotfiles repository from a Git URL | |
| 33 | +| [<code>list</code>](./cli/coder_list) | List workspaces | |
| 34 | +| [<code>login</code>](./cli/coder_login) | Authenticate with Coder deployment | |
| 35 | +| [<code>logout</code>](./cli/coder_logout) | Unauthenticate your local session | |
| 36 | +| [<code>ping</code>](./cli/coder_ping) | Ping a workspace | |
| 37 | +| [<code>port-forward</code>](./cli/coder_port-forward) | Forward ports from machine to a workspace | |
| 38 | +| [<code>publickey</code>](./cli/coder_publickey) | Output your Coder public key used for Git operations | |
| 39 | +| [<code>rename</code>](./cli/coder_rename) | Rename a workspace | |
| 40 | +| [<code>reset-password</code>](./cli/coder_reset-password) | Directly connect to the database to reset a user's password | |
| 41 | +| [<code>restart</code>](./cli/coder_restart) | Restart a workspace | |
| 42 | +| [<code>scaletest</code>](./cli/coder_scaletest) | Run a scale test against the Coder API | |
| 43 | +| [<code>schedule</code>](./cli/coder_schedule) | Schedule automated start and stop times for workspaces | |
| 44 | +| [<code>server</code>](./cli/coder_server) | Start a Coder server | |
| 45 | +| [<code>show</code>](./cli/coder_show) | Display details of a workspace's resources and agents | |
| 46 | +| [<code>speedtest</code>](./cli/coder_speedtest) | Run upload and download tests from your machine to a workspace | |
| 47 | +| [<code>ssh</code>](./cli/coder_ssh) | Start a shell into a workspace | |
| 48 | +| [<code>start</code>](./cli/coder_start) | Start a workspace | |
| 49 | +| [<code>state</code>](./cli/coder_state) | Manually manage Terraform state to fix broken workspaces | |
| 50 | +| [<code>stop</code>](./cli/coder_stop) | Stop a workspace | |
| 51 | +| [<code>templates</code>](./cli/coder_templates) | Manage templates | |
| 52 | +| [<code>tokens</code>](./cli/coder_tokens) | Manage personal access tokens | |
| 53 | +| [<code>update</code>](./cli/coder_update) | Update a workspace | |
| 54 | +| [<code>users</code>](./cli/coder_users) | Manage users | |
| 55 | +| [<code>version</code>](./cli/coder_version) | Show coder version | |
0 commit comments