Skip to content

PR4SAN/ngx-agents-md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ngx-agents-md

Add Angular documentation to your project for AI coding agents (Claude Code, Cursor, etc.).

Usage

npx ngx-agents-md

What it does

  1. Detects your Angular version from package.json
  2. Downloads matching Angular docs to .angular-docs/
  3. Injects a compressed index into CLAUDE.md

This helps AI coding agents generate correct, up-to-date Angular code by giving them access to version-matched documentation.

Options

-o, --output <file>           Output file (default: "CLAUDE.md")
-v, --angular-version <ver>   Angular version (auto-detect if not specified)
-d, --docs-dir <dir>          Directory to store docs (default: ".angular-docs")
--dry-run                     Show what would be done without making changes

Why?

AI coding agents rely on training data that becomes outdated. This tool ensures they have access to accurate, version-specific Angular documentation.

License

MIT EOF

10. Install dependencies

npm install

11. Build initial version

npm run build

12. Make CLI executable

chmod +x bin/cli.js

echo "" echo "Project initialized!" echo "" echo "Next steps:" echo " 1. cd ngx-agents-md" echo " 2. Open in your IDE" echo " 3. Give the handoff document to Claude Code" echo " 4. Start building!" echo "" echo "Test the CLI:" echo " npm run build && node bin/cli.js --help"

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors