Skip to content

Commit ffc38aa

Browse files
ammarioammario
committed
make
1 parent 4c441d5 commit ffc38aa

Some content is hidden

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

57 files changed

+628
-663
lines changed

‎docs/cli/coder_config-ssh.md

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,68 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder config-ssh
32

3+
# coder config-ssh
44

55
Add an SSH Host entry for your workspaces "ssh coder.workspace"
66

77
## Usage
8+
89
```console
910
coder config-ssh [flags]
1011
```
1112

1213
## Examples
14+
1315
```console
14-
- You can use -o (or --ssh-option) so set SSH options to be used for all your
15-
workspaces:
16+
- You can use -o (or --ssh-option) so set SSH options to be used for all your
17+
workspaces:
1618

17-
$ coder config-ssh -o ForwardAgent=yes
19+
$ coder config-ssh -o ForwardAgent=yes
1820

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

21-
$ coder config-ssh --dry-run
23+
$ coder config-ssh --dry-run
2224
```
2325

24-
2526
## Flags
27+
2628
### --dry-run, -n
29+
2730
Perform a trial run with no changes made, showing a diff at the end.
2831
<br/>
2932
| | |
3033
| --- | --- |
31-
| Default | <code>false</code> |
32-
33-
34+
| Default | <code>false</code> |
3435

3536
### --ssh-config-file
37+
3638
Specifies the path to an SSH config.
3739
<br/>
3840
| | |
3941
| --- | --- |
4042
| Consumes | <code>$CODER_SSH_CONFIG_FILE</code> |
41-
| Default | <code>~/.ssh/config</code> |
42-
43-
43+
| Default | <code>~/.ssh/config</code> |
4444

4545
### --ssh-option, -o
46+
4647
Specifies additional SSH options to embed in each host stanza.
4748
<br/>
4849
| | |
4950
| --- | --- |
50-
| Default | <code>[]</code> |
51-
52-
51+
| Default | <code>[]</code> |
5352

5453
### --use-previous-options
54+
5555
Specifies whether or not to keep options from previous run of config-ssh.
5656
<br/>
5757
| | |
5858
| --- | --- |
5959
| Consumes | <code>$CODER_SSH_USE_PREVIOUS_OPTIONS</code> |
60-
| Default | <code>false</code> |
61-
62-
60+
| Default | <code>false</code> |
6361

6462
### --yes, -y
63+
6564
Bypass prompts
6665
<br/>
6766
| | |
6867
| --- | --- |
69-
| Default | <code>false</code> |
70-
71-
68+
| Default | <code>false</code> |

‎docs/cli/coder_create.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,62 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder create
32

3+
# coder create
44

55
Create a workspace
66

77
## Usage
8+
89
```console
910
coder create [name] [flags]
1011
```
1112

12-
1313
## Flags
14+
1415
### --parameter-file
16+
1517
Specify a file path with parameter values.
1618
<br/>
1719
| | |
1820
| --- | --- |
1921
| Consumes | <code>$CODER_PARAMETER_FILE</code> |
2022

2123
### --rich-parameter-file
24+
2225
Specify a file path with values for rich parameters defined in the template.
2326
<br/>
2427
| | |
2528
| --- | --- |
2629
| Consumes | <code>$CODER_RICH_PARAMETER_FILE</code> |
2730

2831
### --start-at
32+
2933
Specify the workspace autostart schedule. Check `coder schedule start --help` for the syntax.
3034
<br/>
3135
| | |
3236
| --- | --- |
3337
| Consumes | <code>$CODER_WORKSPACE_START_AT</code> |
3438

3539
### --stop-after
40+
3641
Specify a duration after which the workspace should shut down (e.g. 8h).
3742
<br/>
3843
| | |
3944
| --- | --- |
4045
| Consumes | <code>$CODER_WORKSPACE_STOP_AFTER</code> |
41-
| Default | <code>8h0m0s</code> |
42-
43-
46+
| Default | <code>8h0m0s</code> |
4447

4548
### --template, -t
49+
4650
Specify a template name.
4751
<br/>
4852
| | |
4953
| --- | --- |
5054
| Consumes | <code>$CODER_TEMPLATE_NAME</code> |
5155

5256
### --yes, -y
57+
5358
Bypass prompts
5459
<br/>
5560
| | |
5661
| --- | --- |
57-
| Default | <code>false</code> |
58-
59-
62+
| Default | <code>false</code> |

‎docs/cli/coder_delete.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder delete
32

3+
# coder delete
44

55
Delete a workspace
66

77
## Usage
8+
89
```console
910
coder delete <workspace> [flags]
1011
```
1112

