Skip to content

Add Cursor Cloud specific instructions to AGENTS.md #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olliethedev merged 1 commit into from
Apr 9, 2026
Merged

Add Cursor Cloud specific instructions to AGENTS.md #115

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,28 @@ Detailed patterns and reference material are in the following skills. Read the r
| [`btst-registry`](.agents/skills/btst-registry/SKILL.md) | Shadcn registry | `build-registry.ts`, `EXTERNAL_REGISTRY_COMPONENTS`, adding a plugin |
| [`btst-ai-context`](.agents/skills/btst-ai-context/SKILL.md) | AI chat page context | `useRegisterPageAIContext`, `clientTools`, `BUILT_IN_PAGE_TOOL_SCHEMAS` |
| [`btst-integration`](.agents/skills/btst-integration/SKILL.md) | Consumer integration | Integrating `@btst/stack` into an external app (not monorepo work) |

## Cursor Cloud specific instructions

### Quick reference
- **Package manager:** pnpm 10.17.1 (declared in root `package.json` `packageManager` field)
- **Node.js:** v22.18.0 (`.nvmrc`)
- **Build orchestration:** Turborepo (`turbo.json`)
- **Linter:** Biome (`biome check .`)
- **Test runner:** Vitest (unit), Playwright (E2E)
- **No external services required** — the library uses `@btst/adapter-memory` for testing; no Docker/DB needed.

### Corepack prompt
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.

### Build before test
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.

### Docs site
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.

### Playground
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.

### E2E / codegen projects
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.
Loading