Skip to content

AGENTS.md

Latest commit

 

History

History
30 lines (25 loc) · 1.66 KB

AGENTS.md

File metadata and controls

30 lines (25 loc) · 1.66 KB
Raw

AGENTS.md

Build/Test/Lint Commands

  • Build: npm run build (tsc + vite)
  • Typecheck: npm run typecheck
  • Lint: npm run lint
  • Test all: npm run test
  • Test single file: npx vitest run path/to/file.test.ts
  • Test watch: npm run test:watch
  • Dev servers: npm run dev (frontend), npm run dev:worker (backend), npm run dev:browser (local Chromium sidecar for the get_browser_console_logs think-agent tool; optional, prints a warning instead of failing if not running)

Code Style

  • No any type - find or create proper types
  • Types: Frontend imports from @/api-types (single source of truth)
  • Formatting: Prettier with single quotes, tabs (see package.json)
  • Naming: React components PascalCase.tsx, utilities/hooks kebab-case.ts, backend services PascalCase.ts
  • Comments: Explain purpose, not narration. No verbose AI-like comments. No emojis.
  • DRY: Search for existing code before creating new. Never copy-paste.
  • Imports: Frontend APIs in src/lib/api-client.ts, types in src/api-types.ts

Error Handling

  • Backend services return null/boolean on error, never throw in RPC methods
  • Use existing error classes from worker/utils/ErrorHandling.ts

Key Patterns

  • Add API endpoint: types in src/api-types.ts -> src/lib/api-client.ts -> service in worker/database/services/ -> controller in worker/api/controllers/ -> route in worker/api/routes/
  • Add LLM tool: create in worker/agents/tools/toolkit/ -> register in worker/agents/tools/customTools.ts

Subsystem Docs

  • Usage limits UI (top-right badge, credits banner, limit popups): see docs/usage-limits-ui.md