Skip to content

Commit ce56dbd

Browse files
committed
More stage -> env updates
1 parent 069a420 commit ce56dbd

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

docs/guide/cli/reference.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Add a custom env/environment beyond the standard ones (local, staging, productio
5656
| `--no-interaction` | boolean | `false` | Run without prompts |
5757

5858
**Arguments:**
59-
- `[name]` - Stage name (prompted if not provided)
59+
- `[name]` - Environment name (prompted if not provided)
6060

6161
**Examples:**
6262
```bash
@@ -75,7 +75,7 @@ keep env:add hotfix
7575
keep env:add sandbox --no-interaction
7676
```
7777

78-
**Stage Name Requirements:**
78+
**Environment Name Requirements:**
7979
- Must be lowercase
8080
- Can contain letters, numbers, hyphens, and underscores
8181
- Examples: `qa`, `demo`, `integration`, `sandbox`, `dev2`, `staging-eu`
@@ -231,7 +231,7 @@ Show all secrets from a vault and environment.
231231

232232
| Option | Type | Default | Description |
233233
|--------|------|---------|-------------|
234-
| `--env` | string | *interactive* | Stage to list secrets from |
234+
| `--env` | string | *interactive* | Environment to list secrets from |
235235
| `--vault` | string | *default vault* | Vault to list secrets from |
236236
| `--unmask` | boolean | `false` | Show actual secret values instead of masked |
237237
| `--format` | string | `table` | Output format: `table`, `json`, `env` |
@@ -266,7 +266,7 @@ Generate a template file from existing secrets in a environment.
266266
| Option | Type | Default | Description |
267267
|--------|------|---------|-------------|
268268
| `filename` | string | *required* | Template filename to create |
269-
| `--env` | string | *required* | Stage to generate template from |
269+
| `--env` | string | *required* | Environment to generate template from |
270270
| `--vault` | string | *all vaults* | Specific vault to use |
271271
| `--overwrite` | boolean | `false` | Overwrite existing template file |
272272

@@ -290,7 +290,7 @@ Validate template files for syntax and placeholder resolution.
290290
| Option | Type | Default | Description |
291291
|--------|------|---------|-------------|
292292
| `filename` | string | *required* | Template file to validate |
293-
| `--env` | string | *optional* | Stage to validate against |
293+
| `--env` | string | *optional* | Environment to validate against |
294294

295295
### Examples
296296

@@ -374,7 +374,7 @@ Remove secrets from vaults.
374374

375375
| Option | Type | Default | Description |
376376
|--------|------|---------|-------------|
377-
| `--env` | string | *interactive* | Stage to delete secret from |
377+
| `--env` | string | *interactive* | Environment to delete secret from |
378378
| `--vault` | string | *default vault* | Vault to delete the secret from |
379379
| `--force` | boolean | `false` | Delete without confirmation prompt |
380380

@@ -402,7 +402,7 @@ Rename a secret while preserving its value and metadata.
402402

403403
| Option | Type | Default | Description |
404404
|--------|------|---------|-------------|
405-
| `--env` | string | *interactive* | Stage where the secret exists |
405+
| `--env` | string | *interactive* | Environment where the secret exists |
406406
| `--vault` | string | *default vault* | Vault containing the secret |
407407
| `--force` | boolean | `false` | Skip confirmation prompt |
408408

@@ -430,7 +430,7 @@ Search for text within secret values.
430430

431431
| Option | Type | Default | Description |
432432
|--------|------|---------|-------------|
433-
| `--env` | string | *interactive* | Stage to search in |
433+
| `--env` | string | *interactive* | Environment to search in |
434434
| `--vault` | string | *default vault* | Vault to search in |
435435
| `--unmask` | boolean | `false` | Show actual secret values in results |
436436
| `--case-sensitive` | boolean | `false` | Make the search case-sensitive |
@@ -603,7 +603,7 @@ Export secrets from vaults with optional template processing.
603603

604604
| Option | Type | Default | Description |
605605
|--------|------|---------|-------------|
606-
| `--env` | string | *interactive* | Stage to export secrets from |
606+
| `--env` | string | *interactive* | Environment to export secrets from |
607607
| `--vault` | string | *auto-discover* | Vault(s) to export from (comma-separated) |
608608
| `--format` | string | `env` | Output format: `env`, `json`, `csv` |
609609
| `--template` | string | | Optional template file with placeholders |
@@ -678,7 +678,7 @@ Execute subprocesses with secrets injected as environment variables (diskless).
678678
| Option | Type | Default | Description |
679679
|--------|------|---------|-------------|
680680
| `--vault` | string | *interactive* | Vault to fetch secrets from |
681-
| `--env` | string | *interactive* | Stage to use |
681+
| `--env` | string | *interactive* | Environment to use |
682682
| `--template` | string | | Template file path, or auto-discover if empty |
683683
| `--only` | string | | Include only matching keys (patterns) |
684684
| `--except` | string | | Exclude matching keys (patterns) |

docs/guide/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This interactive command will:
1616
You'll be prompted for:
1717
- **Project name**: Display name for your project
1818
- **Namespace**: Unique identifier for secret prefixes
19-
- **Stages**: Environment names (defaults to local, staging, production)
19+
- **Environments**: Environment names (defaults to local, staging, production)
2020

2121
## Project Structure
2222

@@ -88,7 +88,7 @@ In larger teams, you might have:
8888

8989
Workspace filtering lets each developer see only what's relevant to them, while the full configuration remains available to the team.
9090

91-
## Managing Stages
91+
## Managing Environments
9292

9393
The default envs are local, staging, and production. You can add custom envs as needed:
9494

docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Keep is a PHP toolkit for managing secrets across applications, environments, an
77
Managing secrets across local, staging, and production environments is challenging. Keep solves this by providing:
88

99
- **Unified Interface**: One CLI for all your secret vaults
10-
- **Stage Organization**: Separate secrets by environment (local, staging, production)
10+
- **Environment Organization**: Separate secrets by environment (local, staging, production)
1111
- **Template Generation**: Build configuration files from templates with automatic secret replacement
1212
- **Team Collaboration**: Share vault access without exposing secret values
1313
- **Security First**: Encrypted storage, masked output, and secure AWS integration

docs/guide/shell/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Summary:
174174
• Identical across all environments: 1 (25%)
175175
• Different values: 2 (50%)
176176
• Missing in some envs: 1 (25%)
177-
Stages compared: 2
177+
Environments compared: 2
178178
```
179179

180180
### Import/Export
@@ -204,7 +204,7 @@ Note: The `import` command is only available in the CLI, not the shell.
204204
Checking vault access permissions...
205205
Keep Vault Verification Results
206206
┌────────────────┬────────────┬──────┬───────┬──────┬─────────┬────────┐
207-
│ Vault │ Stage │ List │ Write │ Read │ History │ Delete │
207+
│ Vault │ Environment │ List │ Write │ Read │ History │ Delete │
208208
├────────────────┼────────────┼──────┼───────┼──────┼─────────┼────────┤
209209
│ ssm │ local │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ │
210210
│ ssm │ staging │ ✓ │ ✓ │ ✓ │ ✓ │ ✓ │

docs/guide/vaults.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ keep set DB_PASSWORD "..." --vault=databases --env=production
6868
- **SSM**: Path-based (`/myapp/env/key`)
6969
- **Secrets Manager**: Tag-based with namespace tags
7070

71-
**Stage Separation**
71+
**Environment Separation**
7272
Each vault organizes secrets by env:
7373
- `development`
7474
- `staging`

docs/guide/vaults/aws-secrets-manager.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For developers who need complete access to manage secrets across all environment
9191
"aws:TagKeys": [
9292
"ManagedBy",
9393
"Namespace",
94-
"Stage",
94+
"Environment",
9595
"VaultSlug"
9696
]
9797
}
@@ -141,7 +141,7 @@ For developers who should only access development and staging environments:
141141
"secretsmanager:ResourceTag/Namespace": "myapp"
142142
},
143143
"ForAnyValue:StringEquals": {
144-
"secretsmanager:ResourceTag/Stage": [
144+
"secretsmanager:ResourceTag/Environment": [
145145
"staging",
146146
"production"
147147
]
@@ -168,7 +168,7 @@ For developers who should only access development and staging environments:
168168
"aws:RequestTag/Namespace": "myapp"
169169
},
170170
"ForAnyValue:StringEquals": {
171-
"aws:RequestTag/Stage": [
171+
"aws:RequestTag/Environment": [
172172
"staging",
173173
"production"
174174
]
@@ -177,7 +177,7 @@ For developers who should only access development and staging environments:
177177
"aws:TagKeys": [
178178
"ManagedBy",
179179
"Namespace",
180-
"Stage",
180+
"Environment",
181181
"VaultSlug"
182182
]
183183
}
@@ -216,7 +216,7 @@ For production deployment processes that only need to read production secrets:
216216
"Condition": {
217217
"StringEquals": {
218218
"secretsmanager:ResourceTag/Namespace": "myapp",
219-
"secretsmanager:ResourceTag/Stage": "production"
219+
"secretsmanager:ResourceTag/Environment": "production"
220220
}
221221
}
222222
},
@@ -256,7 +256,7 @@ Keep organizes secrets using simple path-style naming for duplicate avoidance, w
256256

257257
## Security Best Practices
258258

259-
**Tag-Based Access Control**: Keep uses tags (`ManagedBy`, `Namespace`, `Stage`, `VaultSlug`) for precise IAM permissions instead of resource ARNs.
259+
**Tag-Based Access Control**: Keep uses tags (`ManagedBy`, `Namespace`, `Environment`, `VaultSlug`) for precise IAM permissions instead of resource ARNs.
260260

261261
**Automatic Encryption**: All secrets are automatically encrypted at rest using AWS KMS.
262262

0 commit comments

Comments
 (0)