Check Catalog
Active checks
Section titled “Active checks”| Check ID | Name | Category | Tier | Applies to |
|---|---|---|---|---|
agents-md | Agent guidance | agent-readiness | critical | all |
documentation | Documentation | documentation | critical | all |
ci-pipeline | CI pipeline | quality-gates | important | software |
testing-provision | Testing provision | quality-gates | important | software |
Check details
Section titled “Check details”agents-md
Section titled “agents-md”- Detects root-level
AGENTS.mdorCLAUDE.md - Evaluates presence and guidance depth
- Recommends improvements when guidance is missing or too brief
documentation
Section titled “documentation”- Requires a root
README.md - Looks for durable docs structure such as
docs/orprds/ - Scores readability and documentation coverage signals
ci-pipeline
Section titled “ci-pipeline”- Detects CI markers such as GitHub Actions, GitLab CI, CircleCI, Jenkins, Travis CI, and Azure Pipelines
- Returns pass when a CI system is detected
testing-provision
Section titled “testing-provision”- Looks for runnable test signals and common test framework patterns
- Surfaces remediation guidance when testing coverage appears weak or missing
Filter by check ID
Section titled “Filter by check ID”Use check IDs with CLI flags:
harnix scan . --only agents-mdharnix scan . --skip ci-pipeline