docs: comprehensive CLI documentation audit and fixes #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Change 'capiscio version' to 'capiscio --version' (version is a flag, not command) - Fix 'key gen --output' to 'key gen --out-priv/--out-pub' (correct flag names) - Remove '(includes scores)' from JSON output description (clarification)
|
✅ All checks passed! Ready for review. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes CLI command documentation to align with the actual capiscio v2.2.0 binary behavior. The changes correct command syntax and flag usage across all documentation files based on verification against the binary's --help output.
- Fixed version check command from
capiscio versiontocapiscio --version(version is a flag, not a subcommand) - Updated key generation command to use separate
--out-privand--out-pubflags instead of single--outputflag - Clarified comments for improved accuracy (removed "includes scores" qualifier, changed "key" to "key pair")
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updated version command syntax and clarified JSON output comment |
| docs/index.md | Updated version command syntax and clarified JSON output comment |
| docs/getting-started/installation.md | Updated version command syntax |
| docs/reference/commands.md | Updated version command syntax, fixed key generation flags, and improved comment accuracy |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
✅ All checks passed! Ready for review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Documentation audit verifying CLI examples against actual
capiscio v2.2.0binary.Issues Fixed
capiscio versioncapiscio --version(version is a flag, not command)key gen --outputkey gen --out-priv/--out-pubFiles Changed
README.md: Fixed version command syntaxdocs/index.md: Fixed version command syntaxdocs/getting-started/installation.md: Fixed version command syntaxdocs/reference/commands.md: Fixed key gen flagsVerification
All changes verified against
capiscio-core v2.2.0 --helpoutput.Audit date: 2025-12-26