Link to auto-generated docs

cmoog · cmoog · commit b9ebf97a834e · 2020-08-12T21:58:05.000-05:00
diff --git a/README.md b/README.md
@@ -2,10 +2,14 @@
 
 `coder` is a command line utility for Coder Enterprise.
 
-To view usage documentation, head over to [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).
-
 To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new).
 
+## Usage
+
+View the `coder-cli` documentation [here](./docs/coder.md).
+
+You can find additional Coder Enterprise usage documentation on [https://enterprise.coder.com](https://enterprise.coder.com/docs/getting-started).
+
 ## Install Release
 
 Download the latest [release](https://github.com/cdr/coder-cli/releases):
diff --git a/docs/coder.md b/docs/coder.md
@@ -0,0 +1,26 @@
+## coder
+
+coder provides a CLI for working with an existing Coder Enterprise installation
+
+### Synopsis
+
+coder provides a CLI for working with an existing Coder Enterprise installation
+
+### Options
+
+```
+  -h, --help   help for coder
+```
+
+### SEE ALSO
+
+* [coder config-ssh](coder_config-ssh.md)	 - Configure SSH to access Coder environments
+* [coder envs](coder_envs.md)	 - Interact with Coder environments
+* [coder login](coder_login.md)	 - Authenticate this client for future operations
+* [coder logout](coder_logout.md)	 - Remove local authentication credentials if any exist
+* [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
+* [coder sh](coder_sh.md)	 - Open a shell and execute commands in a Coder environment
+* [coder sync](coder_sync.md)	 - Establish a one way directory sync to a Coder environment
+* [coder urls](coder_urls.md)	 - Interact with environment DevURLs
+* [coder users](coder_users.md)	 - Interact with Coder user accounts
+
diff --git a/docs/coder_config-ssh.md b/docs/coder_config-ssh.md
@@ -0,0 +1,24 @@
+## coder config-ssh
+
+Configure SSH to access Coder environments
+
+### Synopsis
+
+Inject the proper OpenSSH configuration into your local SSH config file.
+
+```
+coder config-ssh [flags]
+```
+
+### Options
+
+```
+      --filepath string   overide the default path of your ssh config file (default "~/.ssh/config")
+  -h, --help              help for config-ssh
+      --remove            remove the auto-generated Coder Enterprise ssh config
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/docs/coder_envs.md b/docs/coder_envs.md
@@ -0,0 +1,20 @@
+## coder envs
+
+Interact with Coder environments
+
+### Synopsis
+
+Perform operations on the Coder environments owned by the active user.
+
+### Options
+
+```
+  -h, --help          help for envs
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+* [coder envs ls](coder_envs_ls.md)	 - list all environments owned by the active user
+
diff --git a/docs/coder_envs_ls.md b/docs/coder_envs_ls.md
@@ -0,0 +1,29 @@
+## coder envs ls
+
+list all environments owned by the active user
+
+### Synopsis
+
+List all Coder environments owned by the active user.
+
+```
+coder envs ls [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for ls
+  -o, --output string   human | json (default "human")
+```
+
+### Options inherited from parent commands
+
+```
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder envs](coder_envs.md)	 - Interact with Coder environments
+
diff --git a/docs/coder_login.md b/docs/coder_login.md
@@ -0,0 +1,22 @@
+## coder login
+
+Authenticate this client for future operations
+
+### Synopsis
+
+Authenticate this client for future operations
+
+```
+coder login [Coder Enterprise URL eg. http://my.coder.domain/] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for login
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/docs/coder_logout.md b/docs/coder_logout.md
@@ -0,0 +1,22 @@
+## coder logout
+
+Remove local authentication credentials if any exist
+
+### Synopsis
+
+Remove local authentication credentials if any exist
+
+```
+coder logout [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for logout
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/docs/coder_secrets.md b/docs/coder_secrets.md
@@ -0,0 +1,23 @@
+## coder secrets
+
+Interact with Coder Secrets
+
+### Synopsis
+
+Interact with secrets objects owned by the active user.
+
+### Options
+
+```
+  -h, --help          help for secrets
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+* [coder secrets create](coder_secrets_create.md)	 - Create a new secret
+* [coder secrets ls](coder_secrets_ls.md)	 - List all secrets owned by the active user
+* [coder secrets rm](coder_secrets_rm.md)	 - Remove one or more secrets by name
+* [coder secrets view](coder_secrets_view.md)	 - View a secret by name
+
diff --git a/docs/coder_secrets_create.md b/docs/coder_secrets_create.md
@@ -0,0 +1,40 @@
+## coder secrets create
+
+Create a new secret
+
+### Synopsis
+
+Create a new secret object to store application secrets and access them securely from within your environments.
+
+```
+coder secrets create [secret_name] [flags]
+```
+
+### Examples
+
+```
+coder secrets create mysql-password --from-literal 123password
+coder secrets create mysql-password --from-prompt
+coder secrets create aws-credentials --from-file ./credentials.json
+```
+
+### Options
+
+```
+      --description string    a description of the secret
+      --from-file string      a file from which to read the value of the secret
+      --from-literal string   the value of the secret
+      --from-prompt           enter the secret value through a terminal prompt
+  -h, --help                  help for create
+```
+
+### Options inherited from parent commands
+
+```
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
+
diff --git a/docs/coder_secrets_ls.md b/docs/coder_secrets_ls.md
@@ -0,0 +1,28 @@
+## coder secrets ls
+
+List all secrets owned by the active user
+
+### Synopsis
+
+List all secrets owned by the active user
+
+```
+coder secrets ls [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for ls
+```
+
+### Options inherited from parent commands
+
+```
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
+
diff --git a/docs/coder_secrets_rm.md b/docs/coder_secrets_rm.md
@@ -0,0 +1,34 @@
+## coder secrets rm
+
+Remove one or more secrets by name
+
+### Synopsis
+
+Remove one or more secrets by name
+
+```
+coder secrets rm [...secret_name] [flags]
+```
+
+### Examples
+
+```
+coder secrets rm mysql-password mysql-user
+```
+
+### Options
+
+```
+  -h, --help   help for rm
+```
+
+### Options inherited from parent commands
+
+```
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
+
diff --git a/docs/coder_secrets_view.md b/docs/coder_secrets_view.md
@@ -0,0 +1,34 @@
+## coder secrets view
+
+View a secret by name
+
+### Synopsis
+
+View a secret by name
+
+```
+coder secrets view [secret_name] [flags]
+```
+
+### Examples
+
+```
+coder secrets view mysql-password
+```
+
+### Options
+
+```
+  -h, --help   help for view
+```
+
+### Options inherited from parent commands
+
+```
+      --user string   Specify the user whose resources to target (default "me")
+```
+
+### SEE ALSO
+
+* [coder secrets](coder_secrets.md)	 - Interact with Coder Secrets
+
diff --git a/docs/coder_sh.md b/docs/coder_sh.md
@@ -0,0 +1,28 @@
+## coder sh
+
+Open a shell and execute commands in a Coder environment
+
+### Synopsis
+
+Execute a remote command on the environment\nIf no command is specified, the default shell is opened.
+
+```
+coder sh [environment_name] [<command [args...]>] [flags]
+```
+
+### Examples
+
+```
+coder sh backend-env
+```
+
+### Options
+
+```
+  -h, --help   help for sh
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/docs/coder_sync.md b/docs/coder_sync.md
@@ -0,0 +1,23 @@
+## coder sync
+
+Establish a one way directory sync to a Coder environment
+
+### Synopsis
+
+Establish a one way directory sync to a Coder environment
+
+```
+coder sync [local directory] [<env name>:<remote directory>] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for sync
+      --init   do initial transfer and exit
+```
+
+### SEE ALSO
+
+* [coder](coder.md)	 - coder provides a CLI for working with an existing Coder Enterprise installation
+
diff --git a/docs/coder_urls.md b/docs/coder_urls.md
diff --git a/docs/coder_urls_create.md b/docs/coder_urls_create.md
diff --git a/docs/coder_urls_ls.md b/docs/coder_urls_ls.md
diff --git a/docs/coder_urls_rm.md b/docs/coder_urls_rm.md
diff --git a/docs/coder_users.md b/docs/coder_users.md
diff --git a/docs/coder_users_ls.md b/docs/coder_users_ls.md
diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go
