Imported from aurokin/agentchat (
AGENTS.md). Install upstream withnpx skills add aurokin/agentchat. Copyright stays with the author.
Agentchat Agent Instructions
Read this file before making changes in this repository.
Quick Reference
- Package manager: Bun. Use
bun installandbun run <script>. - Product name: Agentchat.
- Primary surfaces:
apps/web,apps/server,apps/mobile,packages/convex, andpackages/shared. - Product source of truth: docs/agentchat.
- Harness model: Harness Engineering.
- Git: avoid
git commit --no-verifyso hooks run.
Harness Ladder
- Orient with README.md, docs/agentchat/README.md, and Local Modes.
- Prepare a fresh checkout with
bun install. Populate<repo>/.env.convex.local(apps/server reads it directly viabun --env-file=...; apps/web'snext.config.tsloads it at startup). New worktrees pick it up automatically viawt step copy-ignoredin thepost-starthook. - Use
bun devwhen a live stack is needed; Ctrl+C to stop. Web + server are routed through portless —portless listorportless get <name>show the current URLs (worktrees get a<branch>.subdomain prefix automatically). - Use
wt switch -c <branch>for disposable worktree work;wt removeto tear it down. - Mobile is run separately via
bun --cwd apps/mobile dev(Expo is intentionally outside portless until support matures). - Run the health task for each modified surface:
bun run health:web,bun run health:server,bun run health:mobile,bun run health:shared, orbun run health:convex. - Use repo gates when touching contracts, env, docs, imports, or shared behavior:
bun run env:check,bun run docs:check,bun run lint:repo,bun run verify:ci.
Product Guardrails
- Build for the self-hosted, agent-centric architecture already in progress.
- Do not reintroduce hosted-product assumptions, billing, analytics, attachments, or browser-local product data modes.
- Treat Convex as the source of truth for auth, conversations, runs, and runtime bindings.
- Treat
apps/serveras the runtime layer. Codex is the active runtime. Pi, OpenCode, and Claude Code are planned. - Runtime is an implementation detail of each agent, not a separate user-facing concept. See Provider-Agent Merge Plan and Roadmap.