From 8f32cefaa3f269aab4a49cb4b9cd52514e2ec5ab Mon Sep 17 00:00:00 2001 From: Ari Date: Fri, 14 Nov 2025 18:46:52 -0500 Subject: [PATCH] docs: fix broken references and remove non-existent flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixed broken documentation references: - README.md: docs/05-development → docs/06-development (2 occurrences) Removed references to non-existent flags: - --no-keychain flag (never implemented) - Replaced with actual OS credential manager commands - Updated quick-start.md to use interactive prompts instead - --no-audit flag (never implemented) - Corrected to --enable-audit (actual flag name) - Updated quick-start.md to reflect audit is disabled by default Files changed: - README.md - docs/01-getting-started/quick-start.md - docs/03-reference/command-reference.md Generated with Claude Code Co-Authored-By: Claude --- README.md | 4 ++-- docs/01-getting-started/quick-start.md | 17 +++++++++++------ docs/03-reference/command-reference.md | 14 ++++++++++---- 3 files changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index cf941b7d..471a83e6 100644 --- a/README.md +++ b/README.md @@ -212,7 +212,7 @@ go build -o pass-cli . go test ./... ``` -For testing guidelines, see [test/README.md](test/README.md). For Git workflow, see [docs/05-development/branch-workflow.md](docs/05-development/branch-workflow.md). +For testing guidelines, see [test/README.md](test/README.md). For Git workflow, see [docs/06-development/branch-workflow.md](docs/06-development/branch-workflow.md). ## FAQ @@ -248,7 +248,7 @@ For more questions and troubleshooting, see [docs/04-troubleshooting/faq.md](doc ## Contributing -Contributions are welcome! See [docs/05-development/branch-workflow.md](docs/05-development/branch-workflow.md) for Git workflow and contribution guidelines. +Contributions are welcome! See [docs/06-development/branch-workflow.md](docs/06-development/branch-workflow.md) for Git workflow and contribution guidelines. ## License diff --git a/docs/01-getting-started/quick-start.md b/docs/01-getting-started/quick-start.md index abe93fe4..bef00328 100644 --- a/docs/01-getting-started/quick-start.md +++ b/docs/01-getting-started/quick-start.md @@ -68,7 +68,7 @@ Store your master password in OS keychain for convenience? Benefits: ✓ No need to type password for every operation ✓ Secure OS-level storage - ✓ Can be disabled later with --no-keychain + ✓ Can be disabled later via OS credential manager Enable keychain storage? (y/n): y @@ -159,19 +159,24 @@ pass-cli get github #### Skip Keychain Integration +During the interactive initialization, answer "n" when prompted about keychain storage: + ```bash -pass-cli init --no-keychain +pass-cli init +# When asked "Enable keychain storage? (y/n):", enter "n" ``` -Creates a vault without storing the master password in OS keychain. You'll need to enter your password for each operation. +This creates a vault without storing the master password in OS keychain. You'll need to enter your password for each operation. + +#### Enable Audit Logging -#### Disable Audit Logging +Audit logging is disabled by default. To enable it during initialization: ```bash -pass-cli init --no-audit +pass-cli init --enable-audit ``` -Creates a vault without audit logging enabled (not recommended for production use). +This creates a vault with tamper-evident HMAC-signed audit logging enabled (recommended for production use). ## Your First Credential diff --git a/docs/03-reference/command-reference.md b/docs/03-reference/command-reference.md index 7a0eaf6b..6e4f0aeb 100644 --- a/docs/03-reference/command-reference.md +++ b/docs/03-reference/command-reference.md @@ -1561,11 +1561,17 @@ secret-tool search service pass-cli secret-tool clear service pass-cli vault /old/path/vault.enc ``` -**Prevention**: When deleting or moving vaults, remove the keychain entry first: +**Prevention**: When deleting or moving vaults, remove the keychain entry first using your OS credential manager: + ```bash -# Before deleting vault -pass-cli change-password --no-keychain # Disables keychain -# OR manually remove from OS keychain +# Windows +cmdkey /delete:pass-cli + +# macOS +security delete-generic-password -s "pass-cli" -a "$USER" + +# Linux +secret-tool clear service pass-cli vault /old/path/vault.enc ``` #### What if first-run detection doesn't trigger?