Skip to content

Commit bab2eb1

Browse files
cjbellcursoragent
andauthored
chore: set up dev environment - delete environment.json, update AGENTS.md (#741)
- Delete .cursor/environment.json so snapshot-managed settings take effect - Add Cursor Cloud specific instructions to AGENTS.md with dev caveats: - Node >= 20.19.0 required (not 20.9.0 from .tool-versions) - Use bin/dev.js for development (handles @/ path aliases) - No external services needed, tests fully self-contained Co-authored-by: Cursor Agent <cursoragent@cursor.com>
1 parent 04a99c8 commit bab2eb1

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

.cursor/environment.json

Lines changed: 0 additions & 6 deletions
This file was deleted.

AGENTS.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,3 +151,10 @@ The CLI primarily interacts with Knock's Management API via the `@knocklabs/mgmt
151151
- Error messages should be user-friendly and actionable
152152
- Tests are required for new commands and features
153153

154+
## Cursor Cloud specific instructions
155+
156+
- **Node version**: The project requires Node.js >= 20.19.0 (due to `@swc/cli`). The `.tool-versions` file lists `nodejs 20.9.0` but this is outdated; use the latest Node 20.x via nvm (`nvm install 20 && nvm use 20`).
157+
- **Dev entry point**: Use `./bin/dev.js` (not `./bin/run.js`) to run the CLI during development. It uses `ts-node` with `tsconfig-paths/register` to resolve `@/` path aliases. The production `bin/run.js` requires a build step and path alias resolution that SWC does not perform.
158+
- **No external services needed**: This is a self-contained CLI. All tests use `nock` for HTTP mocking — no Knock API access, databases, or Docker required.
159+
- **Standard commands**: See the "Build & Development" section above for `yarn install`, `yarn build`, `yarn test`, `yarn lint`, `yarn type.check`, and `yarn check`.
160+
- **Full check before committing**: Run `yarn check` (which runs lint + format.check + type.check) to validate changes before pushing.

0 commit comments

Comments
 (0)