Skip to content

docs: add dev environment caveats to AGENTS.md #24

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

Draft
JohannesKonings wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

docs: add dev environment caveats to AGENTS.md #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e1fdcd
docs: add dev environment caveats to AGENTS.md for cloud agents
cursoragent Mar 22, 2026
2e0fb57
docs: fix vp install method to use official curl installer
cursoragent Mar 22, 2026
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
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,11 @@ These commands map to their corresponding tools. For example, `vp dev --port 300
- [ ] Run `vp install` after pulling remote changes and before getting started.
- [ ] Run `vp check` and `vp test` to validate changes.
<!--VITE PLUS END-->

### Dev environment caveats

- **Node.js 24.14.0** is required (see `.node-version`). The `vp` CLI must be installed via the official installer: `curl -fsSL https://vite.plus | bash` (see https://viteplus.dev/guide/).
- **Dev server**: `vp dev --port 3000`. Many demo pages (Store, Guitars, Start server functions with in-memory data) work without AWS credentials. DB-backed pages (Todos DynamoDB, Persons) require DynamoDB, and AI chat requires Bedrock.
- **pnpm build script warning**: `pnpm approve-builds` warning for esbuild can be safely ignored — esbuild pre-built binaries work without running its install script.
- **Test suite**: `vp test` runs 2 test files (9 tests total, CDK constructs). A "hanging-process" warning appears after tests pass — this is benign and does not affect results.
- **Lint**: `vp lint` reports pre-existing warnings/errors in the codebase. Use `vp check` for the full format + lint + type-check suite.