Skip to content

Remove refs to cli repo docs, move cli reference in #1234

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.

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 3 commits into from
Mar 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions cli/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Command line

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

<children></children>

## Full CLI reference

For a full list of the Coder CLI commands available, see the
[reference pages](https://github.com/coder/coder-cli/blob/master/docs/coder.md).
[reference pages](./reference/coder).
2 changes: 1 addition & 1 deletion cli/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ brew install cdr/coder/coder-cli

### Download (Linux, Mac)

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

1. Click a release and download the tar file for your operating system (ex:
`coder-cli-linux-amd64.tar.gz`)
Expand Down
34 changes: 34 additions & 0 deletions cli/reference/coder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- markdownlint-disable MD044 -->

# coder

coder provides a CLI for working with an existing Coder installation

### Options

```text
-h, --help help for coder
-v, --verbose show verbose output
```

### SEE ALSO

- [coder completion](coder_completion.md) - Generate completion script
- [coder config-ssh](coder_config-ssh.md) - Configure SSH to access Coder
workspaces
- [coder images](coder_images.md) - Manage Coder images
- [coder login](coder_login.md) - Authenticate this client for future operations
- [coder logout](coder_logout.md) - Remove local authentication credentials if
any exist
- [coder satellites](coder_satellites.md) - Interact with Coder satellite
deployments
- [coder ssh](coder_ssh.md) - Enter a shell of execute a command over SSH into a
Coder workspace
- [coder sync](coder_sync.md) - Establish a one way directory sync to a Coder
workspace
- [coder tokens](coder_tokens.md) - manage Coder API tokens for the active user
- [coder tunnel](coder_tunnel.md) - proxies a port on the workspace to localhost
- [coder update](coder_update.md) - Update coder binary
- [coder urls](coder_urls.md) - Interact with workspace DevURLs
- [coder users](coder_users.md) - Interact with Coder user accounts
- [coder workspaces](coder_workspaces.md) - Interact with Coder workspaces
75 changes: 75 additions & 0 deletions cli/reference/coder_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# coder completion

Generate completion script

### Synopsis

To load completions:

Bash:

```bash
source <(coder completion bash)
```

To load completions for each session, execute once: Linux:

```bash
coder completion bash > /etc/bash_completion.d/coder
```

MacOS:

```bash
coder completion bash > /usr/local/etc/bash_completion.d/coder`
```

Zsh:

If shell completion is not already enabled in your workspace you will need to
enable it. You can execute the following once:

```zsh
echo "autoload -U compinit; compinit" >> ~/.zshrc
```

To load completions for each session, execute once:

```zsh
coder completion zsh > "${fpath[1]}/_coder"
```

You will need to start a new shell for this setup to take effect.

Fish:

```fish
coder completion fish | source
```

To load completions for each session, execute once:

```fish
coder completion fish > ~/.config/fish/completions/coder.fish
```

```fish
coder completion [bash|zsh|fish|powershell]
```

### Options

```text
-h, --help help for completion
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
31 changes: 31 additions & 0 deletions cli/reference/coder_config-ssh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# coder config-ssh

Configure SSH to access Coder workspaces

### Synopsis

Inject the proper OpenSSH configuration into your local SSH config file.

```text
coder config-ssh [flags]
```

### Options

```text
--filepath string override the default path of your ssh config file (default "~/.ssh/config")
-h, --help help for config-ssh
-o, --option strings additional options injected in the ssh config (ex. disable caching with "-o ControlPath=none")
--remove remove the auto-generated Coder ssh config
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
27 changes: 27 additions & 0 deletions cli/reference/coder_images.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# coder images

Manage Coder images

### Synopsis

Manage existing images and/or import new ones.

### Options

```text
-h, --help help for images
--user string Specifies the user by email (default "me")
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
- [coder images ls](coder_images_ls.md) - list all images available to the
active user
30 changes: 30 additions & 0 deletions cli/reference/coder_images_ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# coder images ls

list all images available to the active user

### Synopsis

List all Coder images available to the active user.

```text
coder images ls [flags]
```

### Options

```text
-h, --help help for ls
--org string organization name
--output string human | json (default "human")
```

### Options inherited from parent commands

```text
--user string Specifies the user by email (default "me")
-v, --verbose show verbose output
```

### SEE ALSO

- [coder images](coder_images.md) - Manage Coder images
24 changes: 24 additions & 0 deletions cli/reference/coder_login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# coder login

Authenticate this client for future operations

```text
coder login [Coder URL eg. https://my.coder.domain/] [flags]
```

### Options

```text
-h, --help help for login
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
24 changes: 24 additions & 0 deletions cli/reference/coder_logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# coder logout

Remove local authentication credentials if any exist

```text
coder logout [flags]
```

### Options

```text
-h, --help help for logout
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
28 changes: 28 additions & 0 deletions cli/reference/coder_satellites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# coder satellites

Interact with Coder satellite deployments

### Synopsis

Perform operations on the Coder satellites for the platform.

### Options

```text
-h, --help help for satellites
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder](coder.md) - coder provides a CLI for working with an existing Coder
installation
- [coder satellites create](coder_satellites_create.md) - create a new
satellite.
- [coder satellites ls](coder_satellites_ls.md) - list satellites.
- [coder satellites rm](coder_satellites_rm.md) - remove a satellite.
36 changes: 36 additions & 0 deletions cli/reference/coder_satellites_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# coder satellites create

create a new satellite.

### Synopsis

Create a new Coder satellite.

```text
coder satellites create [name] [satellite_access_url] [flags]
```

### Examples

```text
# create a new satellite

coder satellites create eu-west https://eu-west.coder.com
```

### Options

```text
-h, --help help for create
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder satellites](coder_satellites.md) - Interact with Coder satellite
deployments
35 changes: 35 additions & 0 deletions cli/reference/coder_satellites_ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# coder satellites ls

list satellites.

### Synopsis

List all Coder workspace satellites.

```text
coder satellites ls [flags]
```

### Examples

```text
# list satellites
coder satellites ls
```

### Options

```text
-h, --help help for ls
```

### Options inherited from parent commands

```text
-v, --verbose show verbose output
```

### SEE ALSO

- [coder satellites](coder_satellites.md) - Interact with Coder satellite
deployments
Loading