12-
1313
## Flags
14+
1415
### --orphan
16+
1517
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.
1618
<br/>
1719
| | |
1820
| --- | --- |
19-
| Default | <code>false</code> |
20-
21-
21+
| Default | <code>false</code> |
2222

2323
### --yes, -y
24+
2425
Bypass prompts
2526
<br/>
2627
| | |
2728
| --- | --- |
28-
| Default | <code>false</code> |
29-
30-
29+
| Default | <code>false</code> |

‎docs/cli/coder_dotfiles.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder dotfiles
32

3+
# coder dotfiles
44

55
Checkout and install a dotfiles repository from a Git URL
66

77
## Usage
8+
89
```console
910
coder dotfiles [git_repo_url] [flags]
1011
```
1112

1213
## Examples
14+
1315
```console
14-
- Check out and install a dotfiles repository without prompts:
16+
- Check out and install a dotfiles repository without prompts:
1517

16-
$ coder dotfiles --yes git@github.com:example/dotfiles.git
18+
$ coder dotfiles --yes git@github.com:example/dotfiles.git
1719
```
1820

19-
2021
## Flags
22+
2123
### --symlink-dir
24+
2225
Specifies the directory for the dotfiles symlink destinations. If empty will use $HOME.
2326
<br/>
2427
| | |
2528
| --- | --- |
2629
| Consumes | <code>$CODER_SYMLINK_DIR</code> |
2730

2831
### --yes, -y
32+
2933
Bypass prompts
3034
<br/>
3135
| | |
3236
| --- | --- |
33-
| Default | <code>false</code> |
34-
35-
37+
| Default | <code>false</code> |

‎docs/cli/coder_list.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,45 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder list
32

3+
# coder list
44

55
List workspaces
66

77
## Usage
8+
89
```console
910
coder list [flags]
1011
```
1112

12-
1313
## Flags
14+
1415
### --all, -a
16+
1517
Specifies whether all workspaces will be listed or not.
1618
<br/>
1719
| | |
1820
| --- | --- |
19-
| Default | <code>false</code> |
20-
21-
21+
| Default | <code>false</code> |
2222

2323
### --column, -c
24+
2425
Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after
2526
<br/>
2627
| | |
2728
| --- | --- |
28-
| Default | <code>[workspace,template,status,last built,outdated,starts at,stops after]</code> |
29-
30-
29+
| Default | <code>[workspace,template,status,last built,outdated,starts at,stops after]</code> |
3130

3231
### --output, -o
32+
3333
Output format. Available formats: table, json
3434
<br/>
3535
| | |
3636
| --- | --- |
37-
| Default | <code>table</code> |
38-
39-
37+
| Default | <code>table</code> |
4038

4139
### --search
40+
4241
Search for a workspace with a query.
4342
<br/>
4443
| | |
4544
| --- | --- |
46-
| Default | <code>owner:me</code> |
47-
48-
45+
| Default | <code>owner:me</code> |

‎docs/cli/coder_login.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,44 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder login
32

3+
# coder login
44

55
Authenticate with Coder deployment
66

77
## Usage
8+
89
```console
910
coder login <url> [flags]
1011
```
1112

12-
1313
## Flags
14+
1415
### --first-user-email
16+
1517
Specifies an email address to use if creating the first user for the deployment.
1618
<br/>
1719
| | |
1820
| --- | --- |
1921
| Consumes | <code>$CODER_FIRST_USER_EMAIL</code> |
2022

2123
### --first-user-password
24+
2225
Specifies a password to use if creating the first user for the deployment.
2326
<br/>
2427
| | |
2528
| --- | --- |
2629
| Consumes | <code>$CODER_FIRST_USER_PASSWORD</code> |
2730

2831
### --first-user-trial
32+
2933
Specifies whether a trial license should be provisioned for the Coder deployment or not.
3034
<br/>
3135
| | |
3236
| --- | --- |
3337
| Consumes | <code>$CODER_FIRST_USER_TRIAL</code> |
34-
| Default | <code>false</code> |
35-
36-
38+
| Default | <code>false</code> |
3739

3840
### --first-user-username
41+
3942
Specifies a username to use if creating the first user for the deployment.
4043
<br/>
4144
| | |

‎docs/cli/coder_logout.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
<!-- DO NOT EDIT | GENERATED CONTENT -->
2-
# coder logout
32

3+
# coder logout
44

55
Unauthenticate your local session
66

77
## Usage
8+
89
```console
910
coder logout [flags]
1011
```
1112

12-
1313
## Flags
14+
1415
### --yes, -y
16+
1517
Bypass prompts
1618
<br/>
1719
| | |
1820
| --- | --- |
19-
| Default | <code>false</code> |
20-
21-
21+
| Default | <code>false</code> |

0 commit comments

Comments
 (0)