Imported from nyuta01/fbt (
AGENTS.md). Install upstream withnpx skills add nyuta01/fbt. Copyright stays with the author.
AGENTS.md
This repository is built AI-first. Keep this file compact; it is the routing layer into repository-local source-of-truth docs, not a full manual.
Mission
fbt is a file build tool: a lightweight local-first control plane for
filesystem artifact transformations, especially LLM and agent-generated
knowledge artifacts. Core does not implement document conversion, OCR, LLM
providers, or agent runtimes; those belong to external runners.
Start Here
Read these in order before changing code:
README.md- repository entry point and documentation map.docs/design-doc.md- product principles, architecture, roadmap, decisions.docs/spec.md- overall semantics and MVP acceptance criteria.docs/project-config-spec.md- user-facing YAML contract.docs/runner-protocol-spec.md- core/runner boundary.docs/methodology/harness-engineering.md- AI-first workflow.docs/methodology/self-pdca-loop.md- task loop.docs/methodology/permanent-fix-protocol.md- repeated failure handling.docs/exec-plans/feature-list.json- structured task state.AGENT_PROGRESS.md- latest handoff state.
Working Rules
- Work one bounded task at a time.
- Prefer boring, inspectable infrastructure that agents can reason about.
- Do not mark work done from code inspection alone; run the relevant checks.
- If behavior changes, update the matching spec, design doc, or plan.
- If an agent failure repeats, promote the fix into docs, scripts, or a deterministic check.
- Keep
fbtcore lightweight: no daemon, scheduler, metadata DB, cloud account, or heavyweight runner dependency in the base tool. - Keep runner/plugin behavior outside core unless a spec explicitly says otherwise.
Verification
Use the harness entrypoint:
make agent-init
Before calling work done, run:
make verify
make verify is the single gate for harness checks, docs checks, Go formatting,
Go tests, and the CLI smoke.
Completion Rule
Before ending a task:
- Update
docs/exec-plans/feature-list.jsonwhen task state changes. - Update the active plan with Observation, Decision, Permanent Fix, and Next Check.
- Update
docs/QUALITY_SCORE.mdwhen quality or risk changed. - Update
docs/agent-failures.mdwhen the task fixes or reveals a repeated agent failure. - Run
make verify. - Leave
AGENT_PROGRESS.mdwith restartable next steps if work is incomplete.