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
+11 -31
View File
@@ -1,38 +1,18 @@
## coder state
<!-- DO NOT EDIT | GENERATED CONTENT -->
# coder state
Manually manage Terraform state to fix broken workspaces
```
## Usage
```console
coder state [flags]
```
### Options
## Subcommands
```
-h, --help help for state
```
### Options inherited from parent commands
```
--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
```
### SEE ALSO
- [coder](coder.md) -
- [coder state pull](coder_state_pull.md) -
- [coder state push](coder_state_push.md) -
| Name | Purpose |
| --------------------------------------- | --------------------------------------------- |
| [<code>pull</code>](./coder_state_pull) | Pull a Terraform state file from a workspace. |
| [<code>push</code>](./coder_state_push) | Push a Terraform state file to a workspace. |