feat(docs): rework CLI docs (#6312)

This commit is contained in:
Ammar Bandukwala
2023-02-22 19:53:21 -06:00
committed by GitHub
parent 43e8ba0811
commit f6a8c360e5
71 changed files with 2342 additions and 2087 deletions

View File

@ -1,44 +1,74 @@
## coder templates push
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates push
Push a new template version from the current directory or as specified by flag
```
## Usage
```console
coder templates push [template] [flags]
```
### Options
## Flags
```
--always-prompt Always prompt all parameters. Does not pull parameter values from active template version
-d, --directory string Specify the directory to create from, use '-' to read tar from stdin (default "<current-directory>")
-h, --help help for push
--name string Specify a name for the new template version. It will be automatically generated if not provided.
--parameter-file string Specify a file path with parameter values.
--provisioner-tag stringArray Specify a set of tags to target provisioner daemons.
--variable stringArray Specify a set of values for Terraform-managed variables.
--variables-file string Specify a file path with values for Terraform-managed variables.
-y, --yes Bypass prompts
```
### --always-prompt
### Options inherited from parent commands
Always prompt all parameters. Does not pull parameter values from active template version
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |
```
--global-config coder Path to the global coder config directory.
Consumes $CODER_CONFIG_DIR (default "~/.config/coderv2")
--header stringArray HTTP headers added to all requests. Provide as "Key=Value".
Consumes $CODER_HEADER
--no-feature-warning Suppress warnings about unlicensed features.
Consumes $CODER_NO_FEATURE_WARNING
--no-version-warning Suppress warning when client and server versions do not match.
Consumes $CODER_NO_VERSION_WARNING
--token string Specify an authentication token. For security reasons setting CODER_SESSION_TOKEN is preferred.
Consumes $CODER_SESSION_TOKEN
--url string URL to a deployment.
Consumes $CODER_URL
-v, --verbose Enable verbose output.
Consumes $CODER_VERBOSE
```
### --directory, -d
### SEE ALSO
Specify the directory to create from, use '-' to read tar from stdin
<br/>
| | |
| --- | --- |
| Default | <code>.</code> |
- [coder templates](coder_templates.md) - Manage templates
### --name
Specify a name for the new template version. It will be automatically generated if not provided.
<br/>
| | |
| --- | --- |
### --parameter-file
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
### --provisioner-tag
Specify a set of tags to target provisioner daemons.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variable
Specify a set of values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
| Default | <code>[]</code> |
### --variables-file
Specify a file path with values for Terraform-managed variables.
<br/>
| | |
| --- | --- |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |