![\"Agent](\"./landing/public/favicon.svg\")
\n\n \n
\n Diagnose whether a repository is ready for AI coding agents.\n
\n\n\n Repository\n ·\n Technical decisions\n ·\n Publishing\n
\n\n---\n\n## What It Is\n\nAgent Ready is an open source Node.js CLI that checks whether a project has the context,\ncommands, safety files, and setup signals that coding agents need before they start changing code.\n\nIt does not provide an AI model and does not call any hosted AI service. It prepares your repository\nfor the agent you already use, such as Codex, Claude Code, OpenCode, Cursor, Windsurf, or another\ntool that can read files in your project.\n\n```text\nagent-ready = scanner + generator + prescription builder\nyour coding agent = executor\n```\n\n## Why Use It\n\nCoding agents work better when a repository tells them what matters. Many projects are missing that\ncontext:\n\n- `AGENTS.md` with project-specific instructions\n- documented `dev`, `build`, `test`, `lint`, and `format` commands\n- `.env.example` with safe placeholders\n- clear safety rules for secrets and destructive commands\n- a simple readiness summary before delegating work\n\nAgent Ready finds those gaps and gives you a concrete next step instead of making your coding agent\nguess.\n\n## What It Checks\n\nThe current version focuses on Node.js and TypeScript projects. It scans for:\n\n- repository basics: Git, manifests, package manager, lockfile\n- context files: `README.md`, `AGENTS.md`, `.env.example`\n- scripts: `dev`, `build`, `test`, `lint`, `format`\n- agent tooling signals: Codex, Claude Code, OpenCode, Cursor, Windsurf\n- local skills under `.agents/skills`\n- readiness score, status, and recommended next steps\n\n## Install\n\nRun it directly with `npx`:\n\n```bash\nnpx @agent-ready/cli scan\n```\n\nThe public package uses the scoped npm package `@agent-ready/cli` and exposes the `agent-ready` binary.\n\nFor local development:\n\n```bash\npnpm install\npnpm build\npnpm dev -- scan\n```\n\n## Commands\n\n### `scan`\n\nScans the repository without modifying files.\n\n```bash\nnpx @agent-ready/cli scan\n```\n\nUseful when you want to know what the repo already has and what is missing.\n\nYou can scan another directory with `--root`:\n\n```bash\nnpx @agent-ready/cli scan --root ./path/to/project\n```\n\n### `init`\n\nCreates safe starter files without overwriting existing files.\n\n```bash\nnpx @agent-ready/cli init\n```\n\nCurrently generated files:\n\n- `AGENTS.md`\n- `.env.example`\n\nIf either file already exists, Agent Ready skips it.\n\n### `prescribe`\n\nCreates a prescription file for your coding agent.\n\n```bash\nnpx @agent-ready/cli prescribe\n```\n\nGenerated file:\n\n- `.agent-ready/prescription.md`\n\nGive that file to your coding agent and ask it to apply the recommended repository setup fixes.\n\n## Suggested Workflow\n\n1. Diagnose the project:\n\n```bash\nnpx @agent-ready/cli scan\n```\n\n2. Generate missing base files:\n\n```bash\nnpx @agent-ready/cli init\n```\n\n3. Create instructions for your coding agent:\n\n```bash\nnpx @agent-ready/cli prescribe\n```\n\n4. Ask your agent to read the prescription:\n\n```text\nRead .agent-ready/prescription.md and apply the recommended repository setup fixes.\nDo not modify secrets or run destructive commands.\n```\n\n5. Re-scan after changes:\n\n```bash\nnpx @agent-ready/cli scan\n```\n\n## Commands To Test The Tool\n\nFrom this repository:\n\n```bash\npnpm install\npnpm dev -- scan\npnpm dev -- init --yes\npnpm dev -- prescribe --yes\npnpm test\npnpm build\npnpm lint\npnpm check\n```\n\nAfter building, you can test the compiled CLI:\n\n```bash\npnpm build\nnode dist/cli.js scan\nnode dist/cli.js init --yes\nnode dist/cli.js prescribe --yes\n```\n\nTo test against a temporary project:\n\n```bash\nmkdir /tmp/agent-ready-demo\ncd /tmp/agent-ready-demo\npnpm init\nnode /path/to/agent-ready/dist/cli.js scan\nnode /path/to/agent-ready/dist/cli.js init --yes\nnode /path/to/agent-ready/dist/cli.js prescribe --yes\n```\n\nReplace `/path/to/agent-ready` with the absolute path to this repository.\n\n## Development\n\nMain commands:\n\n```bash\npnpm dev # default scan\npnpm dev -- scan\npnpm dev -- init --yes\npnpm dev -- prescribe --yes\npnpm test\npnpm lint\npnpm build\npnpm check\npnpm format\n```\n\nLanding page:\n\n```bash\npnpm --dir landing dev\npnpm --dir landing build\npnpm --dir landing preview\n```\n\n## Project Structure\n\n```text\nsrc/\n analyzer/ readiness scoring and next steps\n cli/ command output, parsing, presentation helpers\n generator/ AGENTS.md, .env.example, and prescription generation\n scanner/ repository inspection\ntests/ Vitest coverage\ndocs/ technical and publishing notes\nlanding/ Astro landing page\n.agents/ project agent roles, messages, and workflows\n```\n\n## Safety Model\n\nAgent Ready is intentionally conservative:\n\n- `scan` is read-only.\n- `init` does not overwrite existing files.\n- `prescribe` does not overwrite an existing prescription.\n- no API keys are required.\n- no model provider account is required.\n- generated instructions warn agents not to modify secrets or run destructive commands.\n\n## Current Status\n\nImplemented:\n\n- TypeScript CLI scaffold\n- `scan`, `init`, and `prescribe` commands\n- readiness analyzer and score\n- Node.js project signal detection\n- package manager and script detection\n- agent tool and skill detection\n- Vitest test suite\n- Astro landing page\n\nPlanned:\n\n- richer framework detection\n- stable JSON report output\n- CI-friendly mode\n- adapter-specific prescriptions for Codex, Claude Code, and OpenCode\n- broader language support beyond Node.js\n\n## License\n\nMIT. See [LICENSE](./LICENSE).\n","readmeFilename":"README.md","_rev":"1-02fc0c3cea34c1baf4932857cc25872e"}