synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/cli/coder_update.md
View File

@ -1,41 +1,37 @@
## coder update
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder update
Update a workspace
```
## Usage
```console
coder update <workspace> [flags]
```
### Options
## Flags
```
--always-prompt Always prompt all parameters. Does not pull parameter values from existing workspace
-h, --help help for update
--parameter-file string Specify a file path with parameter values.
Consumes $CODER_PARAMETER_FILE
--rich-parameter-file string Specify a file path with values for rich parameters defined in the template.
Consumes $CODER_RICH_PARAMETER_FILE
```
### --always-prompt
### Options inherited from parent commands
Always prompt all parameters. Does not pull parameter values from existing workspace
<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
```
### --parameter-file
### SEE ALSO
Specify a file path with parameter values.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_PARAMETER_FILE</code> |
- [coder](coder.md) -
### --rich-parameter-file
Specify a file path with values for rich parameters defined in the template.
<br/>
| | |
| --- | --- |
| Consumes | <code>$CODER_RICH_PARAMETER_FILE</code> |