Skip to content

Document Cursor Cloud setup caveats #22

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
saggiyogesh wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Document Cursor Cloud setup caveats #22

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
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Agent instructions

## Cursor Cloud specific instructions

- Standard setup and run commands live in `README.md` and the WSL2-specific sandbox guide lives in `docs/wsl2-setup.md`; use those as the source of truth for normal developer workflows.
- The API service can be developed and tested against MongoDB without booting sandboxes. In Cursor Cloud, full sandbox creation/execution also requires `/dev/kvm`, `cloud-hypervisor`, a configured bridge/NAT, and base image/kernel files; if those are absent, expect only API/database flows such as version, org/API-key, image listing, and sandbox listing to work.
- The current router does not mount the README's public `/api/register` example. For local API bootstrapping without Clerk credentials, start the server with `AUTH_LOCAL_MODE=true`, create an API key through `/api/orgs/apikeys`, then restart with normal auth and use that key via `X-API-Key`.
- When running API-only checks in an environment without sandbox VM support, set `HEALTH_ENABLED=false`, `MONITOR_ENABLED=false`, and `AUTO_LIFECYCLE_ENABLED=false` so startup does not try to manage unavailable VM runtime state.