vrr/wirenboard-agent-vm
2
0
Fork 0
mirror of https://github.com/wirenboard/agent-vm.git synced 2026-07-09 16:00:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

help: fix review findings in the regrouped CLI help

Browse source 
Follow-up to the help regroup (f881e07), addressing a code review of
that change.

  - The `--help` example `agent-vm shell -- -c 'cargo test'` was wrong
    and would not run. The launcher already wraps a Shell agent's
    trailing args in `bash -c <shell-escaped args>`, so a literal `-c`
    is double-applied: the guest runs `bash -c "-c 'cargo test'"`, bash
    takes `-c` as the command name -> `bash: -c: command not found`,
    exit 127. Changed to `agent-vm shell -- cargo test`.

  - The Examples/Networking/Environment footer hangs off the single
    `run::Args` shared by claude/codex/opencode/shell, so it renders
    verbatim under every verb. The examples are claude-flavoured
    (`-- --model opus`), which read as authoritative under
    `agent-vm codex --help`. Labelled the block "(claude shown;
    codex/opencode/shell take the same options)" and dropped the
    now-false "command-agnostic" comment.

  - The Environment section omitted two env vars the launch path
    honours: AGENT_VM_STATE_DIR (host_paths::state_root) and
    AGENT_VM_INSECURE_REGISTRY (is_plain_http_registry). Added both.

  - `--publish` value_name was `[BIND:]HOST:GUEST`; the port fields read
    as hostnames. Changed to `[BIND:]HOST_PORT:GUEST_PORT`, matching the
    real parse format and the per-flag long help.

  - Rewrote the networking cheatsheet: dropped the per-row format
    abbreviations (they duplicated the value_names and pushed the
    longest row to ~88 cols, which wrap_help reflows and de-aligns on an
    80-col terminal) and kept the direction arrows. All footer lines are
    now <=76 cols.

  - Cargo.toml `description` said "Sandboxed VMs"; `about` says
    "microVMs". Aligned to "microVMs".

Presentation-only; no flag, env var, or behaviour changed.
`cargo test -p agent-vm`: 123 passed. Rendered `-h`/`--help` for claude
and codex verified against the rebuilt binary.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Evgeny Boger 2026-05-31 16:12:10 +03:00
parent 6513050a31
commit 7ebb0b0a3d
2 changed files with 16 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

2
crates/agent-vm/Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "agent-vm"
description = "Sandboxed VMs for AI coding agents, built on microsandbox."
description = "Sandboxed microVMs for AI coding agents, built on microsandbox."
version.workspace = true
edition.workspace = true
license.workspace = true

27
crates/agent-vm/src/run.rs
View file

@ -96,10 +96,11 @@ impl Agent {
// Footer shown under `-h` (the short summary). A few high-value
// examples plus a pointer to `--help`. Printed verbatim by clap, so
// this is exactly what the user sees. Kept command-agnostic: all four
// launch verbs (claude/codex/opencode/shell) share this `Args`.
// this is exactly what the user sees. One `Args` backs all four launch
// verbs (claude/codex/opencode/shell), so this footer can't vary per
// verb — the examples use `claude` and the header says so.
const LAUNCH_AFTER_HELP: &str = "\
Examples:
Examples (claude shown; codex/opencode/shell take the same options):
agent-vm claude launch Claude Code in the current project
agent-vm shell open a bash shell instead
agent-vm claude -p 8080:3000 publish guest :3000 to host 127.0.0.1:8080
@ -107,27 +108,29 @@ Examples:
Trailing args go to the agent. Run with --help for networking, security, and env details.";
// Fuller footer shown under `--help`. Same command-agnostic constraint.
// Fuller footer shown under `--help`. Same single-`Args` constraint.
const LAUNCH_AFTER_LONG_HELP: &str = "\
Examples:
Examples (claude shown; codex/opencode/shell take the same options):
agent-vm claude launch in the current project
agent-vm shell open a bash shell instead
agent-vm shell -- -c 'cargo test' run one command, then exit
agent-vm shell -- cargo test run one command, then exit
agent-vm claude -- --model opus --resume forward args to the agent
agent-vm claude --memory 8 --cpus 4 a bigger sandbox
agent-vm claude --mount ~/ref -p 3000:3000 extra mount + publish a port
agent-vm claude --repo owner/other-repo widen the GitHub allow-list
Networking (deny-by-default; flags compose):
--publish [BIND:]HOST:GUEST host → guest open an inbound port
--auto-publish guest → host mirror every guest listener to loopback
--allow-egress IP|CIDR guest → IP/LAN open one address or subnet
--allow-lan guest → LAN open the whole private range
--allow-host guest → host reach services on host 127.0.0.1
--publish host → guest open an inbound port to a guest service
--auto-publish guest → host mirror guest listeners onto host loopback
--allow-egress guest → IP/LAN reach one IP or subnet
--allow-lan guest → LAN reach the whole private range
--allow-host guest → host reach the host's 127.0.0.1 services
Environment:
AGENT_VM_MEMORY_GIB / AGENT_VM_CPUS same as --memory / --cpus
AGENT_VM_IMAGE_TAG same as --image
AGENT_VM_INSECURE_REGISTRY allow plain-HTTP registry pulls
AGENT_VM_STATE_DIR override the per-project state dir
AGENT_VM_PROFILE print per-phase boot timings
AGENT_VM_DEBUG_CONFIG dump the SandboxConfig JSON before boot
AGENT_VM_NO_CHROME_MCP skip the Chrome DevTools MCP setup
@ -187,7 +190,7 @@ pub struct Args {
/// guest IP from `MSB_NET_IPV4`); a bare `127.0.0.1` bind inside
/// the guest is not reachable because the smoltcp dial target is
/// the guest's assigned VLAN address, not loopback.
#[arg(long = "publish", short = 'p', value_name = "[BIND:]HOST:GUEST",
#[arg(long = "publish", short = 'p', value_name = "[BIND:]HOST_PORT:GUEST_PORT",
help_heading = "Mounts & ports")]
publish: Vec<String>,