Sync .faf to CLAUDE.md
faf_syncWrite project.faf into CLAUDE.md, AGENTS.md, .cursorrules, GEMINI.md, or copilot-instructions.md as a managed block, keeping all other lines intact. Run after editing project.faf.
Instructions
Write project.faf into CLAUDE.md as a faf-managed block (faf-cli's render and injector), and on request into AGENTS.md (agents), .cursorrules (cursor), GEMINI.md (gemini) and .github/copilot-instructions.md (copilot) — or all of them (all) — with faf-cli's writers. Each file keeps every line outside faf's block. Returns the files written and any requested file that could not be written, with the reason (then isError). Use it after editing project.faf.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | Write every format: CLAUDE.md + AGENTS.md + .cursorrules + GEMINI.md + .github/copilot-instructions.md | |
| path | No | Project path. Sets session context for subsequent calls. | |
| agents | No | Also write AGENTS.md (OpenAI Codex and other agents) | |
| cursor | No | Also write .cursorrules (Cursor IDE) | |
| gemini | No | Also write GEMINI.md (Google Gemini CLI) | |
| copilot | No | Also write .github/copilot-instructions.md (GitHub Copilot) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| score | No | faf-cli's score of that .faf, as text ("85%" or "unknown (—)") | |
| fafPath | No | The .faf the files were written from | |
| filesFailed | Yes | Requested files that were not written | |
| filesWritten | Yes | Files written, CLAUDE.md first |