Skip to content

feat: rework CLI docs #6312

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 21 commits into from
Feb 23, 2023
Merged

feat: rework CLI docs #6312

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
a756f52
Refactor MVP
ammario Feb 22, 2023
0912689
Some more progress!
ammario Feb 22, 2023
895b109
Print usage!!
ammario Feb 22, 2023
d4dedd9
Support flags
ammario Feb 22, 2023
6e55629
Add DO NOT EDIT disclaimer
ammario Feb 22, 2023
e04d191
Add Subcommands
ammario Feb 22, 2023
5e64155
Parse environment variables
ammario Feb 22, 2023
2db1963
Correctly exclude hidden commands
ammario Feb 23, 2023
376c38a
Merge remote-tracking branch 'origin/main' into cli-docs
ammario Feb 23, 2023
4c441d5
Link subcommands
ammario Feb 23, 2023
ffc38aa
make
ammario Feb 23, 2023
8f29627
fixup! make
ammario Feb 23, 2023
cc5ea25
fixup! make
ammario Feb 23, 2023
37152b2
fixup! make
ammario Feb 23, 2023
bff3045
fixup! make
ammario Feb 23, 2023
4ae86f7
fixup! make
ammario Feb 23, 2023
ba7c73b
fixup! make
ammario Feb 23, 2023
93f69b2
fixup! make
ammario Feb 23, 2023
ff0446e
fixup! make
ammario Feb 23, 2023
c7f3a2e
fixup! make
ammario Feb 23, 2023
72c2d5f
fixup! make
ammario Feb 23, 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
fixup! make
  • Loading branch information
@ammario
ammario committed Feb 23, 2023
commit 8f29627cea23d993489e86bf842287f72b0905c4
72 changes: 37 additions & 35 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder

# coder

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


## Usage

```console
coder [flags]
```

## Examples

```console
- 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
```

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

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