Skip to content

Commit 2db1963

Browse files
ammarioammario
committed
Correctly exclude hidden commands
1 parent 5e64155 commit 2db1963

Some content is hidden

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

49 files changed

+1812
-440
lines changed

‎docs/cli.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,13 @@ coder [flags]
2424
## Subcommands
2525
| Name | Purpose |
2626
| ---- | ----- |
27-
| <code>agent</code> | |
2827
| <code>config-ssh</code> | Add an SSH Host entry for your workspaces "ssh coder.workspace" |
2928
| <code>create</code> | Create a workspace |
3029
| <code>delete</code> | Delete a workspace |
3130
| <code>dotfiles</code> | Checkout and install a dotfiles repository from a Git URL |
32-
| <code>gitssh</code> | Wraps the "ssh" command and uses the coder gitssh key for authentication |
3331
| <code>list</code> | List workspaces |
3432
| <code>login</code> | Authenticate with Coder deployment |
3533
| <code>logout</code> | Unauthenticate your local session |
36-
| <code>parameters</code> | List parameters for a given scope |
3734
| <code>ping</code> | Ping a workspace |
3835
| <code>port-forward</code> | Forward ports from machine to a workspace |
3936
| <code>publickey</code> | Output your Coder public key used for Git operations |
@@ -54,4 +51,3 @@ coder [flags]
5451
| <code>update</code> | Update a workspace |
5552
| <code>users</code> | Manage users |
5653
| <code>version</code> | Show coder version |
57-
| <code>vscodessh</code> | |

‎docs/cli/coder_agent.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎docs/cli/coder_config-ssh.md

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,50 @@ coder config-ssh [flags]
2222
```
2323

2424

25-
## Local Flags
26-
| Name | Default | Usage | Environment |
27-
| ---- | ------- | ----- | -------- |
28-
| --dry-run, -n |false |<code>Perform a trial run with no changes made, showing a diff at the end.</code> | |
29-
| --ssh-config-file |~/.ssh/config |<code>Specifies the path to an SSH config.</code> | <code>$CODER_SSH_CONFIG_FILE</code> |
30-
| --ssh-option, -o |[] |<code>Specifies additional SSH options to embed in each host stanza.</code> | |
31-
| --use-previous-options |false |<code>Specifies whether or not to keep options from previous run of config-ssh.</code> | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
32-
| --yes, -y |false |<code>Bypass prompts</code> | |
25+
## Flags
26+
### --dry-run, -n
27+
Perform a trial run with no changes made, showing a diff at the end.
28+
<br/>
29+
| | |
30+
| --- | --- |
31+
| Default | <code>false</code> |
32+
33+
34+
35+
### --ssh-config-file
36+
Specifies the path to an SSH config.
37+
<br/>
38+
| | |
39+
| --- | --- |
40+
| Consumes | <code>$CODER_SSH_CONFIG_FILE</code> |
41+
| Default | <code>~/.ssh/config</code> |
42+
43+
44+
45+
### --ssh-option, -o
46+
Specifies additional SSH options to embed in each host stanza.
47+
<br/>
48+
| | |
49+
| --- | --- |
50+
| Default | <code>[]</code> |
51+
52+
53+
54+
### --use-previous-options
55+
Specifies whether or not to keep options from previous run of config-ssh.
56+
<br/>
57+
| | |
58+
| --- | --- |
59+
| Consumes | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
60+
| Default | <code>false</code> |
61+
62+
63+
64+
### --yes, -y
65+
Bypass prompts
66+
<br/>
67+
| | |
68+
| --- | --- |
69+
| Default | <code>false</code> |
70+
71+

‎docs/cli/coder_create.md

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,50 @@ coder create [name] [flags]
1010
```
1111

1212

