Skip to content

Add comprehensive CLI reference documentation #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 4 commits into from
Closed

Add comprehensive CLI reference documentation #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2cfba7
Initial plan
Copilot Oct 31, 2025
b20a281
Add comprehensive CLI reference documentation
Copilot Oct 31, 2025
8c98606
Improve CLI documentation accuracy based on code review
Copilot Oct 31, 2025
3eec127
Add clarifying notes about required arguments in CLI docs
Copilot Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,20 @@ kaprese run -b flint-1 spearmint-1 -e saver
# LOG_LEVEL=info kaprese run -b flint-1 spearmint-1 -e saver
```

## Options
## Commands

`kaprese` provides the following options:
`kaprese` provides the following commands:

| Benchmarks | Repository |
| Command | Description |
| :--------- | :---------------------------------------------------------------------------------------- |
| `benchmark` | command to do something about benchmark |
| `engine` | command to do something about engine |
| `run` | command to run APR tools on benchmarks |
| `eval` | command to evaluate the results |
| `-h`, `--help` | command to show help |

For detailed command-line options, argument descriptions, default values, and usage examples, see the [**CLI Reference**](docs/cli.md).

## Benchmarks and Engines

`kaprese` provides a set of benchmarks and engines.
Expand Down
Loading