Skip to content

Commit b54aefb

Browse files
jszobodyclaudehappy-otter
committed
Add missing verify and info commands to CLI reference docs
Both commands were completely missing from the CLI reference documentation. - verify: Checks vault configuration, authentication, and permissions - info: Displays Keep configuration information Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
1 parent d8c55f2 commit b54aefb

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

docs/guide/reference/cli-reference.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,74 @@ keep stage:add sandbox --no-interaction
8080
- Can contain letters, numbers, hyphens, and underscores
8181
- Examples: `qa`, `demo`, `integration`, `sandbox`, `dev2`, `staging-eu`
8282

83+
## `keep verify`
84+
85+
Verify vault configuration, authentication, and permissions by running a comprehensive test matrix.
86+
87+
**Examples:**
88+
```bash
89+
# Verify all configured vaults
90+
keep verify
91+
```
92+
93+
**What it checks:**
94+
- **Vault Configuration**: Validates that all configured vaults are properly set up
95+
- **Authentication**: Tests that Keep can authenticate with AWS using current credentials
96+
- **Permissions Matrix**: Runs through a complete test of read, write, and delete operations
97+
- **Stage Access**: Verifies access to all configured stages (local, staging, production, etc.)
98+
99+
**Output includes:**
100+
- Connection status for each vault
101+
- Authentication method being used (IAM role, profile, etc.)
102+
- Permission check results for each operation
103+
- Any errors or warnings about missing permissions
104+
105+
**Common use cases:**
106+
```bash
107+
# Run after initial setup
108+
keep configure
109+
keep vault:add
110+
keep verify
111+
112+
# Check before deploying to production
113+
keep verify
114+
115+
# Troubleshoot permission issues
116+
keep verify
117+
```
118+
119+
## `keep info`
120+
121+
Display information about the Keep configuration, including version, paths, and settings.
122+
123+
**Examples:**
124+
```bash
125+
# Show Keep configuration info
126+
keep info
127+
```
128+
129+
**Information displayed:**
130+
- **Keep Version**: Current version of the Keep package
131+
- **Configuration Path**: Location of `.keep` directory
132+
- **Settings Path**: Location of `settings.json`
133+
- **Available Vaults**: List of configured vaults with their types
134+
- **Configured Stages**: All available stages (local, staging, production, custom)
135+
- **Default Vault**: The vault used when no `--vault` is specified
136+
- **Cache Status**: Whether caching is enabled and cache location
137+
138+
**Common use cases:**
139+
```bash
140+
# Check Keep version
141+
keep info
142+
143+
# Verify configuration after setup
144+
keep configure
145+
keep info
146+
147+
# Debug path issues
148+
keep info
149+
```
150+
83151
## `keep set`
84152

85153
Create or update secrets in vaults.

0 commit comments

Comments
 (0)