Skip to content

CLAUDE.md

Latest commit

 

History

History
75 lines (55 loc) · 2.59 KB

CLAUDE.md

File metadata and controls

75 lines (55 loc) · 2.59 KB

Project Instructions for AI Agents

This file provides instructions and context for AI coding agents working on this project.

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

Landing the Plane (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

Build & Test

bun test              # Run all unit tests
bunx tsc --noEmit     # Type check (must pass before any PR)
bun run build         # Build to dist/

Architecture Overview

OpenCode plugin for automatic model fallback on rate limits. See AGENTS.md for full architecture guide and Implementation.plan.md for the detailed plan and phase status.

Key files:

  • src/plugin.ts — event router entry point
  • src/replay/orchestrator.ts — the fragile abort→revert→prompt sequence
  • src/state/ — global model health + per-session fallback state

Conventions & Patterns

  • All imports use .js extensions (ESM/bundler resolution)
  • Errors are caught and logged — never crash the plugin
  • All client API calls are best-effort (fire-and-forget where appropriate)
  • bd for issue tracking — see bd list for open work