Skip to content

Commit afe461d

Browse files
committed
docs(readme): add cape benchmark stats command documentation
Add comprehensive documentation for the new benchmark statistics command including usage examples, JSON output format explanation, and integration with external tools like jq.
1 parent 720e553 commit afe461d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ cape benchmark list
8585
cape benchmark fibonacci
8686
cape benchmark two-party-escrow
8787

88+
# Generate JSON statistics for all benchmarks
89+
cape benchmark stats
90+
8891
# Create a submission for your compiler
8992
cape submission new fibonacci MyCompiler 1.0.0 myhandle
9093
cape submission new two-party-escrow MyCompiler 1.0.0 myhandle
@@ -121,6 +124,7 @@ For the full and up-to-date command reference, see [USAGE.md](USAGE.md).
121124
# Benchmarks
122125
cape benchmark list # List all benchmarks
123126
cape benchmark <name> # Show benchmark details
127+
cape benchmark stats # Generate JSON statistics for all benchmarks
124128
cape benchmark new <name> # Create a new benchmark from template
125129

126130
# Submissions
@@ -134,6 +138,23 @@ cape submission report <name> # Generate HTML report for a benchmark
134138
cape submission report --all # Generate HTML reports for all benchmarks
135139
```
136140

141+
### JSON Statistics
142+
143+
The `cape benchmark stats` command generates comprehensive JSON data for all benchmarks:
144+
145+
```zsh
146+
# Output JSON statistics to console
147+
cape benchmark stats
148+
149+
# Save to file
150+
cape benchmark stats > stats.json
151+
152+
# Use with jq for filtering
153+
cape benchmark stats | jq '.benchmarks[] | select(.submission_count > 0)'
154+
```
155+
156+
The output includes formatted metrics, best value indicators, and submission metadata, making it ideal for generating custom reports or integrating with external tools.
157+
137158
### Interactive prompts
138159

139160
```zsh

0 commit comments

Comments
 (0)