13-
## Local Flags
14-
| Name | Default | Usage | Environment |
15-
| ---- | ------- | ----- | -------- |
16-
| --parameter-file | |<code>Specify a file path with parameter values.</code> | <code>$CODER_PARAMETER_FILE</code> |
17-
| --rich-parameter-file | |<code>Specify a file path with values for rich parameters defined in the template.</code> | <code>$CODER_RICH_PARAMETER_FILE</code> |
18-
| --start-at | |<code>Specify the workspace autostart schedule. Check `coder schedule start --help` for the syntax.</code> | <code>$CODER_WORKSPACE_START_AT</code> |
19-
| --stop-after |8h0m0s |<code>Specify a duration after which the workspace should shut down (e.g. 8h).</code> | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
20-
| --template, -t | |<code>Specify a template name.</code> | <code>$CODER_TEMPLATE_NAME</code> |
21-
| --yes, -y |false |<code>Bypass prompts</code> | |
13+
## Flags
14+
### --parameter-file
15+
Specify a file path with parameter values.
16+
<br/>
17+
| | |
18+
| --- | --- |
19+
| Consumes | <code>$CODER_PARAMETER_FILE</code> |
20+
21+
### --rich-parameter-file
22+
Specify a file path with values for rich parameters defined in the template.
23+
<br/>
24+
| | |
25+
| --- | --- |
26+
| Consumes | <code>$CODER_RICH_PARAMETER_FILE</code> |
27+
28+
### --start-at
29+
Specify the workspace autostart schedule. Check `coder schedule start --help` for the syntax.
30+
<br/>
31+
| | |
32+
| --- | --- |
33+
| Consumes | <code>$CODER_WORKSPACE_START_AT</code> |
34+
35+
### --stop-after
36+
Specify a duration after which the workspace should shut down (e.g. 8h).
37+
<br/>
38+
| | |
39+
| --- | --- |
40+
| Consumes | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
41+
| Default | <code>8h0m0s</code> |
42+
43+
44+
45+
### --template, -t
46+
Specify a template name.
47+
<br/>
48+
| | |
49+
| --- | --- |
50+
| Consumes | <code>$CODER_TEMPLATE_NAME</code> |
51+
52+
### --yes, -y
53+
Bypass prompts
54+
<br/>
55+
| | |
56+
| --- | --- |
57+
| Default | <code>false</code> |
58+
59+

‎docs/cli/coder_delete.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,21 @@ coder delete <workspace> [flags]
1010
```
1111

1212

13-
## Local Flags
14-
| Name | Default | Usage | Environment |
15-
| ---- | ------- | ----- | -------- |
16-
| --orphan |false |<code>Delete a workspace without deleting its resources. This can delete a<br/>workspace in a broken state, but may also lead to unaccounted cloud resources.</code> | |
17-
| --yes, -y |false |<code>Bypass prompts</code> | |
13+
## Flags
14+
### --orphan
15+
Delete a workspace without deleting its resources. This can delete a<br/>workspace in a broken state, but may also lead to unaccounted cloud resources.
16+
<br/>
17+
| | |
18+
| --- | --- |
19+
| Default | <code>false</code> |
20+
21+
22+
23+
### --yes, -y
24+
Bypass prompts
25+
<br/>
26+
| | |
27+
| --- | --- |
28+
| Default | <code>false</code> |
29+
30+

‎docs/cli/coder_dotfiles.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,19 @@ coder dotfiles [git_repo_url] [flags]
1717
```
1818

1919

20-
## Local Flags
21-
| Name | Default | Usage | Environment |
22-
| ---- | ------- | ----- | -------- |
23-
| --symlink-dir | |<code>Specifies the directory for the dotfiles symlink destinations. If empty will use $HOME.</code> | <code>$CODER_SYMLINK_DIR</code> |
24-
| --yes, -y |false |<code>Bypass prompts</code> | |
20+
## Flags
21+
### --symlink-dir
22+
Specifies the directory for the dotfiles symlink destinations. If empty will use $HOME.
23+
<br/>
24+
| | |
25+
| --- | --- |
26+
| Consumes | <code>$CODER_SYMLINK_DIR</code> |
27+
28+
### --yes, -y
29+
Bypass prompts
30+
<br/>
31+
| | |
32+
| --- | --- |
33+
| Default | <code>false</code> |
34+
35+

