Skip to content

AGENTS.md

Latest commit

 

History

History
30 lines (24 loc) · 1.3 KB

AGENTS.md

File metadata and controls

30 lines (24 loc) · 1.3 KB

opencode agent guidelines

Build/Test Commands

  • Install: bun install
  • Dev: bun dev (runs packages/opencode/src/index.ts)
  • Typecheck: bun run typecheck (runs across all workspaces)
  • Test: bun test (runs all tests)
  • Single test: bun test packages/opencode/test/tool/tool.test.ts (specific test file)
  • Go tests: go test ./... (in packages/tui/sdk/)

Code Style

  • Runtime: Bun with TypeScript ESM modules, Go for TUI
  • Imports: Use relative imports for local modules (./, ../), named imports preferred
  • Types: Zod schemas for validation, TypeScript interfaces for structure
  • Naming: camelCase for variables/functions, PascalCase for classes/namespaces
  • Error handling: Use Result patterns, avoid throwing exceptions in tools
  • File structure: Namespace-based organization (e.g., Tool.define(), App.provide())
  • Formatting: Prettier with semi: false, printWidth: 120

IMPORTANT Rules

  • Keep functions focused - avoid unnecessary composition unless reusable
  • AVOID destructuring unless it improves readability
  • AVOID else statements where possible
  • AVOID try/catch - prefer letting exceptions bubble up
  • AVOID any type and let statements
  • PREFER single word variable names
  • Use Bun APIs like Bun.file() over Node.js equivalents