ready-for-agents

v0.3.0

Published

12 days ago

Make any repository AI-agent-ready in 30 seconds.

Downloads

635

0High
0Medium
0Low

leminhsang

ai agents cli context cursor codex developer-tools llm prompt

██████╗ ███████╗ █████╗ ██████╗ ██╗   ██╗    ███████╗ ██████╗ ██████╗
██╔══██╗██╔════╝██╔══██╗██╔══██╗╚██╗ ██╔╝    ██╔════╝██╔═══██╗██╔══██╗
██████╔╝█████╗  ███████║██║  ██║ ╚████╔╝     █████╗  ██║   ██║██████╔╝
██╔══██╗██╔══╝  ██╔══██║██║  ██║  ╚██╔╝      ██╔══╝  ██║   ██║██╔══██╗
██║  ██║███████╗██║  ██║██████╔╝   ██║       ██║     ╚██████╔╝██║  ██║
╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝    ╚═╝       ╚═╝      ╚═════╝ ╚═╝  ╚═╝

 █████╗  ██████╗ ███████╗███╗   ██╗████████╗███████╗
██╔══██╗██╔════╝ ██╔════╝████╗  ██║╚══██╔══╝██╔════╝
███████║██║  ███╗█████╗  ██╔██╗ ██║   ██║   ███████╗
██╔══██║██║   ██║██╔══╝  ██║╚██╗██║   ██║   ╚════██║
██║  ██║╚██████╔╝███████╗██║ ╚████║   ██║   ███████║
╚═╝  ╚═╝ ╚═════╝ ╚══════╝╚═╝  ╚═══╝   ╚═╝   ╚══════╝

Biến mọi repository thành workspace sẵn sàng cho AI agent trong 30 giây.

CLI nhỏ quét project Node.js và sinh các file context cho Cursor, Codex, Claude Code, Copilot và các AI coding agent khác — để agent không còn đoán stack, script hay cấu trúc thư mục của bạn.

Bắt đầu nhanh

npx --package ready-for-agents -- rfa init

Xem trước (nên dùng trước khi ghi file):

npx --package ready-for-agents -- rfa init --dry-run

Sinh file native cho Cursor, Claude Code và GitHub Copilot:

npx --package ready-for-agents -- rfa init --cursor
npx --package ready-for-agents -- rfa init --claude
npx --package ready-for-agents -- rfa init --copilot
npx --package ready-for-agents -- rfa init --all

Cập nhật lại các file context sau khi project thay đổi:

npx --package ready-for-agents -- rfa update
npx --package ready-for-agents -- rfa update --check
npx --package ready-for-agents -- rfa update --check --json
npx --package ready-for-agents -- rfa update --all

Xem file context generated đang khác gì so với project hiện tại:

npx --package ready-for-agents -- rfa diff
npx --package ready-for-agents -- rfa diff --json
npx --package ready-for-agents -- rfa diff --all

Sinh runbook an toàn dữ liệu để mở lại project cũ:

npx --package ready-for-agents -- rfa runbook --dry-run
npx --package ready-for-agents -- rfa runbook

runbook chỉ phát hiện tên biến môi trường từ source code và template an toàn như .env.example; lệnh này không đọc hoặc in giá trị trong .env, .env.local, hay các file .env* không phải template.

Sinh local services cho database/cache phát hiện được:

npx --package ready-for-agents -- rfa docker --dry-run
npx --package ready-for-agents -- rfa docker

Chuẩn bị bundle hồi sinh project trong một lệnh:

npx --package ready-for-agents -- rfa revive --dry-run
npx --package ready-for-agents -- rfa revive

revive chuẩn bị RUNBOOK.md, docker-compose.yml nếu phù hợp, và context tree. Lệnh này không chạy Docker, không install dependencies, không chạy script, và không đọc secret.

Kiểm tra project đã sẵn sàng cho AI agent chưa (không ghi file):

npx --package ready-for-agents -- rfa doctor
npx --package ready-for-agents -- rfa doctor --fix --dry-run
npx --package ready-for-agents -- rfa doctor --fix
npx --package ready-for-agents -- rfa doctor --cwd /path/to/your-project

Sinh GitHub Actions workflow để check readiness và context freshness:

npx --package ready-for-agents -- rfa ci
npx --package ready-for-agents -- rfa ci --dry-run

Biến instruction thô thành prompt gọn, sẵn sàng cho agent (không gọi AI API):

npx --package ready-for-agents -- rfa prompt "kiểm tra doctor --json giúp tôi"
npx --package ready-for-agents -- rfa prompt "kiểm tra doctor --json giúp tôi" --context --compact
npx --package ready-for-agents -- rfa prompt --target en "sửa lỗi doctor --json giúp tôi"
echo "review api. chạy pnpm test" | npx --package ready-for-agents -- rfa prompt --stdin --json

Sau khi install global, form ngắn dùng hằng ngày là:

rfa p "kiểm tra doctor --json hoạt động đúng chưa"

Tạo config cục bộ để bớt phải gõ flag lặp lại:

npx --package ready-for-agents -- rfa config init

Sinh context tree cache gọn cho các file agent đã generated:

npx --package ready-for-agents -- rfa index
npx --package ready-for-agents -- rfa index --json

Hỏi context tree agent nên đọc section nào trước:

npx --package ready-for-agents -- rfa query "how should I verify this change?"
npx --package ready-for-agents -- rfa query "kiểm tra doctor hoạt động đúng chưa" --json

Bảng lệnh nhanh

Dùng lệnh đầy đủ khi viết docs, hướng dẫn hoặc debug. Dùng alias khi làm việc hằng ngày.

| Lệnh đầy đủ | Dạng ngắn | Dùng khi bạn muốn... | Có ghi file không? | | ----------------- | --------- | ---------------------------------------------- | --------------------------------------------- | | rfa init | rfa i | tạo context files cho project | Có, trừ khi dùng --dry-run | | rfa update | rfa u | refresh context đã sinh sau khi repo thay đổi | Có, trừ --dry-run, --check, hoặc --json | | rfa doctor | rfa d | kiểm tra project đã sẵn sàng cho AI agent chưa | Chỉ khi dùng --fix | | rfa diff | — | so sánh context generated với project hiện tại | Không | | rfa ci | — | tạo GitHub Actions workflow cho agent checks | Có, trừ khi dùng --dry-run | | rfa runbook | rfa r | tạo hướng dẫn chạy lại project, không lộ secret | Có, trừ khi dùng --dry-run | | rfa docker | — | tạo local services cho database/cache | Có, trừ khi dùng --dry-run | | rfa revive | — | chuẩn bị runbook, services và context index | Có, trừ khi dùng --dry-run | | rfa prompt | rfa p | biến instruction thô thành prompt có cấu trúc | Không | | rfa config init | rfa c i | tạo .ready-for-agents.json | Có, trừ khi dùng --dry-run | | rfa index | rfa x | tạo .ready-for-agents/context-tree.json | Có, trừ --dry-run hoặc --json | | rfa query | rfa q | chọn section context phù hợp cho một task | Không |

Vì sao cần tool này?

AI agent hoạt động tốt hơn khi đã biết sẵn:

| Không có context | Với ready-for-agents | | ------------------------------------ | ---------------------------------------- | | Đoán npm hay pnpm | Đọc lockfile + package.json | | Bịa lệnh build/test | Dùng script thật trong package.json | | Sửa nhầm lockfile | AGENTS.md ghi rõ file không nên đụng | | Mỗi session phải giải thích lại repo | PROJECT_CONTEXT.md nằm ngay trong repo | | Agent đọc hết context mỗi lượt | query chọn section liên quan trước |

Bạn nhận được gì?

Sau khi dùng các lệnh tương ứng, thư mục gốc project có thể có:

| File | Mục đích | | ---------------------------------------- | ------------------------------------------------------------- | | AGENTS.md | Cách agent làm việc trong repo (quy tắc, folder, test) | | PROJECT_CONTEXT.md | Stack, package manager, dependencies, ghi chú | | COMMANDS.md | Lệnh dev, build, test, lint và script liên quan | | RUNBOOK.md | Hướng dẫn chạy lại project, không lộ secret (runbook) | | docker-compose.yml | Local services được sinh bởi docker / revive | | .cursor/rules/ready-for-agents.mdc | Cursor project rule tùy chọn (init --cursor hoặc --all) | | CLAUDE.md | Hướng dẫn Claude Code tùy chọn (init --claude hoặc --all) | | .github/copilot-instructions.md | GitHub Copilot repository instructions tùy chọn | | .github/workflows/ready-for-agents.yml | GitHub Actions workflow tùy chọn (ci) | | .ready-for-agents/context-tree.json | Context tree cache gọn cho các file generated | | .ready-for-agents.json | Config project tùy chọn (config init) |

my-app/
├── package.json
├── AGENTS.md              ← sinh tự động
├── PROJECT_CONTEXT.md     ← sinh tự động
├── COMMANDS.md            ← sinh tự động
├── RUNBOOK.md             ← sinh bởi rfa runbook
├── docker-compose.yml     ← sinh bởi rfa docker/revive
└── .ready-for-agents/
    └── context-tree.json  ← cache sinh tự động

Cài đặt

Chạy một lần (không cần cài global):

npx --package ready-for-agents -- rfa init

pnpm:

pnpm dlx --package ready-for-agents rfa init

Cài global:

npm install -g ready-for-agents
rfa init

Tên package là ready-for-agents; binary dùng hằng ngày là rfa. Binary legacy ready-for-agents vẫn được publish để tương thích ngược.

Yêu cầu Node.js 18+.

Cách dùng

Sinh context (thư mục hiện tại)

rfa init

Quét project khác

Dùng đường dẫn tuyệt đối (không gõ cd vào --cwd):

rfa init --cwd /Users/you/projects/my-app

Chỉ xem trước, không ghi file

rfa init --dry-run

Ghi đè file đã sinh trước đó

rfa init --force

Sinh file native cho agent

rfa init --cursor
rfa init --claude
rfa init --copilot
rfa init --all
rfa init --index

Mặc định init, update, và doctor --fix cũng sinh .ready-for-agents/context-tree.json. Bạn có thể tắt trong .ready-for-agents.json bằng "files": { "index": false }, rồi bật riêng từng lệnh bằng --index.

Cập nhật file context đã sinh

update regenerate các file context được chọn. Lệnh này refresh file đã được ready-for-agents sinh trước đó, tạo file còn thiếu, và bỏ qua file user tự viết trừ khi bạn truyền --force.

rfa update
rfa update --dry-run
rfa update --check
rfa update --check --json
rfa update --all
rfa update --index
rfa update --force
rfa update --cwd /Users/you/projects/my-app

So sánh context generated (`diff`)

diff so sánh các file context generated cho project hiện tại với nội dung đang nằm trên disk. Lệnh này không ghi file.

rfa diff
rfa diff --json
rfa diff --all
rfa diff --cwd /Users/you/projects/my-app

Dùng rfa update để refresh file generated sau khi xem diff.

Sinh GitHub Actions workflow (`ci`)

ci tạo .github/workflows/ready-for-agents.yml, dùng để check readiness và độ mới của context generated trên push/pull request.

rfa ci
rfa ci --dry-run
rfa ci --force
rfa ci --cwd /Users/you/projects/my-app

Sinh runbook để mở lại project (`runbook`)

runbook tạo RUNBOOK.md gồm setup, tên biến môi trường, scripts, runtime notes và checklist chạy lại project cũ.

Privacy là mặc định: lệnh này không đọc hoặc in giá trị từ .env, .env.local, .env.production, hay các file .env* không phải template. Template an toàn như .env.example chỉ được dùng để lấy tên biến.

rfa runbook --dry-run
rfa runbook
rfa r --cwd /Users/you/projects/my-app
rfa runbook --force

Sinh local services (`docker`)

docker tạo docker-compose.yml cho service local detect được rõ ràng như MongoDB, PostgreSQL, MySQL và Redis.

rfa docker --dry-run
rfa docker
rfa docker --force
rfa docker --cwd /Users/you/projects/my-app

Hồi sinh project (`revive`)

revive chuẩn bị RUNBOOK.md, docker-compose.yml nếu có service phù hợp, .ready-for-agents/context-tree.json, và next steps để chạy lại project.

rfa revive --dry-run
rfa revive
rfa revive --no-docker
rfa revive --no-index
rfa revive --force --cwd /Users/you/projects/my-app

Kết hợp flag

rfa init --cwd ./my-app --dry-run
rfa init --cwd ./my-app --force

Tùy chọn CLI

| Flag | Mô tả | | -------------- | ---------------------------------------------------------------------- | | --dry-run | In thông tin detect + preview đầy đủ; không ghi ra disk | | --force | Ghi đè AGENTS.md, PROJECT_CONTEXT.md, COMMANDS.md nếu đã tồn tại | | --cursor | Sinh thêm .cursor/rules/ready-for-agents.mdc | | --claude | Sinh thêm CLAUDE.md | | --copilot | Sinh thêm .github/copilot-instructions.md | | --all | Sinh toàn bộ file agent tùy chọn | | --index | Sinh .ready-for-agents/context-tree.json | | --cwd <path> | Thư mục project cần quét (mặc định: thư mục làm việc hiện tại) |

Tùy chọn update

| Flag | Mô tả | | -------------- | ------------------------------------------------------------------ | | --dry-run | Preview nội dung refresh, không ghi file | | --check | Kiểm tra file generated đã cập nhật chưa; không ghi file | | --json | In kết quả check dạng machine-readable; không ghi file | | --force | Ghi đè file hiện có nhưng không có marker generated | | --cursor | Refresh thêm .cursor/rules/ready-for-agents.mdc | | --claude | Refresh thêm CLAUDE.md | | --copilot | Refresh thêm .github/copilot-instructions.md | | --all | Refresh toàn bộ file agent tùy chọn | | --index | Regenerate .ready-for-agents/context-tree.json | | --cwd <path> | Thư mục project cần cập nhật (mặc định: thư mục làm việc hiện tại) |

File generated có một marker nhỏ kèm hash nội dung. Markdown dùng HTML comment marker; YAML dùng comment #. update và diff dùng marker này để phân biệt file do tool sinh với file bạn tự viết tay, và skip file có hash marker không còn khớp body.

Kiểm tra hoặc sửa readiness (`doctor`)

Mặc định chỉ chạy check tĩnh. Khi có --fix, lệnh sẽ tạo file context còn thiếu, refresh file generated đã cũ, và bỏ qua file user tự viết trừ khi bạn truyền --force.

rfa doctor
rfa doctor --fix --dry-run
rfa doctor --fix
rfa doctor --fix --json
rfa doctor --fix --index
rfa doctor --cwd /Users/you/projects/my-app
rfa doctor --json

| Flag | Mô tả | | -------------- | ------------------------------------------------------------------ | | --cwd <path> | Thư mục project cần kiểm tra (mặc định: thư mục làm việc hiện tại) | | --json | In JSON machine-readable cho CI; không in text màu | | --fix | Tạo file thiếu và refresh file generated đã cũ | | --dry-run | Với --fix, preview thay đổi mà không ghi file | | --force | Với --fix, ghi đè file existing không có marker generated | | --cursor | Với --fix, include .cursor/rules/ready-for-agents.mdc | | --claude | Với --fix, include CLAUDE.md | | --copilot | Với --fix, include .github/copilot-instructions.md | | --all | Với --fix, include toàn bộ file agent tùy chọn | | --index | Với --fix, sinh .ready-for-agents/context-tree.json |

Exit code: 0 khi không có check fail; 1 khi có ít nhất một fail (ví dụ thiếu package.json).

Nếu --cwd không tồn tại hoặc không phải thư mục, doctor dừng sau check đầu tiên — báo đúng gốc lỗi, không liệt kê hàng loạt warn “thiếu context file” gây hiểu nhầm.

doctor --fix không sửa lỗi project critical như thiếu hoặc hỏng package.json; bạn cần xử lý các lỗi đó trước.

Cấu trúc instruction (`prompt`)

Biến instruction thô thành prompt gọn, có cấu trúc — chỉ xử lý tĩnh, MVP chưa dùng model dịch.

rfa prompt "kiểm tra doctor --json giúp tôi"
rfa prompt --target en "sửa lỗi doctor --json giúp tôi"
rfa prompt --target vi "Explain what prompt does"
rfa prompt "kiểm tra doctor --json" --context --compact
rfa p "kiểm tra doctor --json"
rfa prompt --stdin
rfa prompt --file task.txt
rfa prompt --cwd /Users/you/projects/my-app "Explain this task"
rfa prompt

| Flag | Mô tả | | --------------------- | ---------------------------------------------------- | | [text] | Instruction (tham số vị trí) | | --stdin | Đọc instruction từ stdin | | --file <path> | Đọc instruction từ file | | --target <auto\|en\|vi> | Chọn instruction ngôn ngữ cho phần response | | --context | Chèn section context liên quan từ context-tree | | --no-context | Tắt context lookup | | --compact | Render prompt ngắn hơn | | --no-compact | Render prompt dạng standard | | --context-limit <n> | Số section context tối đa | | --json | In JSON thay vì Markdown | | --stats | In thống kê độ dài ra stderr | | --cwd <path> | Thư mục project dùng để đọc .ready-for-agents.json |

Exit code: 0 khi thành công; 1 khi input rỗng sau normalize.

--target vẫn là rule-based. Flag này điều khiển instruction ngôn ngữ trong prompt output; không gọi model dịch.

Nếu bỏ --target, prompt đọc prompt.target trong .ready-for-agents.json, sau đó fallback về auto.

p là alias ngắn của prompt với default --context --compact. Dùng --no-context hoặc --no-compact nếu muốn tắt.

Spec: [doc/guide/PROMPT_SPEC.md](./doc/guide/PROMPT_SPEC.md).

Cấu hình mặc định

Dùng config khi bạn thường xuyên muốn cùng optional files, prompt target, hoặc output path cho context tree:

rfa config init
rfa config init --dry-run
rfa config init --force

Config mặc định:

{
  "$schema": "https://ready-for-agents.dev/config.schema.json",
  "files": {
    "cursor": false,
    "claude": false,
    "copilot": false,
    "all": false,
    "index": true
  },
  "doctor": {
    "fix": {
      "all": false,
      "force": false,
      "index": true
    }
  },
  "prompt": {
    "target": "auto",
    "context": false,
    "style": "standard",
    "contextLimit": 5
  },
  "index": {
    "output": ".ready-for-agents/context-tree.json"
  }
}

Tên config hiện tại là .ready-for-agents.json. Tên cũ .agent-context-kit.json vẫn được đọc để tương thích ngược.

Sinh context tree (`index`)

index đọc các file generated và ghi tree gọn gồm heading, anchor, hash, keyword, command, summary và token estimate. Agent hoặc CI có thể đọc cache này trước, thay vì quét lại toàn bộ Markdown mỗi lần.

rfa index
rfa index --dry-run
rfa index --json
rfa index --output .cache/agent-context-tree.json
rfa index --cwd /Users/you/projects/my-app

Output mặc định là .ready-for-agents/context-tree.json và có thể đổi trong config.

Query context liên quan (`query`)

query dùng .ready-for-agents/context-tree.json khi có, hoặc scan live các file context generated hiện có. Output gồm section reference, line range, summary ngắn, lý do match và token estimate để agent đọc đúng phần liên quan trước.

rfa query "how should I verify this change?"
rfa query "kiểm tra doctor hoạt động đúng chưa" --limit 4
rfa query "show stack and dependencies" --json
rfa query "fix build" --cwd /Users/you/projects/my-app

Flow nên dùng:

rfa init --index
rfa query "mô tả task của bạn"

Dùng JSON output cho CI:

rfa doctor --json

{
  "cwd": "/path/to/project",
  "ok": true,
  "score": {
    "passed": 11,
    "warned": 0,
    "failed": 0,
    "total": 11
  },
  "checks": [
    {
      "label": "Project directory found",
      "status": "pass"
    }
  ]
}

Các check (khi thư mục hợp lệ):

| Check | pass | warn | fail | | ------------------------------------------------ | ------------------------------------ | ---------------- | ------------------------------------ | | Thư mục project | tồn tại và là directory | — | không tồn tại / không phải directory | | package.json | có | — | thiếu | | JSON package.json | hợp lệ | — | sai / không đọc được | | Package manager | lockfile hoặc field packageManager | chỉ fallback npm | — | | AGENTS.md, PROJECT_CONTEXT.md, COMMANDS.md | có | thiếu | — | | script dev, build, test | có | thiếu | — | | README.md | có | thiếu | — |

Ví dụ output terminal

ready-for-agents

Detected:
- Project: todoist-style-demo
- Package manager: npm
- Framework: React/Vite + Express
- Database: MongoDB/Mongoose
- Scripts: dev, dev:client, dev:server, build

Would generate:
- AGENTS.md
- PROJECT_CONTEXT.md
- COMMANDS.md
- .ready-for-agents/context-tree.json

──────────────────────────────────────────────
Dry run — no files written.

Khi ghi file thật:

Generated:
- PROJECT_CONTEXT.md
- COMMANDS.md
Skipped:
- AGENTS.md already exists. Use --force to overwrite.

Với --force:

Overwritten:
- AGENTS.md
Generated:
- PROJECT_CONTEXT.md
- COMMANDS.md

doctor (--cwd sai — dừng sớm):

rfa doctor

Checks:
  ✗ Project directory found (/wrong/path does not exist)

Score: 0/1 · 0 warnings · 1 failure

doctor (project hợp lệ, thiếu vài file context):

rfa doctor

Checks:
  ✓ Project directory found
  ✓ package.json found
  ✓ package.json is valid JSON
  ✓ Package manager detected: npm
  ! AGENTS.md found
  ! PROJECT_CONTEXT.md found
  ! COMMANDS.md found
  ✓ dev script found
  ✓ build script found
  ! test script not found
  ✓ README.md found

Score: 6/11 · 4 warnings · 0 failures

Tool detect được gì (MVP)

Phân tích tĩnh (từ package.json, lockfile, folder gốc) — không gọi AI API.

Package manager

Thứ tự ưu tiên: lockfile → field packageManager trong package.json → mặc định npm

| Tín hiệu | Kết quả | | -------------------------------- | ---------------------------- | | pnpm-lock.yaml | pnpm | | yarn.lock | yarn | | bun.lock / bun.lockb | bun | | package-lock.json | npm | | "packageManager": "[email protected]" | pnpm (khi không có lockfile) |

Stack (có thể kết hợp nhiều lớp)

Mỗi lớp chọn rule khớp đầu tiên từ dependencies + devDependencies. Nhiều lớp có thể cùng xuất hiện (frontend + backend + database).

| Lớp | Nhãn detect (theo thứ tự rule) | | -------- | ---------------------------------------------------------------------------- | | Frontend | Next.js, Nuxt, React/Vite, Vue/Vite, React (CRA), React, Vue, Svelte | | Backend | NestJS, Express, Fastify, Koa, Hono | | Database | MongoDB/Mongoose, MongoDB, Prisma, TypeORM, PostgreSQL, MySQL, SQLite, Redis |

Không khớp rule nào → framework summary mặc định Node.js.

Ví dụ full-stack: React/Vite + Express với MongoDB/Mongoose.

Scripts

Map các key logic (alias đầu tiên có trong package.json được dùng):

| Key | Alias cũng được kiểm tra | | ----------- | ---------------------------------------- | | dev | start:dev, develop | | build | build | | test | test, test:unit, test:run | | lint | lint, eslint | | typecheck | typecheck, type-check, check:types | | format | format, prettier, fmt |

Cũng liệt kê script liên quan (dev:client, dev:server, …) nếu có prefix dev:* hoặc được gọi trong lệnh dev.

Folder quan trọng

Kiểm tra ở root: src/, app/, pages/, components/, lib/, tests/.

Mặc định an toàn

Không ghi đè AGENTS.md, PROJECT_CONTEXT.md, COMMANDS.md trừ khi có --force
**--dry-run** không đụng filesystem
Bỏ qua thư mục nặng (node_modules, .git, dist, …) khi quét
Bỏ qua thư mục cache generated (.ready-for-agents/) khi quét
Báo lỗi rõ khi thiếu/sai package.json hoặc --cwd không hợp lệ (init, update, doctor)
doctor dừng sớm khi --cwd sai (tránh warn “thiếu file context” gây nhiễu)

Cách hoạt động

**init** — detect → sinh Markdown:

flowchart LR
  A["package.json"] --> B[Detect]
  C[lockfiles] --> B
  D[dependencies] --> B
  B --> E[ProjectContext]
  E --> F["AGENTS.md"]
  E --> G["PROJECT_CONTEXT.md"]
  E --> H["COMMANDS.md"]
  E --> X[".ready-for-agents/context-tree.json"]

**doctor** — validate; --fix có thể sửa context files an toàn:

flowchart LR
  I["--cwd"] --> J{"thư mục hợp lệ?"}
  J -->|không| K[1 check fail, exit 1]
  J -->|có| L[11 check tĩnh]
  L --> M{--fix?}
  M -->|không| N[Score + exit 0 hoặc 1]
  M -->|có| O["Generate/refresh context files"]

Đặc tả đầy đủ: [doc/guide/README.md](./doc/guide/README.md) (yêu cầu, CLI, mô hình dữ liệu, rule detect, kiến trúc).
Chi tiết mã nguồn: [doc/guide/SRC_WORKFLOW.md](./doc/guide/SRC_WORKFLOW.md).

Phát triển

Clone và làm việc trên CLI:

pnpm install
pnpm dev init --dry-run
pnpm dev init --cwd /path/to/your-project --dry-run
pnpm dev doctor --cwd /path/to/your-project
pnpm dev doctor --fix --dry-run --cwd /path/to/your-project
pnpm dev diff --cwd /path/to/your-project
pnpm dev ci --dry-run --cwd /path/to/your-project
pnpm dev runbook --dry-run --cwd /path/to/your-project
pnpm dev docker --dry-run --cwd /path/to/your-project
pnpm dev revive --dry-run --cwd /path/to/your-project
pnpm dev config init --dry-run --cwd /path/to/your-project
pnpm dev index --dry-run --cwd /path/to/your-project
pnpm dev query "kiểm tra thay đổi này thế nào?" --cwd /path/to/your-project
pnpm test
pnpm typecheck
pnpm build
pnpm start init --help
pnpm start doctor --cwd /path/to/your-project
pnpm start index --cwd /path/to/your-project
pnpm start query "show stack and dependencies" --cwd /path/to/your-project
pnpm --silent start doctor --json --cwd /path/to/your-project

Phát hành: CHANGELOG.md · Publish: PUBLISH_CHECKLIST.md

Trang documentation

Trang docs phong cách research được sinh từ doc/guide sang site/.

pnpm docs:build
pnpm docs:preview

GitHub Pages deploy qua .github/workflows/docs.yml. Trong repository settings, đặt Pages source là GitHub Actions.

Roadmap

rfa doctor — kiểm tra project sẵn sàng cho agent (check tĩnh, không ghi file)
doctor --fix — tạo/refresh context files an toàn
doctor --json — output JSON cho CI
rfa prompt — cấu trúc instruction thô, hỗ trợ --file và interactive mode (không AI API)
prompt --target auto|en|vi — chọn instruction ngôn ngữ cho response
Sinh .cursor/rules, CLAUDE.md, và .github/copilot-instructions.md tùy chọn
rfa update — refresh context sau khi repo thay đổi
rfa diff — so sánh context generated với project hiện tại
rfa ci — sinh GitHub Actions checks cho readiness và context freshness
rfa runbook — sinh hướng dẫn chạy lại project cũ, không lộ secret
rfa docker — sinh local services cho database/cache detect được
rfa revive — chuẩn bị runbook, local services và context index cùng lúc
.ready-for-agents.json — default cho optional files, prompt target, index output
rfa index — context tree cache gọn cho file agent generated
rfa query — chọn section context liên quan trước khi đọc full file
prompt --style
prompt --ai rewrite tùy chọn
Hỗ trợ Python / FastAPI / Django
Tùy chọn tóm tắt bằng AI

Giấy phép

MIT