agentleFS
paruffparuff/uFawkesAI/AGENTS.md

uFawkesAI

AGENTS.md2 starsChanged 24 days agoMITView on GitHub

Loaded on every request, so it stays one page. Detail lives in docs/AGENT_REFERENCE.md (CI gates, commit/hook rules, metrics, assertion runner) and .agents/README.md (full routing); load them when relevant. uFawkesAI: an agent orchestration template for platform engineering (agents, skills, hooks, rules, multi-harness config). Stack: TypeScript · Node 22 · GitHub Actions · OpenTelemetry. Harnesses: OpenCode and Claude Code first-class; Codex and Gemini CLI compatible. All four run in ghcr.io/paruff/fawkes-space and are verified by scripts/multi-harness-smoke.sh (docs/ai-sdlc/dual-harness-template/spec.md R1). CLAUDE.md, .cursorrules, .github/copilot-instructions.md and .cursor/rules/AGENTS.md…

The file

We split this AGENTS.md into the rules it gives an agent

4 rules. About 1 is common, 3 are distinctive, and 0 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No customer PII in AI prompts.

    line 10
  2. Common:

    No secrets, API keys, or credentials in any file.

    line 22
  3. Distinctive:

    No merging your own PR.

    line 23
  4. Distinctive:

    No modifying AGENTS.md (edit the source, never its symlinks).

    line 24

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Agent Instructions — uFawkesAI

Loaded on every request, so it stays one page. Detail lives in docs/AGENT_REFERENCE.md (CI gates, commit/hook rules, metrics, assertion runner) and .agents/README.md (full routing); load them when relevant.

1. AI Policy

  • AI agents implement. Humans decide. No AI-generated code merges without human review.
  • No customer PII in AI prompts.
  • Questions: read-only/question mode. Multi-file work: agentic mode. Unsure which model or mode: docs/MODEL_ROUTING_GUIDE.md.
  • More than 3 files: state scope, list files, ask "Confirm I should proceed?" first.

2. Project

uFawkesAI: an agent orchestration template for platform engineering (agents, skills, hooks, rules, multi-harness config). Stack: TypeScript · Node 22 · GitHub Actions · OpenTelemetry. Harnesses: OpenCode and Claude Code first-class; Codex and Gemini CLI compatible. All four run in ghcr.io/paruff/fawkes-space and are verified by scripts/multi-harness-smoke.sh (docs/ai-sdlc/dual-harness-template/spec.md R1). CLAUDE.md, .cursorrules, .github/copilot-instructions.md and .cursor/rules/AGENTS.md are symlinks to this file.

3. Five Hard Rules

  1. No secrets, API keys, or credentials in any file.
  2. No merging your own PR.
  3. No modifying AGENTS.md (edit the source, never its symlinks); owner approval only.
  4. pre-commit run --all-files passes before every commit.
  5. Agent reports satisfy .agents/assertions/minimal-report.yaml.

4. Routing

Four agents, each a boundary that can block, write or change repo state:

TaskAgentOwns
"Plan how to build X"@plannerscope, tasks, dependency order
"Implement feature X"@buildercode, tests, manifests (the working tree)
"Prove it works" / "Review"@verifierthe verdict; the only agent that can block
"Ship / release / tag"@operatorcommit, PR, tag, publish; never merges

@planner → @builder → @verifier → @operator → human merges. A feature's docs/ai-sdlc/<feature>/{intent,spec,plan}.md comes first (/plan). Load the Superpowers skill for the stage (brainstorming, writing-plans, test-driven-development, verification-before-completion, systematic-debugging, …). Always-on rules: .agents/rules/. Changing any agent configuration: .agents/skills/continuous-evals/SKILL.md.

5. Commits

Conventional Commits, type(scope): description (≤72 chars). Types: feat, fix, docs, style, refactor, test, chore, ci, perf, build, revert. False-positive secret: trailing # pragma: allowlist secret.

6. Workflow: board, gates, review

  • UI changes: read DESIGN.md first (tokens, components, do and don't)
  • Reviewing a PR: apply REVIEW.md (what is Important, verification, validation, security)

Status lives only on Project #7: no status labels, no ✅ in plans. Routing labels say who does the work, not its state. Work traces to docs/ai-sdlc/<feature>/ intent → spec → plan; plans link issues, never list tasks. Statuses, Gate, lifecycle and owner decisions: the board rules.

# 1. Next item for an agent (label: the routing label you run as, claude-code or opencode)
gh project item-list 7 --owner paruff --limit 300 --query 'status:"Ready for agent" is:open label:opencode' \
  --format json --jq '.items | sort_by(.priority // "P9", .content.number) | .[:1][] | "\(.content.repository)#\(.content.number) \(.title)"'
# 2. Waiting on a human, and which gate each waits on
gh project item-list 7 --owner paruff --limit 300 --query 'status:"Needs human" is:open' \
  --format json --jq '.items[] | "\(.gate // "-")\t\(.content.repository)#\(.content.number) \(.title)"'
# Move: "In Progress" before you start; "Needs human" plus Gate "PR review" when the PR is up
gh project item-edit 7 --owner paruff --url <issue url> --field Status --value "In Progress"

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.