Skip to main content

Overview

The evaluate command performs comprehensive static analysis on a skill directory, running all configured checks and generating a detailed quality report with scores and actionable feedback.

Usage

sklab evaluate [SKILL_PATH] [OPTIONS]

Arguments

SKILL_PATH
Path
Path to the skill directory. Defaults to current directory if not specified.

Options

--output
Path
Alias: -oOutput file path for JSON report. Only used when --format json is specified.
sklab evaluate --format json --output report.json
--format
string
default:"console"
Alias: -fOutput format for the report.Options:
  • console - Human-readable terminal output with colors and formatting
  • json - Machine-readable JSON output
sklab evaluate --format json
--verbose
boolean
default:false
Alias: -VShow all checks in the report, not just failures. By default, only failed checks are displayed.
sklab evaluate --verbose
--spec-only
boolean
default:false
Alias: -sOnly run checks required by the Agent Skills specification. Skips quality suggestion checks.
sklab evaluate --spec-only

Examples

Evaluate current directory

sklab evaluate

Evaluate specific skill with verbose output

sklab evaluate ./my-skill --verbose

Generate JSON report

sklab evaluate --format json --output report.json

Run only spec-required checks

sklab evaluate --spec-only

Output Format

Console Output

The default console output includes:
  • Overall quality score (0-100)
  • Pass/fail status
  • Results grouped by dimension (structure, naming, content)
  • Severity indicators (error, warning, info)
  • Actionable error messages

JSON Output

JSON format includes:
  • overall_pass: boolean
  • score: 0-100
  • checks: array of check results with:
    • check_id: unique identifier
    • check_name: human-readable name
    • dimension: structure, naming, description, or content
    • severity: error, warning, or info
    • passed: boolean
    • message: description of result

Exit Codes

  • 0: Evaluation passed (all checks passed)
  • 1: Evaluation failed (one or more checks failed) or error occurred

Notes

The skill directory must contain a SKILL.md file. If not found, the command will exit with an error.
By default, evaluate runs all 28 checks (10 spec-required + 18 quality suggestions). Use --spec-only to run only the 10 required checks.

Build docs developers (and LLMs) love