Skip to content

docs.faf.one

The FAF manual. Facts for devs.

New here? → Getting started


faf-cli

The command-line tool. Reads your repo, writes the context your AI reads.

  • Getting started — install, first run, done
  • Custom rules — pin instructions your AI must follow
  • Commands — every command, one line each (soon)
  • Scoring — the 0–100% AI-readiness score (soon)
  • Sync — keep .faf and CLAUDE.md in step (soon)

Concepts (soon)

  • What is a .faf — the file, and why
  • The 6 Ws — what a .faf holds

Reference (soon)

  • Glossary — every term, defined once
  • Index — A–Z

More of FAF (the format, the MCP servers) lands here over time. faf-cli leads.

The FAF manual · docs.faf.one