‎docs/cli/coder_gitssh.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/cli/coder_list.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,39 @@ coder list [flags]
1010
```
1111

1212

13-
## Local Flags
14-
| Name | Default | Usage | Environment |
15-
| ---- | ------- | ----- | -------- |
16-
| --all, -a |false |<code>Specifies whether all workspaces will be listed or not.</code> | |
17-
| --column, -c |[workspace,template,status,last built,outdated,starts at,stops after] |<code>Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after</code> | |
18-
| --output, -o |table |<code>Output format. Available formats: table, json</code> | |
19-
| --search |owner:me |<code>Search for a workspace with a query.</code> | |
13+
## Flags
14+
### --all, -a
15+
Specifies whether all workspaces will be listed or not.
16+
<br/>
17+
| | |
18+
| --- | --- |
19+
| Default | <code>false</code> |
20+
21+
22+
23+
### --column, -c
24+
Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after
25+
<br/>
26+
| | |
27+
| --- | --- |
28+
| Default | <code>[workspace,template,status,last built,outdated,starts at,stops after]</code> |
29+
30+
31+
32+
### --output, -o
33+
Output format. Available formats: table, json
34+
<br/>
35+
| | |
36+
| --- | --- |
37+
| Default | <code>table</code> |
38+
39+
40+
41+
### --search
42+
Search for a workspace with a query.
43+
<br/>
44+
| | |
45+
| --- | --- |
46+
| Default | <code>owner:me</code> |
47+
48+

‎docs/cli/coder_login.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,34 @@ coder login <url> [flags]
1010
```
1111

1212

13-
## Local Flags
14-
| Name | Default | Usage | Environment |
15-
| ---- | ------- | ----- | -------- |
16-
| --first-user-email | |<code>Specifies an email address to use if creating the first user for the deployment.</code> | <code>$CODER_FIRST_USER_EMAIL</code> |
17-
| --first-user-password | |<code>Specifies a password to use if creating the first user for the deployment.</code> | <code>$CODER_FIRST_USER_PASSWORD</code> |
18-
| --first-user-trial |false |<code>Specifies whether a trial license should be provisioned for the Coder deployment or not.</code> | <code>$CODER_FIRST_USER_TRIAL</code> |
19-
| --first-user-username | |<code>Specifies a username to use if creating the first user for the deployment.</code> | <code>$CODER_FIRST_USER_USERNAME</code> |
13+
## Flags
14+
### --first-user-email
15+
Specifies an email address to use if creating the first user for the deployment.
16+
<br/>
17+
| | |
18+
| --- | --- |
19+
| Consumes | <code>$CODER_FIRST_USER_EMAIL</code> |
20+
21+
### --first-user-password
22+
Specifies a password to use if creating the first user for the deployment.
23+
<br/>
24+
| | |
25+
| --- | --- |
26+
| Consumes | <code>$CODER_FIRST_USER_PASSWORD</code> |
27+
28+
### --first-user-trial
29+
Specifies whether a trial license should be provisioned for the Coder deployment or not.
30+
<br/>
31+
| | |
32+
| --- | --- |
33+
| Consumes | <code>$CODER_FIRST_USER_TRIAL</code> |
34+
| Default | <code>false</code> |
35+
36+
37+
38+
### --first-user-username
39+
Specifies a username to use if creating the first user for the deployment.
40+
<br/>
41+
| | |
42+
| --- | --- |
43+
| Consumes | <code>$CODER_FIRST_USER_USERNAME</code> |

‎docs/cli/coder_logout.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ coder logout [flags]
1010
```
1111

1212

13-
## Local Flags
14-
| Name | Default | Usage | Environment |
15-
| ---- | ------- | ----- | -------- |
16-
| --yes, -y |false |<code>Bypass prompts</code> | |
13+
## Flags
14+
### --yes, -y
15+
Bypass prompts
16+
<br/>
17+
| | |
18+
| --- | --- |
19+
| Default | <code>false</code> |
20+
21+

0 commit comments

Comments
 (0)