Skip to content

Commit 02f05b0

Browse files
authored
docs: add Cursor Cloud dev-environment setup notes to AGENTS.md
Document the non-obvious Cursor Cloud setup caveats and keyless local-provider verification path. Preserve Cursor Agent authorship and Hunter Bown co-author credit.
2 parents ce69bfc + b34395b commit 02f05b0

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,3 +121,37 @@
121121
(`gh issue list --repo Hmbown/CodeWhale --milestone "<current milestone>"`) and
122122
refresh state before acting. Older per-version triage docs under `docs/` are
123123
historical reference only.
124+
125+
## Cursor Cloud specific instructions
126+
127+
Standard build/test/run commands are already documented above and in
128+
`CONTRIBUTING.md`; this section only records the non-obvious cloud-VM caveats.
129+
130+
- **System build dep:** the build needs `libdbus-1-dev` (pulled in by
131+
`crates/secrets` for the OS keyring). It is installed by the startup update
132+
script; if a `cargo build` fails with a `dbus`/`pkg-config` error, that dep is
133+
missing.
134+
- **`rustup default` must be set:** some tests and runtime paths spawn shells in
135+
temp dirs *outside* this checkout (e.g. `run_verifiers_background_*`, sub-agent
136+
worktrees). Those spawned shells only see the repo's `rust-toolchain.toml`
137+
override while inside `/workspace`, so without a global default they fail with
138+
"rustup could not choose a version of rustc to run". The update script runs
139+
`rustup default stable` to fix this.
140+
- **Known env-specific test failures at `/workspace` (not code bugs):** because
141+
the checkout sits directly under `/`, two `codewhale-tui` subagent tests fail
142+
here — `git_repo_root_reports_attempted_paths_when_no_repo_found` (cannot
143+
create a temp dir in the unwritable parent `/`) and
144+
`create_isolated_worktree_reports_friendly_error_when_no_repo_found` (walking
145+
up to `/` discovers `/workspace` itself as a repo). Both pass when the repo is
146+
checked out under a normal, writable parent. `run_verifiers_background_*` is
147+
the separate pre-existing flake already noted above. Everything else in
148+
`cargo test --workspace` passes (~6384 tests).
149+
- **Running the agent without provider API keys:** point CodeWhale at any local
150+
OpenAI-compatible endpoint via the keyless `vllm`/`ollama`/`sglang` providers,
151+
e.g. `CODEWHALE_PROVIDER=vllm VLLM_BASE_URL=http://127.0.0.1:8000/v1
152+
VLLM_MODEL=<id> codewhale exec --auto "..."`. `codewhale exec` (add `--auto`
153+
for tool use) is the non-interactive path to exercise the full agent loop.
154+
- **Dispatcher needs its sibling:** the `codewhale` binary shells out to a
155+
sibling `codewhale-tui` in the same directory (both land in `target/debug`
156+
after a build). If they are not co-located, set `DEEPSEEK_TUI_BIN` to the
157+
`codewhale-tui` path.

0 commit comments

Comments
 (0)