FAF

Appearance

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
  • Export — every file faf can write, and why re-running is always safe
  • Custom rules — pin instructions your AI must follow
  • Context guard — a pre-commit hook that catches context regressions
  • What each command writes — project files, agent files, git and CI, and what leaves your machine
  • Commands — every command, one line each (soon)
  • Scoring — the 0–100% AI-readiness score: always-33, and what counts
  • Sync — keep .faf and CLAUDE.md in step (soon)

Chrome extension ​

  • Agent Discovery Check — checks the site you are on for an AI Catalog, MCP Server Card, llms.txt and WebMCP tools

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

MIT · faf.one