ngAutoPilot

NgAutoPilot 🚀

English · Español · Documentation map

Give your coding agent a route, not a pile of instructions.

NgAutoPilot is a CLI and a catalog of small engineering guides (skills). It helps an agent inspect your project, detect versions, choose relevant guidance, make a bounded change, and validate the result. It is not an Angular runtime library or an automatic code migrator.

🧭 Your first run

You need Node.js >= 24.0.0 and < 25 for this checkout, npm, a supported agent, and a receiving project. Check the requirements of the package version you install.

Run these commands inside the receiving project, not inside this catalog:

npm exec --package=ngautopilot -- ngautopilot adapters
npm exec --package=ngautopilot -- ngautopilot packs
npm exec --package=ngautopilot -- ngautopilot install --agent codex --pack ngautopilot-angular-foundations --scope project --dry-run

1. Choose: replace Codex and the foundations pack with IDs printed by the first two commands.
2. Inspect: --dry-run shows the plan without writing. Review paths and file conflicts.
3. Approve and verify: after reviewing the plan, run:

npm exec --package=ngautopilot -- ngautopilot install --agent codex --pack ngautopilot-angular-foundations --scope project --yes
npm exec --package=ngautopilot -- ngautopilot verify --agent codex --scope project

For Codex, expect skills in .agents/skills/, managed instructions in the root AGENTS.md, and a .ngautopilot-manifest.json in the selected install root. Verification checks managed files and checksums; it does not prove agent discovery. Open your agent in the receiving project and ask it to identify the applicable installed skill before editing.

Version checkpoint: npm exec uses a published package, not this checkout. Pin an exact verified release for reproducible automation. Branch-specific commands must be checked with node bin/ngautopilot.mjs help in this repository; do not assume unmerged code is on npm.

Next: first Angular task · installation · troubleshooting.

🎒 Pick the pack for today's job

Focused packs include Core through dependencies. Changing packs at the same agent and scope switches the managed selection, rather than accumulating all previous packs. Unchanged obsolete managed files may be removed; modified obsolete files are preserved and reported unless forced. Files still selected are preserved when locally edited unless explicitly forced. Back up customizations and inspect every switch.

ngautopilot-angular and ngautopilot-full are deliberate broad choices, not beginner defaults. All packs and historical hops.

🧩 Five useful concepts

Your task → inspect → detect versions → select guidance → check risks
         → make a small change → validate → report evidence

The decorative animation runs once for 3.6 seconds and respects reduced motion. All steps remain readable in a static preview.

The human directs the task. Skills guide the agent. Tests and review prove the result. Installing Markdown does not grant permissions, deploy services, register MCP, or automatically start subagents.

💬 Try a useful prompt

Inspect this project's Angular, Node, TypeScript, and RxJS versions. Identify the installed NgAutoPilot skill for lazy-loaded routes. Explain the smallest safe change before editing, then validate using the project's existing checks. Report checks you could not run.

For test review, substitute “review fragile TestBed setup and asynchronous behavior.” For upgrades, name the current and next major version and keep modernization separate.

Success means: detected versions, a named applicable skill, a bounded plan, and real validation output—not just “done.”

🔎 Catalog and repository map

Current catalog size: 413 skills

This checkout's doctor reports 36 packs and 10 adapters. Run doctor, packs, and adapters for your installed version instead of assuming every release matches.

skills/ is canonical. catalog.json, plugins/, and agent-plugins/ are generated distributions; do not hand-edit their copies. Architecture.

🛤️ Choose the right distribution

Adapter IDs: claude, codex, copilot, cursor, gemini, generic, hermes, openclaw, opencode, pi. Native, adapter, experimental, and unverified are different statuses. Installation matrix.

The OpenAI packet in this branch is skills-only, not submitted, and not OpenAI verified. Human attestations remain human actions. Run npm run openai:validate and npm run openai:pack for the current skills-only package. Release boundary.

📚 Choose your next chapter

All guides, historical records, and translation status: English map · Mapa en español.

🛠️ Maintainer checkpoint

For catalog changes, use the existing source pipeline:

npm run skills:validate
npm run skills:catalog
npm run plugins:sync
npm run agent-plugins:sync
npm run consistency:validate

The release checklist covers the full validation and packaging procedure. These commands can regenerate files: inspect the diff. Local checks do not prove publication or review approval.

License and community

MIT · License · Security reporting · Code of conduct · Changelog · Roadmap

Release and publication roadmap

0.10.0 release and publication tasks · Capability platform · Native exports · Safe pack transitions