Skip to content

Commit 7f3c56c

Browse files
committed
docs: add Cursor Cloud specific instructions to AGENTS.md
1 parent d891180 commit 7f3c56c

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,21 @@
2424
- Language: TypeScript (ESM)
2525
- Formatting/linting: Oxlint + Oxfmt
2626
- Run `pnpm check` before commits
27+
28+
## Cursor Cloud specific instructions
29+
30+
### Services
31+
32+
| Service | Command | Port | Notes |
33+
|---|---|---|---|
34+
| Gateway (core) | `OPENSOUL_SKIP_CHANNELS=1 OPENSOUL_GATEWAY_TOKEN=dev-token pnpm gateway:dev` | 19001 | Serves HTTP + WS + Web Control UI |
35+
36+
### Gotchas
37+
38+
- **Gateway requires a token**: set `OPENSOUL_GATEWAY_TOKEN` env var or pass `--token`. Without it the process exits immediately with an auth error.
39+
- **`OPENSOUL_SKIP_CHANNELS=1`**: use this when running the gateway locally to avoid loading channel extensions that require external API credentials.
40+
- **Build before gateway:dev on first run**: `pnpm gateway:dev` (via `scripts/run-node.mjs`) auto-rebuilds if `dist/` is stale, but the first UI build is triggered automatically. Set `OPENSOUL_A2UI_SKIP_MISSING=1` when building if A2UI canvas sources are absent (they usually are).
41+
- **`.npmrc` GITHUB_TOKEN warning**: harmless; the token is only needed for publishing to GitHub Packages. Can be ignored during local dev.
42+
- **Tests (`pnpm test`)**: runs 3 vitest configs in parallel/serial via `scripts/test-parallel.mjs` (unit, extensions, gateway). Total ~850 test files, ~5 400 tests. Takes ~8 min in a Cloud VM. The `canvas:a2ui:bundle` step is a prerequisite for tests (CI runs it inline).
43+
- **Pre-existing lint/format issues**: `pnpm lint` (oxlint) reports ~13 errors in `ui/` and `pnpm format` (oxfmt) reports ~50 format issues — all pre-existing in the repo.
44+
- **No external DB**: uses embedded SQLite (`sqlite-vec`); no Postgres/Redis setup needed.

0 commit comments

Comments
 (0)