From 8685bdcd6966dc49937c977a6cd9c27ffe63a336 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Tue, 23 Jun 2026 11:50:59 +0000 Subject: [PATCH] Document Cursor Cloud setup caveats Co-authored-by: Yogesh Agarwal --- AGENTS.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..23b5177 --- /dev/null +++ b/AGENTS.md @@ -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.