Skip to content

Commit a59c003

Browse files
committed
Update docs for new commands, shell flags, and encrypt toggle
- CLI reference: Add vault:delete and env:remove command docs - Shell reference: Add unmask flag to history, import command with overwrite/skip-existing/dry-run flags, copy overwrite/dry-run flags - Configuration guide: Add vault deletion and env removal sections - Web UI docs: Document encrypt toggle on create/edit dialog
1 parent 5320799 commit a59c003

5 files changed

Lines changed: 94 additions & 5 deletions

File tree

docs/WEB_UI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The server generates a secure token on startup and automatically injects it into
2929
The main Secrets view provides:
3030
- **Table view** of all secrets with key, value (masked), and modification date
3131
- **Search** with real-time filtering
32+
- **Encrypt toggle** when creating or editing secrets (on by default)
3233
- **Quick actions** menu for each secret:
3334
- Edit value
3435
- Rename key

docs/guide/cli/reference.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,31 @@ List all configured vaults.
4747
keep vault:list
4848
```
4949

50+
## `keep vault:delete`
51+
52+
Delete a vault configuration.
53+
54+
| Option | Type | Default | Description |
55+
|--------|------|---------|-------------|
56+
| `--force` | boolean | `false` | Delete without confirmation |
57+
58+
**Arguments:**
59+
- `[vault]` - Vault slug to delete (prompted if not provided)
60+
61+
**Examples:**
62+
```bash
63+
# Interactive deletion
64+
keep vault:delete
65+
66+
# Delete specific vault
67+
keep vault:delete my-vault
68+
69+
# Force delete without prompt
70+
keep vault:delete my-vault --force
71+
```
72+
73+
**Note:** The default vault cannot be deleted. Change the default vault first with `keep init`. Deleting a vault only removes the local Keep configuration — secrets in the remote vault are not affected.
74+
5075
## `keep env:add`
5176

5277
Add a custom env/environment beyond the standard ones (local, staging, production).
@@ -80,6 +105,31 @@ keep env:add sandbox --no-interaction
80105
- Can contain letters, numbers, hyphens, and underscores
81106
- Examples: `qa`, `demo`, `integration`, `sandbox`, `dev2`, `staging-eu`
82107

108+
## `keep env:remove`
109+
110+
Remove a custom environment.
111+
112+
| Option | Type | Default | Description |
113+
|--------|------|---------|-------------|
114+
| `--force` | boolean | `false` | Remove without confirmation |
115+
116+
**Arguments:**
117+
- `[name]` - Environment name to remove (prompted if not provided)
118+
119+
**Examples:**
120+
```bash
121+
# Interactive removal
122+
keep env:remove
123+
124+
# Remove specific environment
125+
keep env:remove integration
126+
127+
# Force remove without prompt
128+
keep env:remove qa --force
129+
```
130+
131+
**Note:** System environments (local, staging, production) cannot be removed. Removing an environment only updates the local Keep settings — secrets in remote vaults are not affected.
132+
83133
## `keep workspace`
84134

85135
Personalize your workspace by filtering which vaults and envs appear in commands and UI.

docs/guide/configuration.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,17 @@ keep set API_KEY "integration-key" --env=integration
108108
keep copy --only="*" --from=local --to=integration
109109
```
110110

111+
### Remove Custom Environments
112+
113+
You can remove custom environments you've added:
114+
115+
```bash
116+
keep env:remove integration
117+
keep env:remove qa --force # Skip confirmation
118+
```
119+
120+
System environments (local, staging, production) cannot be removed.
121+
111122
## Add a Vault
112123

113124
```bash
@@ -121,6 +132,17 @@ Follow the prompts to configure AWS SSM or Secrets Manager access. After adding
121132

122133
**Note:** AWS credentials must be configured separately from your application secrets. See [AWS Authentication](/guide/aws-authentication) for setup instructions.
123134

135+
### Remove a Vault
136+
137+
You can delete vault configurations if they're no longer needed:
138+
139+
```bash
140+
keep vault:delete
141+
keep vault:delete my-vault --force # Skip confirmation
142+
```
143+
144+
This only removes the local Keep configuration — secrets in the remote vault are not affected. The default vault cannot be deleted.
145+
124146
## Verify Setup
125147

126148
After configuration, verify your access:

docs/guide/shell/reference.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ History for secret: API_KEY
121121
│ 2 │ sk_o**** │ String │ 2024-01-10 14:22:00 │ admin │
122122
│ 1 │ sk_t**** │ String │ 2024-01-05 09:15:00 │ admin │
123123
└─────────┴────────────┴──────────┴─────────────────────┴──────────────┘
124+
125+
>>> history API_KEY unmask # Show actual values
124126
```
125127

126128
**search** - Search for secrets by value
@@ -149,6 +151,9 @@ Found 3 secrets containing "postgres":
149151
>>> copy API_KEY production
150152
✓ Copied API_KEY to production
151153

154+
>>> copy API_KEY production overwrite # Overwrite if exists
155+
>>> copy API_KEY production dry-run # Preview without copying
156+
152157
>>> copy only DB_* staging
153158
✓ Copied 3 secrets matching DB_* to staging
154159

@@ -194,7 +199,16 @@ Summary:
194199
# Quick env format export
195200
```
196201

197-
Note: The `import` command is only available in the CLI, not the shell.
202+
**import** - Import secrets from .env file
203+
```bash
204+
>>> import .env
205+
# Imports secrets from file
206+
207+
>>> import .env overwrite # Overwrite existing secrets
208+
>>> import .env skip-existing # Skip existing secrets
209+
>>> import .env dry-run # Preview without importing
210+
>>> import .env dry-run overwrite # Flags can be combined in any order
211+
```
198212

199213
### Verification
200214

@@ -304,7 +318,7 @@ Secret Management
304318
set <key> <value> Set a secret (alias: s)
305319
delete <key> [force] Delete a secret (alias: d)
306320
show [unmask] Show all secrets (alias: ls)
307-
history <key> View secret history
321+
history <key> [unmask] View secret history
308322
rename <old> <new> Rename a secret
309323
search <query> Search for secrets containing text
310324
copy <key> [destination] Copy single secret
@@ -317,7 +331,8 @@ Context Management
317331
use <vault:env> Switch both vault and env (alias: u)
318332
context Show current context (alias: ctx)
319333

320-
Analysis & Export
334+
Import, Export & Analysis
335+
import <file> [flags] Import secrets from .env file
321336
export Export secrets interactively
322337
verify Verify vault setup and permissions
323338
info Show Keep information
@@ -419,9 +434,9 @@ Many commands become interactive when arguments are omitted:
419434

420435
### CLI-Only Commands
421436
These commands are not available in the shell:
422-
- `import` - Use the CLI: `keep import file.env`
423-
- `push` / `pull` - Use the CLI for bulk operations
424437
- `init` - Use the CLI: `keep init`
438+
- `vault:add` / `vault:edit` / `vault:delete` - Use the CLI for vault management
439+
- `env:add` / `env:remove` - Use the CLI for environment management
425440

426441
### Security Notes
427442
- The shell masks secret values by default using `****` or showing only first 4 characters

docs/guide/web-ui/features.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ The Secrets page provides full CRUD operations with real-time search and filteri
66

77
**Key capabilities:**
88
- Create, edit, rename, and delete secrets
9+
- Encryption toggle — choose whether to encrypt each secret (on by default)
910
- Copy secrets between environments and vaults
1011
- View revision history
1112
- Bulk import from `.env` files

0 commit comments

Comments
 (0)