AgentReady Kit

Make your repository ready for AI coding agents.

AgentReady Kit is an open-source CLI toolkit that helps you generate, validate, and synchronize custom instruction files (like AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and .cursorrules) for AI developers (such as OpenAI Codex, Claude Code, GitHub Copilot, Cursor, Aider, and Gemini CLI).

Usually, instructions on how to build, test, and style your project are scattered across your README.md, CONTRIBUTING.md, or your own mind. AgentReady Kit creates a single source of truth configuration file and keeps all agent memory files in sync.

Features

• 🛠️ Config-Driven: Define rules once in .agentready/config.yml and sync them across all agent formats.
• ⚡ Tech Stack Auto-Detection: Automatically identifies frameworks (Next.js, Node.js API, FastAPI, Laravel) to generate specific templates.
• 🔍 Validator Check: Verifies that instruction files contain necessary sections (Setup, Tests, Security Rules, PR Guidelines, "Do not touch" folders).
• 🔒 Security Scanner: Line-by-line regex scanning to flag hardcoded secrets, keys, and dangerous rules (e.g. "bypass authentication").
• 💯 Readiness Scoring: Computes a detailed AgentReady Score (0-100) to grade your repository context quality.
• ⚙️ CI Integration: Easily run validation checks inside GitHub Actions to prevent broken configs or secret leaks in PRs.

Quick Start

Initialize your repository:

npx agentready-kit init

This will scan your directory, detect your tech stack (e.g., Next.js), create a .agentready/config.yml file, a custom manual checklist under .agentready/checklist.md, and generate files like AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, and .cursorrules.

Verify Repository Readiness

npx agentready-kit check

Runs validations, calculates the AgentReady Score, and highlights quality or safety warnings.

Sync Changes from Configuration

Whenever you modify your rules in .agentready/config.yml, sync them to all formats:

npx agentready-kit sync

Diagnostics

npx agentready-kit doctor

Development Verification

For local development in this repository, run the full verification suite before opening a pull request:

npm run verify

Configuration (.agentready/config.yml)

Here is an example structure created during init:

project:
  name: AgentReady Kit
  type: open-source-tool
  stack:
    - typescript
    - node
  package_manager: npm

commands:
  install: npm install
  dev: npm run dev
  test: npm test
  lint: npm run lint
  typecheck: npm run typecheck
  build: npm run build

agent_rules:
  code_style:
    - Use TypeScript strict mode.
    - Keep changes small and focused.
    - Maintain existing patterns in the codebase.
  security:
    - Do not push local environment files (.env) or credentials to git.
    - Keep Server Actions protected by authentication checks.
  pr:
    - Ensure all tests pass before proposing a PR.
    - Document public API changes.
  do_not_touch:
    - .env
    - dist/

targets:
  - agents_md
  - claude_md
  - github_copilot
  - cursor_rules

Supported Templates

We provide tailored, pre-configured instruction templates for:

• 🚀 Next.js (Server components rules, Tailwind, Zod routing safety)
• 🟢 Node.js API (REST standards, Express/Fastify patterns, CORS rules)
• 🐍 Python FastAPI (PEP 8, Pydantic validations, pytest commands)
• 🔴 Laravel (Eloquent relations, artisan tools, CSRF/blade safety)
• 📦 Generic OSS (Base guidelines for general-purpose repositories)

Use the --template option to override stack auto-detection:

npx agentready-kit init --template nextjs

GitHub Action Integration

Keep your agent instructions high-quality and safe in pull requests. Add this workflow under .github/workflows/agentready.yml:

name: AgentReady Quality & Safety Check

on:
  pull_request:
  push:
    branches: [main]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install dependencies
        run: npm install

      - name: Run verification
        run: npm run verify

License

MIT © Erkin Infinity