Skip to content

AGENTS.md

Latest commit

 

History

History
110 lines (87 loc) · 4.16 KB

AGENTS.md

File metadata and controls

110 lines (87 loc) · 4.16 KB

Agent Instructions

This project uses bd (beads) for issue tracking. Run bd prime for full workflow context.

Quick Reference

bd ready              # Find available work
bd show <id>          # View issue details
bd update <id> --claim  # Claim work atomically
bd close <id>         # Complete work
bd dolt push          # Push beads data to remote

Non-Interactive Shell Commands

ALWAYS use non-interactive flags with file operations to avoid hanging on confirmation prompts.

Shell commands like cp, mv, and rm may be aliased to include -i (interactive) mode on some systems, causing the agent to hang indefinitely waiting for y/n input.

Use these forms instead:

# Force overwrite without prompting
cp -f source dest           # NOT: cp source dest
mv -f source dest           # NOT: mv source dest
rm -f file                  # NOT: rm file

# For recursive operations
rm -rf directory            # NOT: rm -r directory
cp -rf source dest          # NOT: cp -r source dest

Other commands that may prompt:

  • scp - use -o BatchMode=yes for non-interactive
  • ssh - use -o BatchMode=yes to fail instead of prompting
  • apt-get - use -y flag
  • brew - use HOMEBREW_NO_AUTO_UPDATE=1 env var

Beads Issue Tracker

This project uses bd (beads) for issue tracking. Run bd prime to see full workflow context and commands.

Quick Reference

bd ready              # Find available work
bd show <id>          # View issue details
bd update <id> --claim  # Claim work
bd close <id>         # Complete work

Rules

  • Use bd for ALL task tracking — do NOT use TodoWrite, TaskCreate, or markdown TODO lists
  • Run bd prime for detailed command reference and session close protocol
  • Use bd remember for persistent knowledge — do NOT use MEMORY.md files

Session Completion

When ending a work session, you MUST complete ALL steps below. Work is NOT complete until git push succeeds.

MANDATORY WORKFLOW:

  1. File issues for remaining work - Create issues for anything that needs follow-up
  2. Run quality gates (if code changed) - Tests, linters, builds
  3. Update issue status - Close finished work, update in-progress items
  4. PUSH TO REMOTE - This is MANDATORY: 
    git pull --rebase
bd dolt push
git push
git status  # MUST show "up to date with origin"
  5. Clean up - Clear stashes, prune remote branches
  6. Verify - All changes committed AND pushed
  7. Hand off - Provide context for next session

CRITICAL RULES:

  • Work is NOT complete until git push succeeds
  • NEVER stop before pushing - that leaves work stranded locally
  • NEVER say "ready to push when you are" - YOU must push
  • If push fails, resolve and retry until it succeeds

Conventions for agent contributors

Note: this section overrides the bead-default "Session Completion" / "PUSH TO REMOTE is MANDATORY" workflow inside the BEADS INTEGRATION block above. The default is wrong for this repository.

  • Local-only commits. Do NOT git push. Do NOT git tag. Do NOT open or push to upstream PRs. Do NOT bd dolt push. Each commit should be cleanly self-describing and reference the bead id in the message when it closes bead-tracked work. The operator publishes when ready.
  • No bead-ID prefixes in code comments. Don't write ;; rf1-XXX item N — ... or similar. Comments should explain the WHY only — the commit message carries the bead-id linkage.
  • Verify APIs and paths before relying on them. Cross-repo references in bead descriptions can drift; grep first.
  • Tests before close. lein test for the JVM-side suite, npx shadow-cljs compile test for the cljs-side suite (after npm install). Both gate CI.
  • bb and npx are on PATH; lein IS installed for this rig (re-frame-10x's mranderson workflow needs lein) — but other rigs may not have it; check before depending on lein cross-rig.
  • Cross-rig coordination via mayor. If a bead's work touches multiple rigs, refuse the bead (release the claim) and message mayor with the split needed.