Skip to content

Commit 3e8e229

Browse files
cursoragentHmbown
andcommitted
docs: add Cursor Cloud dev-environment setup notes to AGENTS.md
Document non-obvious cloud-VM caveats discovered while setting up the development environment: - libdbus-1-dev is a required system build dep (crates/secrets keyring). - rustup default stable must be set so shells spawned outside the checkout (verifier background jobs, sub-agent worktrees) can find rustc. - Two codewhale-tui subagent tests fail only because the checkout sits directly under / (unwritable parent; /workspace discovered as a nested repo when walking up). Not code bugs; pass under a normal parent dir. - How to run the agent without provider API keys via keyless vllm/ollama pointed at a local OpenAI-compatible endpoint. - The codewhale dispatcher needs its sibling codewhale-tui co-located. Co-authored-by: Hunter Bown <Hmbown@users.noreply.github.com>
1 parent 3e97b27 commit 3e8e229

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

0 commit comments

Comments
 (0)