
Check-AI
https://github.com/f/check-ai- Category
- Developer Tools
- Rank
- No. 1537Tools index
Previous survey · No. 1544 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- f
- GitHub
- 67 stars
- Date
About
Audit any repository for AI-readiness. CLI tool that scores how well a codebase is set up for AI agents to work in it.
What it does
Check-AI inspects repository structure, configuration, documentation, tests, prompts, integrations, dependencies, and recent commit messages. It turns those signals into section summaries, findings, recommendations, terminal output, or machine-readable JSON.
Why it's ranked here
The tool is useful as a fast consistency check, especially because it covers many coding assistants without requiring teams to configure every one. Its verdict remains heuristic: file presence, regular expressions, dependency name matching, and weighted signals cannot prove that agents will work safely or effectively.
What's good
It has no runtime dependencies and uses Node built-ins for scanning and terminal presentation. One tree walk collects nested instruction, prompt, and skill files. Interactive, static, JSON, badge, and CI-friendly modes make the same audit useful locally and in automation.
Tradeoffs
Deep scanning stops after six directory levels and ignores most hidden directories, so valid material can escape detection. Documentation quality comes from keyword and formatting signals, not semantic evaluation. Dependency detection uses package names or substring searches. The CI gate exposes one fixed failure threshold rather than a configurable policy.
How to use it well
Use it when maintaining repositories where coding agents need clear instructions, repeatable commands, tests, and controlled context. Run it during setup, then keep its JSON output in CI or dashboards. Treat findings as a checklist for human judgment. It does not test agent task performance, code correctness, or security.
Technical notes+
bin/cli.mjs parses directory and output flags, invokes scan from src/scanner.mjs, passes findings through src/scorer.mjs, and renders through src/reporter.mjs. src/scanner.mjs dynamically imports audit modules, performs one recursive scan with a default maximum depth of 6, then evaluates static and custom checks. src/audits/repo-hygiene.mjs also shells out to Git for recent commit subjects. src/audits/agent-configs.mjs and src/audits/grounding-docs.mjs use regex-based content signals. src/audits/ai-deps.mjs checks JavaScript dependency keys and searches Python, Go, and Rust manifests. src/audits/mcp.mjs parses MCP configuration and requires at least two configured servers for its quality finding. package.json exposes the executable and declares only development dependencies.
Observed
- License
- MIT
- Primary language
- JavaScript using ECMAScript modules
- Packaging
- Published as the check-ai npm package with a check-ai executable
- Install surface
- Runs directly through npx check-ai
- Interface
- Command-line tool with interactive terminal, static terminal, JSON, badge, and CI modes
- Runtime dependencies
- None declared; ESLint and Prettier are development dependencies only
Read from README.md, package.json, src/scorer.mjs, src/scanner.mjs, src/reporter.mjs, src/audits/mcp.mjs, src/audits/ai-deps.mjs, src/audits/testing.mjs, src/audits/ai-context.mjs, src/audits/repo-hygiene.mjs, src/audits/agent-configs.mjs, src/audits/grounding-docs.mjs, src/audits/prompts-skills.mjs, eslint.config.mjs, bin/cli.mjs.
What it can do
Audit repository for AI-readiness
Code repository → AI-readiness assessment
Score codebase AI compatibility
Codebase files and structure → Numerical AI-readiness score
Analyze code structure for AI agent compatibility
Source code files → Structure analysis report
Evaluate documentation quality for AI understanding
Project documentation and comments → Documentation quality assessment
Check code organization standards
File structure and naming conventions → Organization compliance report
Generate AI-readiness recommendations
Codebase analysis results → Improvement suggestions list
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.