菜单
Use heyvm proxy, connect, share, ssh, and bind commands to expose ports, connect to remote sandboxes over P2P (iroh), mount remote workspaces, and share sandbox shells.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Use the Heyo Cloud API to manage deployed sandboxes — execute commands, read/write files, start/stop sandboxes, and check status. Use when an agent needs to interact with a running deployed sandbox programmatically.
Deploy apps to Heyo cloud sandboxes — archive code, deploy to production, bind ports, set up custom domains, and manage deployed sandboxes. Use when the user wants to deploy, update, or manage a running app.
Build Dockerfiles for Firecracker microVM rootfs images and manage them with `heyvm mvm`. Use when the user wants to create a Firecracker image, write a Dockerfile for a Firecracker VM, or build/list/manage Firecracker rootfs images.
Log in to the Heyo platform via `heyvm login` — authenticate with email/password or API key to enable cloud sandbox operations (deploy, list, archive, etc.).
Create, start, stop, restart, list, and exec commands in heyvm sandboxes. Use when the user wants to manage sandbox lifecycle, run commands in isolated environments, or configure sandbox settings like mounts, ports, and backend types.
Check if the host system meets all requirements to run VM sandboxes. On Linux, verifies KVM, Firecracker, kernel images, networking permissions. On macOS, verifies Apple Container and Apple Virtualization native (apple_virt) readiness and VM images. Runs a full end-to-end test on each platform. Use when the user wants to diagnose setup issues or verify their host is ready.
| name | heyvm-proxy |
| description | Use heyvm proxy, connect, share, ssh, and bind commands to expose ports, connect to remote sandboxes over P2P (iroh), mount remote workspaces, and share sandbox shells. |
| argument-hint | [subcommand] [args...] |
| allowed-tools | Bash, Read, Grep |
You are helping the user expose local services, connect to remote sandboxes, share sandbox shells, and mount remote workspaces using the heyvm P2P networking features (powered by iroh).
The binary is heyvm. If it is not on PATH, build it from mvm-ctrl/:
cargo build --release -p heyvm
Most proxy/connect commands sync endpoint shortnames to the cloud and require authentication. Ensure the user is logged in first:
heyvm login
Token is loaded automatically from ~/.heyo/token.json. Commands degrade gracefully (local-only) without auth.
| Command | Purpose |
|---|---|
heyvm proxy start | Expose a local port over iroh P2P |
heyvm proxy list | List saved proxy endpoints |
heyvm proxy sync | Sync endpoints with the cloud |
heyvm proxy add | Save an endpoint shortname |
heyvm connect | Connect to a remote proxy |
heyvm ssh | SSH into a shared sandbox |
heyvm share | Share a sandbox shell over P2P |
heyvm bind | Bind a local sandbox port to a public hostname |
heyvm proxy start <PORT>Starts an iroh P2P proxy server on a local port. Prints a heyo:// connection URL that others can use to connect.
heyvm proxy start 3000
Options:
| Flag | Description |
|---|---|
--name <NAME> | Save the endpoint under a shortname (synced to cloud) |
-r, --relay <URL> | Relay server URL for short ticket codes |
Example with shortname:
heyvm proxy start 8080 --name my-server
Others can then connect by shortname: heyvm connect my-server
The server runs until Ctrl+C.
heyvm connect <TICKET_URL_OR_SHORTNAME>Connects to a remote iroh proxy and forwards traffic to a local port.
# Connect by full URL
heyvm connect heyo://abc123...
# Connect by saved shortname
heyvm connect my-server
Options:
| Flag | Description |
|---|---|
-p, --port <PORT> | Local port to listen on (default: random) |
-r, --relay <URL> | Relay server URL for short ticket lookup |
--save <NAME> | Save this connection under a shortname for future use |
--shell | After connecting, open an interactive SSH shell |
--run-host | Mount remote workspace via SSHFS and run a host command |
--mount-path <PATH> | Sandbox path to mount (default: /workspace, used with --run-host) |
-- <COMMAND...> | Host command to run (used with --run-host) |
Default (TCP proxy):
heyvm connect my-server -p 8080
# Proxies localhost:8080 -> remote service
Interactive SSH shell:
heyvm connect my-server --shell
Mount remote workspace and run a command:
heyvm connect my-server --run-host -- code .
This mounts the remote /workspace via SSHFS, sets up path reconciliation, creates a CLAUDE_CODE_SHELL wrapper for remote command execution, and runs the given host command in the mounted directory. Cleanup (unmount, temp files) happens automatically on exit.
heyvm ssh <TICKET_URL_OR_SHORTNAME>Opens an SSH session to a shared sandbox.
# Interactive shell
heyvm ssh my-sandbox
# Run a specific command
heyvm ssh my-sandbox -- ls /workspace
Options:
| Flag | Description |
|---|---|
-p, --port <PORT> | Local port to listen on (default: random) |
-r, --relay <URL> | Relay server URL for short ticket lookup |
--save <NAME> | Save this connection under a shortname |
-- <COMMAND...> | Command to run in the remote sandbox |
heyvm share <ID_OR_SLUG>Shares a sandbox's SSH over the iroh P2P proxy so others can connect.
heyvm share my-sandbox --name pair-session
Options:
| Flag | Description |
|---|---|
-r, --relay <URL> | Relay server URL for short ticket codes |
--name <NAME> | Save the connection URL under a shortname |
What happens:
heyo:// connection URLConnecting to a shared sandbox:
# By shortname (if --name was used)
heyvm ssh pair-session
# By full URL
heyvm ssh heyo://abc123...
# Or with connect for non-SSH use
heyvm connect pair-session --shell
heyvm bind <ID_OR_SLUG> <PORT>Proxies a local sandbox port to a public hostname. Requires the API_HOSTNAME environment variable.
API_HOSTNAME=heyo.computer heyvm bind my-sandbox 8080
Important: heyvm bind only works for local sandboxes. For deployed (cloud) sandboxes, use the cloud API — see the /deploy skill.
heyvm proxy listLists all saved proxy endpoints (local and cloud-synced).
heyvm proxy list
Displays a table with columns: SHORTNAME, TICKET_URL, CREATED.
heyvm proxy syncBidirectional sync of endpoint shortnames between local storage and the cloud.
heyvm proxy sync
heyvm proxy add <SHORTNAME> <TICKET_URL>Manually save a heyo:// connection URL under a shortname.
heyvm proxy add my-server heyo://abc123...
The ticket URL must start with heyo://.
| Location | Contents |
|---|---|
~/.heyo/proxy-endpoints.json | Local shortname-to-URL mappings |
| Cloud (via API) | Synced endpoints at /p2p-proxy-endpoints |
| Variable | Description |
|---|---|
API_HOSTNAME | Required for heyvm bind (public hostname for proxy) |
HEYO_RELAY_URL | Fallback relay server URL for share/connect |
# Person A: share the sandbox
heyvm share my-sandbox --name pair-session
# Person B: connect and open a shell
heyvm ssh pair-session
# Or mount the workspace locally
heyvm connect pair-session --run-host -- code .
# Start a dev server in a sandbox
heyvm exec my-sandbox -- npm run dev
# Expose it over P2P
heyvm proxy start 3000 --name my-app
# Remote collaborator connects
heyvm connect my-app -p 3000
# Then visit http://localhost:3000
# Save on first connect
heyvm connect heyo://abc123... --save staging
# Reuse the shortname later
heyvm ssh staging
heyvm connect staging -p 8080
When the user provides $ARGUMENTS, interpret them as a proxy/connect subcommand. For example:
/heyvm-proxy start 8080 should run heyvm proxy start 8080/heyvm-proxy connect my-server --shell should run heyvm connect my-server --shellIf $ARGUMENTS is empty, ask the user what they want to do:
heyvm proxy startheyvm connectheyvm shareheyvm ssh