Skip to content

Commit 21385c3

Browse files
authored
Merge pull request #115 from better-stack-ai/cursor/env-setup-agents-md-5531
Add Cursor Cloud specific instructions to AGENTS.md
2 parents f20472d + d581f26 commit 21385c3

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,28 @@ Detailed patterns and reference material are in the following skills. Read the r
3535
| [`btst-registry`](.agents/skills/btst-registry/SKILL.md) | Shadcn registry | `build-registry.ts`, `EXTERNAL_REGISTRY_COMPONENTS`, adding a plugin |
3636
| [`btst-ai-context`](.agents/skills/btst-ai-context/SKILL.md) | AI chat page context | `useRegisterPageAIContext`, `clientTools`, `BUILT_IN_PAGE_TOOL_SCHEMAS` |
3737
| [`btst-integration`](.agents/skills/btst-integration/SKILL.md) | Consumer integration | Integrating `@btst/stack` into an external app (not monorepo work) |
38+
39+
## Cursor Cloud specific instructions
40+
41+
### Quick reference
42+
- **Package manager:** pnpm 10.17.1 (declared in root `package.json` `packageManager` field)
43+
- **Node.js:** v22.18.0 (`.nvmrc`)
44+
- **Build orchestration:** Turborepo (`turbo.json`)
45+
- **Linter:** Biome (`biome check .`)
46+
- **Test runner:** Vitest (unit), Playwright (E2E)
47+
- **No external services required** — the library uses `@btst/adapter-memory` for testing; no Docker/DB needed.
48+
49+
### Corepack prompt
50+
When running pnpm in subdirectories (e.g. `docs/`, `playground/`), corepack may prompt to download pnpm. Set `COREPACK_ENABLE_AUTO_PIN=0` in your shell to suppress the interactive prompt, or answer `Y` when prompted.
51+
52+
### Build before test
53+
Turborepo's `test` task depends on `build` (see `turbo.json`). Always run `pnpm build` before `pnpm test` if you haven't built yet in the session.
54+
55+
### Docs site
56+
Run `cd docs && pnpm dev` to start the FumaDocs site at `http://localhost:3000/docs`. The root route (`/`) returns 404; use `/docs` as the entry point.
57+
58+
### Playground
59+
The playground (`cd playground && pnpm dev`, port 3002) requires an `OPENAI_API_KEY` in `playground/.env.local`. Without it, the AI chat plugin won't function but other plugins still work.
60+
61+
### E2E / codegen projects
62+
Codegen projects are generated on-the-fly (not committed). Run `bash scripts/codegen/setup-nextjs.sh` to create the Next.js test project, then `pnpm -F e2e codegen:e2e:nextjs` for E2E tests. See `scripts/codegen/README.md` and `CONTRIBUTING.md` for full details.

0 commit comments

Comments
 (0)