Getting Started

What Harnix does

Harnix scans a repository for harness readiness signals such as agent guidance, documentation, CI, and testing setup.

Each scan produces:

• A console summary with per-check status and recommendations
• A Markdown report file for sharing in issues and pull requests
• A self-contained HTML report file for browser review

First scan

npx harnix scan .

You can also scan a specific path:

npx harnix scan /path/to/repository

What to expect in output

The console summary includes:

• Overall score and qualitative band — a percentage and label such as “Good” (51–75%) or “Excellent” (76–100%)
• Per-check score with status symbols — ✓ for pass (≥75%), △ for partial (25–74%), ✗ for fail (<25%)
• Top recommendations — prioritized by check tier (critical first) and then by lowest score within each tier
• Report paths — file locations for the generated Markdown and HTML reports

After the scan, two report files are written to the repository root (or a custom directory if --output is used):

• A timestamped Markdown report (.md) for embedding in pull requests and issues
• A self-contained HTML report (.html) for viewing in any browser without external dependencies

Next

1. Review Installation for all runtime options.
2. Check CLI Reference for flags such as --verbose, --skip, and --output.
3. Use Scoring Methodology to interpret results consistently across repos.