Skip to content

AGENTS.md

Latest commit

 

History

History
55 lines (37 loc) · 1.42 KB

AGENTS.md

File metadata and controls

55 lines (37 loc) · 1.42 KB
Raw

AGENTS.md

Instructions for AI agents working in this repository.

Build & typecheck

Always run after making changes:

bun run build
bun run typecheck

Published packages use compiled dist/ output generated by the build script. TypeScript source files are used by tests and local source-file development.

Testing

bun test

Project layout

src/
└── index.ts    — Plugin entrypoint, hooks into tool execution

Key conventions

  • Bun over Node — use bun, bun test, bun run. Never use node, npx.
  • No comments unless explicitly requested.
  • AWS auth error patterns — all AWS auth error detection happens in AWS_AUTH_ERROR_PATTERNS in src/index.ts. Add new patterns there.
  • Single credential refresh — use the refreshInProgress flag to prevent concurrent refresh attempts.
  • Tool hooks — only bash and task tools are monitored for AWS auth errors.

Commit message format

All commits must follow Conventional Commits:

<type>[optional scope]: <description>

Common types: feat, fix, perf, refactor, test, docs, ci, chore, build.

Use ! or a BREAKING CHANGE: footer for breaking changes.

Examples:

feat: add support for custom SSO login command
fix: handle concurrent refresh requests correctly
chore(deps): bump @opencode-ai/plugin to 1.14.20