Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

Commit 419a882

Browse files
cmoogcmoog
committed
Link to auto-generated docs
1 parent c3d6592 commit 419a882

21 files changed

+551
-2
lines changed

‎README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22

33
`coder` is a command line utility for Coder Enterprise.
44

5-
To view usage documentation, head over to [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).
6-
75
To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new).
86

7+
## Usage
8+
9+
View the `coder-cli` documentation [here](./docs/coder.md).
10+
11+
You can find additional Coder Enterprise usage documentation on [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).
12+
913
## Install Release
1014

1115
Download the latest [release](https://github.com/cdr/coder-cli/releases):

‎docs/coder.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## coder
2+
3+
coder provides a CLI for working with an existing Coder Enterprise installation
4+
5+
### Synopsis
6+
7+
coder provides a CLI for working with an existing Coder Enterprise installation
8+
9+
### Options
10+
11+
```
12+
-h, --help help for coder
13+
```
14+
15+
### SEE ALSO
16+
17+
* [coder completion](coder_completion.md) - Generate completion script
18+
* [coder config-ssh](coder_config-ssh.md) - Configure SSH to access Coder environments
19+
* [coder envs](coder_envs.md) - Interact with Coder environments
20+
* [coder login](coder_login.md) - Authenticate this client for future operations
21+
* [coder logout](coder_logout.md) - Remove local authentication credentials if any exist
22+
* [coder secrets](coder_secrets.md) - Interact with Coder Secrets
23+
* [coder sh](coder_sh.md) - Open a shell and execute commands in a Coder environment
24+
* [coder sync](coder_sync.md) - Establish a one way directory sync to a Coder environment
25+
* [coder urls](coder_urls.md) - Interact with environment DevURLs
26+
* [coder users](coder_users.md) - Interact with Coder user accounts
27+

‎docs/coder_completion.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
## coder completion
2+
3+
Generate completion script
4+
5+
### Synopsis
6+
7+
To load completions:
8+
9+
Bash:
10+
11+
$ source <(yourprogram completion bash)
12+
13+
# To load completions for each session, execute once:
14+
Linux:
15+
$ yourprogram completion bash > /etc/bash_completion.d/yourprogram
16+
MacOS:
17+
$ yourprogram completion bash > /usr/local/etc/bash_completion.d/yourprogram
18+
19+
Zsh:
20+
21+
# If shell completion is not already enabled in your environment you will need
22+
# to enable it. You can execute the following once:
23+
24+
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
25+
26+
# To load completions for each session, execute once:
27+
$ yourprogram completion zsh > "${fpath[1]}/_yourprogram"
28+
29+
# You will need to start a new shell for this setup to take effect.
30+
31+
Fish:
32+
33+
$ yourprogram completion fish | source
34+
35+
# To load completions for each session, execute once:
36+
$ yourprogram completion fish > ~/.config/fish/completions/yourprogram.fish
37+
38+
39+
```
40+
coder completion [bash|zsh|fish|powershell]
41+
```
42+
43+
### Options
44+
45+
```
46+
-h, --help help for completion
47+
```
48+
49+
### SEE ALSO
50+
51+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
52+

‎docs/coder_config-ssh.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## coder config-ssh
2+
3+
Configure SSH to access Coder environments
4+
5+
### Synopsis
6+
7+
Inject the proper OpenSSH configuration into your local SSH config file.
8+
9+
```
10+
coder config-ssh [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
--filepath string overide the default path of your ssh config file (default "/Users/charlesmoog/.ssh/config")
17+
-h, --help help for config-ssh
18+
--remove remove the auto-generated Coder Enterprise ssh config
19+
```
20+
21+
### SEE ALSO
22+
23+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
24+

‎docs/coder_envs.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## coder envs
2+
3+
Interact with Coder environments
4+
5+
### Synopsis
6+
7+
Perform operations on the Coder environments owned by the active user.
8+
9+
### Options
10+
11+
```
12+
-h, --help help for envs
13+
--user string Specify the user whose resources to target (default "me")
14+
```
15+
16+
### SEE ALSO
17+
18+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
19+
* [coder envs ls](coder_envs_ls.md) - list all environments owned by the active user
20+

‎docs/coder_envs_ls.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## coder envs ls
2+
3+
list all environments owned by the active user
4+
5+
### Synopsis
6+
7+
List all Coder environments owned by the active user.
8+
9+
```
10+
coder envs ls [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for ls
17+
-o, --output string human | json (default "human")
18+
```
19+
20+
### Options inherited from parent commands
21+
22+
```
23+
--user string Specify the user whose resources to target (default "me")
24+
```
25+
26+
### SEE ALSO
27+
28+
* [coder envs](coder_envs.md) - Interact with Coder environments
29+

‎docs/coder_login.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## coder login
2+
3+
Authenticate this client for future operations
4+
5+
### Synopsis
6+
7+
Authenticate this client for future operations
8+
9+
```
10+
coder login [Coder Enterprise URL eg. http://my.coder.domain/] [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for login
17+
```
18+
19+
### SEE ALSO
20+
21+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
22+

‎docs/coder_logout.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## coder logout
2+
3+
Remove local authentication credentials if any exist
4+
5+
### Synopsis
6+
7+
Remove local authentication credentials if any exist
8+
9+
```
10+
coder logout [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help help for logout
17+
```
18+
19+
### SEE ALSO
20+
21+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
22+

‎docs/coder_secrets.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## coder secrets
2+
3+
Interact with Coder Secrets
4+
5+
### Synopsis
6+
7+
Interact with secrets objects owned by the active user.
8+
9+
### Options
10+
11+
```
12+
-h, --help help for secrets
13+
--user string Specify the user whose resources to target (default "me")
14+
```
15+
16+
### SEE ALSO
17+
18+
* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation
19+
* [coder secrets create](coder_secrets_create.md) - Create a new secret
20+
* [coder secrets ls](coder_secrets_ls.md) - List all secrets owned by the active user
21+
* [coder secrets rm](coder_secrets_rm.md) - Remove one or more secrets by name
22+
* [coder secrets view](coder_secrets_view.md) - View a secret by name
23+

‎docs/coder_secrets_create.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## coder secrets create
2+
3+
Create a new secret
4+
5+
### Synopsis
6+
7+
Create a new secret object to store application secrets and access them securely from within your environments.
8+
9+
```
10+
coder secrets create [secret_name] [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
coder secrets create mysql-password --from-literal 123password
17+
coder secrets create mysql-password --from-prompt
18+
coder secrets create aws-credentials --from-file ./credentials.json
19+
```
20+
21+
### Options
22+
23+
```
24+
--description string a description of the secret
25+
--from-file string a file from which to read the value of the secret
26+
--from-literal string the value of the secret
27+
--from-prompt enter the secret value through a terminal prompt
28+
-h, --help help for create
29+
```
30+
31+
### Options inherited from parent commands
32+
33+
```
34+
--user string Specify the user whose resources to target (default "me")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [coder secrets](coder_secrets.md) - Interact with Coder Secrets
40+

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy