Skip to content

Commit e04d191

Browse files
ammarioammario
committed
Add Subcommands
1 parent 6e55629 commit e04d191

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+192
-23
lines changed

‎docs/cli.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Usage
66
```console
7-
coder
7+
coder [flags]
88
```
99

1010
## Examples
@@ -17,3 +17,38 @@ coder
1717

1818
 $ coder templates init 
1919
```
20+
21+
## Subcommands
22+
| Name | Purpose |
23+
| ---- | ----- |
24+
| <code>agent</code> | |
25+
| <code>config-ssh</code> | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
26+
| <code>create</code> | Create a workspace |
27+
| <code>delete</code> | Delete a workspace |
28+
| <code>dotfiles</code> | Checkout and install a dotfiles repository from a Git URL |
29+
| <code>gitssh</code> | Wraps the "ssh" command and uses the coder gitssh key for authentication |
30+
| <code>list</code> | List workspaces |
31+
| <code>login</code> | Authenticate with Coder deployment |
32+
| <code>logout</code> | Unauthenticate your local session |
33+
| <code>parameters</code> | List parameters for a given scope |
34+
| <code>ping</code> | Ping a workspace |
35+
| <code>port-forward</code> | Forward ports from machine to a workspace |
36+
| <code>publickey</code> | Output your Coder public key used for Git operations |
37+
| <code>rename</code> | Rename a workspace |
38+
| <code>reset-password</code> | Directly connect to the database to reset a user's password |
39+
| <code>restart</code> | Restart a workspace |
40+
| <code>scaletest</code> | Run a scale test against the Coder API |
41+
| <code>schedule</code> | Schedule automated start and stop times for workspaces |
42+
| <code>server</code> | Start a Coder server |
43+
| <code>show</code> | Display details of a workspace's resources and agents |
44+
| <code>speedtest</code> | Run upload and download tests from your machine to a workspace |
45+
| <code>ssh</code> | Start a shell into a workspace |
46+
| <code>start</code> | Start a workspace |
47+
| <code>state</code> | Manually manage Terraform state to fix broken workspaces |
48+
| <code>stop</code> | Stop a workspace |
49+
| <code>templates</code> | Manage templates |
50+
| <code>tokens</code> | Manage personal access tokens |
51+
| <code>update</code> | Update a workspace |
52+
| <code>users</code> | Manage users |
53+
| <code>version</code> | Show coder version |
54+
| <code>vscodessh</code> | |

‎docs/cli/coder_agent.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
coder agent [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_config-ssh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ coder config-ssh [flags]
1919
$ coder config-ssh --dry-run
2020
```
2121

22+
2223
## Local Flags
2324
| Name | Default | Usage |
2425
| ---- | ------- | ----- |

