CLI Commands¶

Detailed reference for all sevaluation commands.

render¶

Render evaluation or summary reports in various formats.

Usage¶

sevaluation render <file> [--format=<format>]

Formats¶

Format	Description	Report Type
`terminal`	ANSI colors + UTF8 icons	Rubric
`markdown`	Markdown output	Rubric
`detailed`	Verbose terminal output	Rubric
`box`	ASCII box format (deterministic)	Both
`json`	Pretty-printed JSON	Both

Examples¶

# Terminal output (default)
sevaluation render eval.json

# Explicit format
sevaluation render eval.json --format=terminal

# Markdown for documentation
sevaluation render eval.json --format=markdown > report.md

# JSON for programmatic use
sevaluation render eval.json --format=json | jq '.decision'

# Box format for summary reports
sevaluation render summary.json --format=box

Auto-Detection¶

The command auto-detects report type (rubric vs summary) and uses the appropriate renderer.

lint¶

Validate report correctness including enum values, count accuracy, and decision consistency. Added in v0.7.0.

Usage¶

sevaluation lint <file> [--strict] [--format=<format>]

Flags¶

Flag	Description
`--strict`	Treat warnings as errors
`--format`	Output format: `text` (default), `json`

Validation Checks¶

Check	Level	Description
Enum Values	Error	Score, severity, decision status must be valid
Required Fields	Error	`metadata.document` and `reviewType` are required
Finding Title	Error	Each finding must have a title
Count Accuracy	Warning	Reported counts must match actual data
Decision Consistency	Warning	Decision should align with findings
OverallDecision Match	Warning	`overallDecision` should match `decision.status`

Exit Codes¶

Code	Status	Meaning
0	Valid	No errors (warnings allowed unless `--strict`)
1	Invalid	Has errors, or has warnings with `--strict`

Examples¶

# Basic validation
sevaluation lint report.json

# Strict mode (warnings are errors)
sevaluation lint report.json --strict

# JSON output for programmatic use
sevaluation lint report.json --format=json

# CI pipeline validation
for report in reports/*.json; do
    if ! sevaluation lint "$report" --strict; then
        echo "Invalid report: $report"
        exit 1
    fi
done

Output¶

✅ Valid: 0 errors, 0 warnings

or

❌ Invalid: 2 errors, 1 warning
  [error] categories[0].score: invalid score value "passed", must be one of: pass, partial, fail
  [error] findings[1].title: finding must have a title
  [warning] summary.categoryCount: reported 5, actual 4

check¶

Check if a report passes evaluation criteria. Useful for CI/CD gates.

Usage¶

sevaluation check <file>

Exit Codes¶

Code	Status	Meaning
0	Pass	All criteria met
1	Fail/Conditional	Blocking issues or conditional pass

Examples¶

# Basic check
sevaluation check report.json

# Use in CI
if sevaluation check report.json; then
    echo "✅ Evaluation passed"
    deploy_to_production
else
    echo "❌ Evaluation failed"
    exit 1
fi

# Capture output
result=$(sevaluation check report.json 2>&1)

Output¶

✅ PASSED: prd-review (4/4 categories)

or

❌ FAILED: prd-review - 2 blocking issues

validate¶

Validate a JSON file against the appropriate schema.

Usage¶

sevaluation validate <file>

Examples¶

# Validate rubric report
sevaluation validate eval.json

# Validate summary report
sevaluation validate summary.json

Output¶

✅ Valid rubric report

or

❌ Invalid: missing required field "review_type"

schema¶

Work with JSON schemas.

Subcommands¶

Subcommand	Description
`generate`	Generate schema files
`show`	Display embedded schema

generate¶

sevaluation schema generate -o ./schema/

Generates:

rubric.schema.json
summary.schema.json

show¶

# Show rubric schema
sevaluation schema show rubric

# Show summary schema
sevaluation schema show summary

version¶

Print version information.

Usage¶

sevaluation version

Output¶

sevaluation v0.7.0

Common Workflows¶

CI Pipeline Gate¶

# .github/workflows/pr-check.yaml
- name: Run evaluation
  run: |
    sevaluation check eval-report.json

Generate Documentation¶

# Generate markdown reports
for f in reports/*.json; do
    name=$(basename "$f" .json)
    sevaluation render "$f" --format=markdown > "docs/reports/${name}.md"
done

Validate Before Commit¶

# Pre-commit hook
#!/bin/bash
for report in reports/*.json; do
    if ! sevaluation validate "$report"; then
        echo "Invalid report: $report"
        exit 1
    fi
done

Lint Reports in CI¶

# Validate all reports with strict mode
for report in reports/*.json; do
    if ! sevaluation lint "$report" --strict; then
        echo "Invalid report: $report"
        exit 1
    fi
done

Compare Reports¶

# Extract decisions from multiple reports
for f in reports/*.json; do
    echo -n "$f: "
    sevaluation render "$f" --format=json | jq -r '.decision.status'
done

Next Steps¶

Report Rendering - Format details
Pass Criteria - Check thresholds