Skip to content

Commit 13f385d

Browse files
spikecurtisjohnstcn
spikecurtis
and
johnstcn
authored
Remove refs to cli repo docs, move cli reference in (coder#1234)
* Remove refs to cli repo docs, move cli reference in Signed-off-by: Spike Curtis <spike@coder.com> * Add ref to manifest; fix link Signed-off-by: Spike Curtis <spike@coder.com> * Update manifest.json Co-authored-by: Cian Johnston <cian@coder.com> --------- Signed-off-by: Spike Curtis <spike@coder.com> Co-authored-by: Cian Johnston <cian@coder.com>
1 parent 2bbe4cf commit 13f385d

Some content is hidden

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

44 files changed

+1406
-8
lines changed

‎cli/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Command line
22

3-
Coder provides an [open-source CLI](https://github.com/coder/coder-cli) that
4-
allows you to interact with your workspaces using your local machine.
3+
Coder provides a CLI that allows you to interact with your workspaces using your
4+
local machine.
55

66
<children></children>
77

88
## Full CLI reference
99

1010
For a full list of the Coder CLI commands available, see the
11-
[reference pages](https://github.com/coder/coder-cli/blob/master/docs/coder.md).
11+
[reference pages](./reference/coder).

‎cli/installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ brew install cdr/coder/coder-cli
2222

2323
### Download (Linux, Mac)
2424

25-
Download releases [from GitHub](https://github.com/coder/coder-cli/releases):
25+
Download releases [from GitHub](https://github.com/coder/coder-v1-cli/releases):
2626

2727
1. Click a release and download the tar file for your operating system (ex:
2828
`coder-cli-linux-amd64.tar.gz`)

‎cli/reference/coder.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- markdownlint-disable MD044 -->
2+
3+
# coder
4+
5+
coder provides a CLI for working with an existing Coder installation
6+
7+
### Options
8+
9+
```text
10+
-h, --help help for coder
11+
-v, --verbose show verbose output
12+
```
13+
14+
### SEE ALSO
15+
16+
- [coder completion](coder_completion.md) - Generate completion script
17+
- [coder config-ssh](coder_config-ssh.md) - Configure SSH to access Coder
18+
workspaces
19+
- [coder images](coder_images.md) - Manage Coder images
20+
- [coder login](coder_login.md) - Authenticate this client for future operations
21+
- [coder logout](coder_logout.md) - Remove local authentication credentials if
22+
any exist
23+
- [coder satellites](coder_satellites.md) - Interact with Coder satellite
24+
deployments
25+
- [coder ssh](coder_ssh.md) - Enter a shell of execute a command over SSH into a
26+
Coder workspace
27+
- [coder sync](coder_sync.md) - Establish a one way directory sync to a Coder
28+
workspace
29+
- [coder tokens](coder_tokens.md) - manage Coder API tokens for the active user
30+
- [coder tunnel](coder_tunnel.md) - proxies a port on the workspace to localhost
31+
- [coder update](coder_update.md) - Update coder binary
32+
- [coder urls](coder_urls.md) - Interact with workspace DevURLs
33+
- [coder users](coder_users.md) - Interact with Coder user accounts
34+
- [coder workspaces](coder_workspaces.md) - Interact with Coder workspaces

‎cli/reference/coder_completion.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# coder completion
2+
3+
Generate completion script
4+
5+
### Synopsis
6+
7+
To load completions:
8+
9+
Bash:
10+
11+
```bash
12+
source <(coder completion bash)
13+
```
14+
15+
To load completions for each session, execute once: Linux:
16+
17+
```bash
18+
coder completion bash > /etc/bash_completion.d/coder
19+
```
20+
21+
MacOS:
22+
23+
```bash
24+
coder completion bash > /usr/local/etc/bash_completion.d/coder`
25+
```
26+
27+
Zsh:
28+
29+
If shell completion is not already enabled in your workspace you will need to
30+
enable it. You can execute the following once:
31+
32+
```zsh
33+
echo "autoload -U compinit; compinit" >> ~/.zshrc
34+
```
35+
36+
To load completions for each session, execute once:
37+
38+
```zsh
39+
coder completion zsh > "${fpath[1]}/_coder"
40+
```
41+
42+
You will need to start a new shell for this setup to take effect.
43+
44+
Fish:
45+
46+
```fish
47+
coder completion fish | source
48+
```
49+
50+
To load completions for each session, execute once:
51+
52+
```fish
53+
coder completion fish > ~/.config/fish/completions/coder.fish
54+
```
55+
56+
```fish
57+
coder completion [bash|zsh|fish|powershell]
58+
```
59+
60+
### Options
61+
62+
```text
63+
-h, --help help for completion
64+
```
65+
66+
### Options inherited from parent commands
67+
68+
```text
69+
-v, --verbose show verbose output
70+
```
71+
72+
### SEE ALSO
73+
74+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
75+
installation

‎cli/reference/coder_config-ssh.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# coder config-ssh
2+
3+
Configure SSH to access Coder workspaces
4+
5+
### Synopsis
6+
7+
Inject the proper OpenSSH configuration into your local SSH config file.
8+
9+
```text
10+
coder config-ssh [flags]
11+
```
12+
13+
### Options
14+
15+
```text
16+
--filepath string override the default path of your ssh config file (default "~/.ssh/config")
17+
-h, --help help for config-ssh
18+
-o, --option strings additional options injected in the ssh config (ex. disable caching with "-o ControlPath=none")
19+
--remove remove the auto-generated Coder ssh config
20+
```
21+
22+
### Options inherited from parent commands
23+
24+
```text
25+
-v, --verbose show verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
31+
installation

‎cli/reference/coder_images.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# coder images
2+
3+
Manage Coder images
4+
5+
### Synopsis
6+
7+
Manage existing images and/or import new ones.
8+
9+
### Options
10+
11+
```text
12+
-h, --help help for images
13+
--user string Specifies the user by email (default "me")
14+
```
15+
16+
### Options inherited from parent commands
17+
18+
```text
19+
-v, --verbose show verbose output
20+
```
21+
22+
### SEE ALSO
23+
24+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
25+
installation
26+
- [coder images ls](coder_images_ls.md) - list all images available to the
27+
active user

‎cli/reference/coder_images_ls.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# coder images ls
2+
3+
list all images available to the active user
4+
5+
### Synopsis
6+
7+
List all Coder images available to the active user.
8+
9+
```text
10+
coder images ls [flags]
11+
```
12+
13+
### Options
14+
15+
```text
16+
-h, --help help for ls
17+
--org string organization name
18+
--output string human | json (default "human")
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```text
24+
--user string Specifies the user by email (default "me")
25+
-v, --verbose show verbose output
26+
```
27+
28+
### SEE ALSO
29+
30+
- [coder images](coder_images.md) - Manage Coder images

‎cli/reference/coder_login.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# coder login
2+
3+
Authenticate this client for future operations
4+
5+
```text
6+
coder login [Coder URL eg. https://my.coder.domain/] [flags]
7+
```
8+
9+
### Options
10+
11+
```text
12+
-h, --help help for login
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```text
18+
-v, --verbose show verbose output
19+
```
20+
21+
### SEE ALSO
22+
23+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
24+
installation

‎cli/reference/coder_logout.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# coder logout
2+
3+
Remove local authentication credentials if any exist
4+
5+
```text
6+
coder logout [flags]
7+
```
8+
9+
### Options
10+
11+
```text
12+
-h, --help help for logout
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```text
18+
-v, --verbose show verbose output
19+
```
20+
21+
### SEE ALSO
22+
23+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
24+
installation

‎cli/reference/coder_satellites.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# coder satellites
2+
3+
Interact with Coder satellite deployments
4+
5+
### Synopsis
6+
7+
Perform operations on the Coder satellites for the platform.
8+
9+
### Options
10+
11+
```text
12+
-h, --help help for satellites
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```text
18+
-v, --verbose show verbose output
19+
```
20+
21+
### SEE ALSO
22+
23+
- [coder](coder.md) - coder provides a CLI for working with an existing Coder
24+
installation
25+
- [coder satellites create](coder_satellites_create.md) - create a new
26+
satellite.
27+
- [coder satellites ls](coder_satellites_ls.md) - list satellites.
28+
- [coder satellites rm](coder_satellites_rm.md) - remove a satellite.

‎cli/reference/coder_satellites_create.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# coder satellites create
2+
3+
create a new satellite.
4+
5+
### Synopsis
6+
7+
Create a new Coder satellite.
8+
9+
```text
10+
coder satellites create [name] [satellite_access_url] [flags]
11+
```
12+
13+
### Examples
14+
15+
```text
16+
# create a new satellite
17+
18+
coder satellites create eu-west https://eu-west.coder.com
19+
```
20+
21+
### Options
22+
23+
```text
24+
-h, --help help for create
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```text
30+
-v, --verbose show verbose output
31+
```
32+
33+
### SEE ALSO
34+
35+
- [coder satellites](coder_satellites.md) - Interact with Coder satellite
36+
deployments

‎cli/reference/coder_satellites_ls.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# coder satellites ls
2+
3+
list satellites.
4+
5+
### Synopsis
6+
7+
List all Coder workspace satellites.
8+
9+
```text
10+
coder satellites ls [flags]
11+
```
12+
13+
### Examples
14+
15+
```text
16+
# list satellites
17+
coder satellites ls
18+
```
19+
20+
### Options
21+
22+
```text
23+
-h, --help help for ls
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```text
29+
-v, --verbose show verbose output
30+
```
31+
32+
### SEE ALSO
33+
34+
- [coder satellites](coder_satellites.md) - Interact with Coder satellite
35+
deployments

0 commit comments

Comments
 (0)