Skip to content

docs: Fix broken references and remove non-existent flags#32

Merged
arimxyer merged 1 commit intomainfrom
docs/fix-broken-references
Nov 14, 2025
Merged

docs: Fix broken references and remove non-existent flags#32
arimxyer merged 1 commit intomainfrom
docs/fix-broken-references

Conversation

@arimxyer
Copy link
Copy Markdown
Collaborator

Clean up documentation by fixing broken links and removing references to flags that were never implemented.

Fixed Broken References

  • README.md: docs/05-developmentdocs/06-development (2 occurrences)
    • Git workflow and contribution guidelines links now point to correct location

Removed Non-Existent Flags

--no-keychain (never implemented)

Before:

pass-cli init --no-keychain  # Disables keychain

After:

  • Updated to use interactive prompts during pass-cli init
  • Replaced with actual OS credential manager commands for removal:
    • Windows: cmdkey /delete:pass-cli
    • macOS: security delete-generic-password -s "pass-cli" -a "$USER"
    • Linux: secret-tool clear service pass-cli vault /path

--no-audit (never implemented)

Before:

pass-cli init --no-audit  # Disable audit logging

After:

pass-cli init --enable-audit  # Enable audit logging (disabled by default)

Files Changed

  • README.md - Fixed 2 broken path references
  • docs/01-getting-started/quick-start.md - Removed --no-keychain and --no-audit, corrected to interactive prompts and --enable-audit
  • docs/03-reference/command-reference.md - Replaced --no-keychain with OS-specific commands

Verification

./pass-cli init --help
# Shows actual flags:
#   --use-keychain (enable keychain)
#   --enable-audit (enable audit)
#   --no-recovery (skip recovery phrase)
# No --no-keychain or --no-audit flags exist

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 <noreply@anthropic.com>
@arimxyer arimxyer merged commit 2270ea1 into main Nov 14, 2025
5 checks passed
@arimxyer arimxyer deleted the docs/fix-broken-references branch November 14, 2025 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant