Getting started

faf-cli reads your repo and writes the context file your AI coding agent needs — detected from your real stack, never guessed.

Try it on any repo first

faf git facebook/react

Clones shallow, reads the tree — languages, frameworks, docker-compose services, Makefile targets — and writes a scored project.faf. No install of the repo, no config. Point it at anything on GitHub.

---

For your own project, three steps.

A — Install it

bunx faf

No install needed: npx faf and pnpm dlx faf work the same way. Or keep it: npm i -g faf-cli

B — Run it

faf

Detects your stack, writes project.faf, scores it 0–100%.

C — Use it

faf export --agents

Writes AGENTS.md from your project.faf — or prefaces an existing one with the facts, non-destructive to your content. Also: --gemini, --cursor, --copilot, --all. See Export for every target.

Plain output

Colour shows only in a terminal. Piped output, CI logs and agent tools get plain text. NO_COLOR (any value) turns colour off; FORCE_COLOR turns it on, even when piped, and FORCE_COLOR=0 or false turns it off, even in a terminal. Error messages are coloured only when they go to a terminal.

---

That's it. Your AI now has context that versions with your code — no re-explaining, no drift.

Next: Custom rules