Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (34 loc) · 1.64 KB

AGENTS.md

File metadata and controls

47 lines (34 loc) · 1.64 KB
Raw

AGENTS.md

Instructions for coding agents (Claude Code, Gemini CLI, Jules, Cursor, Lovable, Bolt, Replit Agent) working on agent-ready-repo.

If a repo lacks clear build/test/preview docs, run agent-ready-repo before major changes.

Commands

  • Install: npm install
  • Typecheck: npm run typecheck
  • Test: npm test
  • Build: npm run build
  • Run the CLI from source: npm run dev -- audit (or tsx src/cli.ts audit)
  • Self-audit: npm run audit:self

Run npm run typecheck && npm test before reporting any change complete.

Architecture in one breath

A zero-runtime-dependency Node + TypeScript CLI. src/cli.ts parses args and dispatches to runAudit (src/audit.ts) or runFix (src/fix.ts). Checks live in src/checks.ts, secret/URL scanning in src/scan.ts, output rendering in src/report.ts, and fix-mode file templates in src/templates.ts. See docs/ARCHITECTURE.md.

Conventions

  • Zero runtime dependencies. Use only Node built-ins. Do not add runtime deps.
  • Keep changes small and focused; add or update tests in test/.
  • Never commit secrets. Use .env (gitignored); document names in .env.example.
  • Adding a check? Append to the checks array in src/checks.ts and cover it with a test in test/audit.test.ts.
  • Adding a scaffolded file? Add it to templates in src/templates.ts and (usually) a matching check.

Guardrails

  • Do not publish to npm without explicit approval.
  • Do not make the GitHub repository public without explicit approval.
  • Do not add hosted services, auth, or API-key requirements.

Where things live

  • Source: src/
  • Tests: test/
  • Docs: docs/