‎docs/cli/coder_create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Create a workspace
77
coder create [name] [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_delete.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Delete a workspace
77
coder delete <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_dotfiles.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ coder dotfiles [git_repo_url] [flags]
1414
$ coder dotfiles --yes git@github.com:example/dotfiles.git
1515
```
1616

17+
1718
## Local Flags
1819
| Name | Default | Usage |
1920
| ---- | ------- | ----- |

‎docs/cli/coder_gitssh.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
Wraps the "ssh" command and uses the coder gitssh key for authentication
55
## Usage
66
```console
7-
coder gitssh
7+
coder gitssh [flags]
88
```
9+

‎docs/cli/coder_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ List workspaces
77
coder list [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_login.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Authenticate with Coder deployment
77
coder login <url> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_logout.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Unauthenticate your local session
77
coder logout [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_parameters.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,15 @@
44
List parameters for a given scope
55
## Usage
66
```console
7-
coder parameters
7+
coder parameters [flags]
88
```
99

1010
## Examples
1111
```console
1212
$ coder parameters list workspace my-workspace
1313
```
14+
15+
## Subcommands
16+
| Name | Purpose |
17+
| ---- | ----- |
18+
| <code>list</code> | |

‎docs/cli/coder_parameters_list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
coder parameters list [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_ping.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Ping a workspace
77
coder ping <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_port-forward.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ coder port-forward <workspace> [flags]
2828
$ coder port-forward <workspace> --tcp 8080,9000:3000,9090-9092,10000-10002:10010-10012
2929
```
3030

31+
3132
## Local Flags
3233
| Name | Default | Usage |
3334
| ---- | ------- | ----- |

‎docs/cli/coder_publickey.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Output your Coder public key used for Git operations
77
coder publickey [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_rename.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Rename a workspace
77
coder rename <workspace> <new name> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_reset-password.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Directly connect to the database to reset a user's password
77
coder reset-password <username> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_restart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Restart a workspace
77
coder restart <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_scaletest.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,11 @@
44
Run a scale test against the Coder API
55
## Usage
66
```console
7-
coder scaletest
7+
coder scaletest [flags]
88
```
9+
10+
## Subcommands
11+
| Name | Purpose |
12+
| ---- | ----- |
13+
| <code>cleanup</code> | Cleanup any orphaned scaletest resources |
14+
| <code>create-workspaces</code> | Creates many workspaces and waits for them to be ready |

‎docs/cli/coder_scaletest_cleanup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Cleanup any orphaned scaletest resources
77
coder scaletest cleanup [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_scaletest_create-workspaces.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Creates many workspaces and waits for them to be ready
77
coder scaletest create-workspaces [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_schedule.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,13 @@
44
Schedule automated start and stop times for workspaces
55
## Usage
66
```console
7-
coder schedule { show | start | stop | override } <workspace>
7+
coder schedule { show | start | stop | override } <workspace> [flags]
88
```
9+
10+
## Subcommands
11+
| Name | Purpose |
12+
| ---- | ----- |
13+
| <code>override-stop</code> | Edit stop time of active workspace |
14+
| <code>show</code> | Show workspace schedule |
15+
| <code>start</code> | Edit workspace start schedule |
16+
| <code>stop</code> | Edit workspace stop schedule |

‎docs/cli/coder_schedule_override-stop.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
Edit stop time of active workspace
55
## Usage
66
```console
7-
coder schedule override-stop <workspace-name> <duration from now>
7+
coder schedule override-stop <workspace-name> <duration from now> [flags]
88
```
99

1010
## Examples
1111
```console
1212
$ coder schedule override-stop my-workspace 90m
1313
```
14+

‎docs/cli/coder_schedule_show.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
Show workspace schedule
55
## Usage
66
```console
7-
coder schedule show <workspace-name>
7+
coder schedule show <workspace-name> [flags]
88
```
9+

‎docs/cli/coder_schedule_start.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
Edit workspace start schedule
55
## Usage
66
```console
7-
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual }
7+
coder schedule start <workspace-name> { <start-time> [day-of-week] [location] | manual } [flags]
88
```
99

1010
## Examples
@@ -13,3 +13,4 @@ coder schedule start <workspace-name> { <start-time> [day-of-week] [location] |
1313

1414
$ coder schedule start my-workspace 9:30AM Mon-Fri Europe/Dublin
1515
```
16+

‎docs/cli/coder_schedule_stop.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
Edit workspace stop schedule
55
## Usage
66
```console
7-
coder schedule stop <workspace-name> { <duration> | manual }
7+
coder schedule stop <workspace-name> { <duration> | manual } [flags]
88
```
99

1010
## Examples
1111
```console
1212
$ coder schedule stop my-workspace 2h30m
1313
```
14+

‎docs/cli/coder_server.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Start a Coder server
77
coder server [flags]
88
```
99

10+
## Subcommands
11+
| Name | Purpose |
12+
| ---- | ----- |
13+
| <code>create-admin-user</code> | Create a new admin user with the given username, email and password and adds it to every organization. |
14+
| <code>postgres-builtin-serve</code> | Run the built-in PostgreSQL deployment. |
15+
| <code>postgres-builtin-url</code> | Output the connection URL for the built-in PostgreSQL deployment. |
16+
1017
## Local Flags
1118
| Name | Default | Usage |
1219
| ---- | ------- | ----- |

‎docs/cli/coder_server_create-admin-user.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Create a new admin user with the given username, email and password and adds it
77
coder server create-admin-user [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_server_postgres-builtin-serve.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Run the built-in PostgreSQL deployment.
77
coder server postgres-builtin-serve [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_server_postgres-builtin-url.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Output the connection URL for the built-in PostgreSQL deployment.
77
coder server postgres-builtin-url [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_show.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@
44
Display details of a workspace's resources and agents
55
## Usage
66
```console
7-
coder show <workspace>
7+
coder show <workspace> [flags]
88
```
9+

‎docs/cli/coder_speedtest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Run upload and download tests from your machine to a workspace
77
coder speedtest <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_ssh.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Start a shell into a workspace
77
coder ssh <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_start.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Start a workspace
77
coder start <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_state.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,11 @@
44
Manually manage Terraform state to fix broken workspaces
55
## Usage
66
```console
7-
coder state
7+
coder state [flags]
88
```
9+
10+
## Subcommands
11+
| Name | Purpose |
12+
| ---- | ----- |
13+
| <code>pull</code> | |
14+
| <code>push</code> | |

‎docs/cli/coder_state_pull.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
coder state pull <workspace> [file] [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_state_push.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
coder state push <workspace> <file> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

‎docs/cli/coder_stop.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Stop a workspace
77
coder stop <workspace> [flags]
88
```
99

10+
1011
## Local Flags
1112
| Name | Default | Usage |
1213
| ---- | ------- | ----- |

0 commit comments

Comments
 (0)