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

This commit is contained in:
Ammar Bandukwala
2023-02-23 01:53:21 +00:00
committed by GitHub
parent 43e8ba0811
commit f6a8c360e5
71 changed files with 2342 additions and 2087 deletions
+54 -32
View File
@@ -1,43 +1,65 @@
## coder templates edit
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder templates edit
Edit the metadata of a template by name.
```
## Usage
```console
coder templates edit <template> [flags]
```
### Options
## Flags
```
--allow-user-cancel-workspace-jobs Allow users to cancel in-progress workspace jobs. (default true)
--default-ttl duration Edit the template default time before shutdown - workspaces created from this template to this value.
--description string Edit the template description
--display-name string Edit the template display name
-h, --help help for edit
--icon string Edit the template icon path
--name string Edit the template name
-y, --yes Bypass prompts
```
### --allow-user-cancel-workspace-jobs
### Options inherited from parent commands
Allow users to cancel in-progress workspace jobs.
<br/>
| | |
| --- | --- |
| Default | <code>true</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
```
### --default-ttl
### SEE ALSO
Edit the template default time before shutdown - workspaces created from this template to this value.
<br/>
| | |
| --- | --- |
| Default | <code>0s</code> |
- [coder templates](coder_templates.md) - Manage templates
### --description
Edit the template description
<br/>
| | |
| --- | --- |
### --display-name
Edit the template display name
<br/>
| | |
| --- | --- |
### --icon
Edit the template icon path
<br/>
| | |
| --- | --- |
### --name
Edit the template name
<br/>
| | |
| --- | --- |
### --yes, -y
Bypass prompts
<br/>
| | |
| --- | --- |
| Default | <code>false</code> |