Skip to content

Commit 3647403

Browse files
docs: add Cursor Cloud specific instructions to AGENTS.md
Co-authored-by: Leo <leoisadev1@users.noreply.github.com>
1 parent 951aa14 commit 3647403

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,27 @@ bun run verify:prod
9595
- `git subtree push --prefix=docs-site https://github.com/tryosschat/docs.git main`
9696
- `docs-site/` is external Mintlify docs; `docs/` contains internal deployment docs.
9797
- `bunfig.toml` isolates Bun's own test discovery; use Vitest commands for project tests.
98+
99+
## Cursor Cloud specific instructions
100+
101+
### Environment
102+
- Bun is installed at `~/.bun/bin/bun`; ensure `~/.bun/bin` is on `PATH`.
103+
- Use `bun run test` (not bare `bun test`) to invoke the `vitest run --coverage` script from `package.json`. Bare `bun test` triggers Bun's built-in test runner, which fails because the `bunfig.toml` root (`.bun-tests/`) doesn't exist.
104+
- The `.env.local` files for `apps/web` and `apps/server` are not checked in. They must be created before starting dev servers. Minimal dev defaults: `VITE_CONVEX_URL=http://localhost:3210`, `VITE_CONVEX_SITE_URL=http://localhost:3210` in `apps/web/.env.local`.
105+
106+
### Services
107+
| Service | Command | Notes |
108+
|---------|---------|-------|
109+
| Web (Vite dev) | `bun dev:web` or `cd apps/web && bunx vite dev` | Runs on port 3000 by default. SSR requires all route modules to load cleanly. |
110+
| Convex backend | `bun dev:server` | Requires Convex cloud credentials; connects to a remote Convex project. |
111+
| Extension | `bun dev:extension` | Optional; not needed for core chat flow. |
112+
113+
### Verification commands
114+
- Lint: `bun check` (runs Oxlint via Turbo across all workspaces)
115+
- Tests: `bun run test` (Vitest with coverage)
116+
- Type check: `bun check-types` (runs `tsc --noEmit` in web and extension workspaces; server uses `|| true`)
117+
118+
### Known caveats
119+
- The Convex backend (`bun dev:server`) requires a Convex cloud project. Without one, the backend won't start. Auth features (GitHub OAuth) also require Convex environment variables (`AUTH_GITHUB_ID`, `AUTH_GITHUB_SECRET`, `BETTER_AUTH_SECRET`).
120+
- Redis is optional for development; the `scripts/check-redis.ts` script gracefully skips when Redis is unreachable in dev mode.
121+
- No Docker or local database is required; Convex is the sole data store.

0 commit comments

Comments
 (0)