Files
coder/docs/reference/cli/secret_update.md
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

63 lines
1.5 KiB
Markdown
Raw Normal View History

---
# Code generated by make gen. DO NOT EDIT.
title: secret update
description: Update a secret
---
<!-- DO NOT EDIT | GENERATED CONTENT -->
Update a secret
## Usage
```console
coder secret update [flags] <name>
```
## Description
```console
At least one of --value, --description, --env, --file, or --enabled must be specified. Provide the secret value by at most one of --value or non-interactive stdin (pipe or redirect).
```
## Options
### --value
| | |
|------|---------------------|
| Type | <code>string</code> |
Update the secret value. For security reasons, prefer non-interactive stdin (pipe or redirect).
### --description
| | |
|------|---------------------|
| Type | <code>string</code> |
Update the secret description. Pass an empty string to clear it.
### --env
| | |
|------|---------------------|
| Type | <code>string</code> |
Name of the workspace environment variable that this secret will set. Pass an empty string to clear it.
### --file
| | |
|------|---------------------|
| Type | <code>string</code> |
Workspace file path where this secret will be written. Must start with ~/ or /. Pass an empty string to clear it.
### --enabled
| | |
|------|-------------------|
| Type | <code>bool</code> |
Whether the secret is injected into workspaces. An enabled secret must keep at least one of --env or --file; pass --enabled=false to stop injecting it without deleting it.