Add comprehensive CLI reference documentation#88
Closed
hyun-hyang with Copilot wants to merge 4 commits into
Closed
Add comprehensive CLI reference documentation#88hyun-hyang with Copilot wants to merge 4 commits into
hyun-hyang with Copilot wants to merge 4 commits into
Conversation
Co-authored-by: hyun-hyang <51802020+hyun-hyang@users.noreply.github.com>
Co-authored-by: hyun-hyang <51802020+hyun-hyang@users.noreply.github.com>
Co-authored-by: hyun-hyang <51802020+hyun-hyang@users.noreply.github.com>
hyun-hyang
marked this pull request as ready for review
October 31, 2025 04:51
Copilot
AI
changed the title
[WIP] Add detailed CLI option documentation to README
Add comprehensive CLI reference documentation
Oct 31, 2025
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
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.
CLI commands (
kaprese run,kaprese eval,kaprese benchmark,kaprese engine,kaprese config) lacked detailed option references. Users had examples but no complete argument specifications or expected outputs.Changes
Documentation Structure
docs/cli.mdwith:LOG_LEVEL)Command Reference Tables
Each command now documents:
README Updates
Example
The
runcommand now has a complete reference:-e [ENGINE ...]-b [BENCHMARK ...]-o OUTPUTkaprese-out--rebuild-runnerFalseWith usage examples:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.