CLI reference · HareBox docs

The binary is harebox. Tables on a terminal, JSON when piped, and JSON Lines for streams. harebox help --json prints this as data.

Exit code	Means
0	Success
2	Usage
3	Auth
4	Not found
5	Wrong state
6	Limit or budget
7	Capacity
8	Network

harebox exec returns the remote command's own exit code.

Command	What it does
`harebox whoami`	Get the current identity
`harebox org list`	List organizations
`harebox org new`	Create an organization
`harebox org set`	Update organization settings
`harebox org switch`	Set the active organization
`harebox org members`	List members
`harebox org invite`	Invite a member
`harebox org member set`	Change a member's role or caps
`harebox org remove`	Remove a member
`harebox project list`	List projects
`harebox project new`	Create a project
`harebox project set`	Update a project
`harebox project rm`	Delete an empty project
`harebox login --agent`	Register an agent without a pasted key
`harebox limits`	Get limits and what remains
`harebox rates`	Get the public rate card
`harebox regions`	Show the EU region
`harebox harnesses`	List harnesses and models
`harebox data-retention status`	Get the retention policy
`harebox data-retention set`	Update the retention policy
`harebox deletion status`	Get a deletion operation
`harebox op`	Get any long-running operation
`harebox audit`	Read the audit log
`harebox repo list`	List connected repositories
`harebox repo add`	Connect a repository
`harebox api-key list`	List API keys
`harebox api-key new`	Create a scoped API key
`harebox api-key set`	Edit a key's name, scopes, IP allowlist or budget
`harebox api-key revoke`	Revoke an API key
`harebox api-key rotate`	Rotate an API key with an overlap window
`harebox api-key usage`	Get usage of an API key
`harebox webhook list`	List webhooks
`harebox webhook new`	Create a webhook
`harebox webhook info`	Get a webhook
`harebox webhook set`	Update a webhook
`harebox webhook rm`	Delete a webhook
`harebox webhook rotate`	Rotate the signing secret with an overlap window
`harebox webhook deliveries`	List delivery attempts
`harebox webhook redeliver`	Redeliver an event
`harebox webhook test`	Send a signed test event
`harebox events types`	List every event type and schema URL
`harebox events`	Read account events with a cursor
`harebox events --follow`	Stream account events over SSE
`harebox telemetry`	Get the OpenTelemetry export
`harebox telemetry set`	Set the OpenTelemetry export
`harebox telemetry rm`	Remove the OpenTelemetry export
`harebox ci`	Get CI status and connected accounts
`harebox ci connect`	Connect a GitHub account or org
`harebox ci public`	Set the policy for public repositories
`harebox ci job`	Get a CI job
`harebox ci logs`	Read CI job logs
`harebox ai profiles`	List credential profiles
`harebox ai profile new`	Create a credential profile
`harebox ai profile set`	Rename a profile or make it the default
`harebox ai profile rm`	Delete a credential profile
`harebox ai key set`	Set an API key
`harebox ai key rm`	Remove a credential
`harebox ai accounts`	List accounts of a credential
`harebox ai account add`	Add another key to a credential
`harebox ai account switch`	Switch to another account
`harebox ai account rm`	Forget an account
`harebox ai api set`	Set a custom API
`harebox ai api rm`	Remove a custom API
`harebox proxy`	Get the credentials proxy
`harebox proxy set`	Configure the credentials proxy
`harebox proxy rules`	List secret-injection rules
`harebox proxy rule add`	Add a rule binding a secret to host
`harebox proxy rule rm`	Remove a rule
`harebox vault list`	List vault connections
`harebox vault connect`	Connect an external vault
`harebox vault rm`	Disconnect a vault
`harebox ai usage`	Get AI usage
`harebox ai usage ID`	Get AI usage of a sandbox
`harebox ai block`	Block or allow AI access or set a budget
`harebox secrets`	Get the account secrets setup
`harebox secrets set`	Update the account secrets setup
`harebox env list`	List environments
`harebox env new`	Create an environment
`harebox env set`	Update an environment and make a new version
`harebox env rm`	Delete an environment
`harebox env upgrade`	Move running sandboxes to a version
`harebox env var set`	Set a variable
`harebox env var rm`	Remove a variable
`harebox env file set`	Write a secret file
`harebox env file rm`	Remove a secret file
`harebox env repo add`	Add a repository
`harebox env repo rm`	Remove a repository
`harebox list`	List sandboxes
`harebox new`	Create a sandbox, optionally from a template, and optionally queue it
`harebox new --count`	Create many sandboxes in one call
`harebox info`	Get a sandbox
`harebox set`	Update name, labels, deadline, sleep policy or subdomain
`harebox delete`	Delete a sandbox and erase its data
`harebox sleep`	Sleep now and keep memory
`harebox wake`	Wake a sleeping sandbox
`harebox stop`	Save the disk and release the machine
`harebox stop --status`	Get a stop
`harebox resume`	Resume a stopped or failed sandbox
`harebox fork`	Fork a running or stopped sandbox
`harebox resize`	Change size live where possible
`harebox restore`	Restore to a point in time
`harebox recover`	Restart a machine that does not answer
`harebox share`	Share with the organization
`harebox unshare`	Make private
`harebox usage`	Get the exact bill of a sandbox
`harebox metrics`	Get CPU
`harebox exec`	Run a command: wait, stream or detach
`harebox history`	List the command history
`harebox exec --status`	Get a command
`harebox exec --kill`	Signal or stop a command
`harebox attach`	Attach to a command over SSE
`harebox logs`	Read command logs
`harebox ps`	List processes
`harebox file read`	Read a file
`harebox file write`	Write a file
`harebox file rm`	Delete a file
`harebox file ls`	List a directory
`harebox file stat`	Get file details
`harebox file find`	Search files by name
`harebox file grep`	Find text in files
`harebox file mkdir`	Create a directory
`harebox file mv`	Move or rename
`harebox file chmod`	Set permissions
`harebox file replace`	Replace text in files
`harebox file url`	Get a signed download URL
`harebox file url --upload`	Get a signed upload URL
`harebox pull`	Download a file or folder as an archive
`harebox prompt`	Prompt a harness
`harebox prompt --status`	Get a prompt
`harebox conversations`	List conversations
`harebox events ID`	Read sandbox and agent events with a cursor
`harebox events ID --follow`	Stream sandbox and agent events over SSE or WebSocket
`harebox steer`	Steer a running turn
`harebox interrupt`	Interrupt running work
`harebox desktop`	Get a desktop stream URL
`harebox record start`	Start a screen recording
`harebox record list`	List recordings
`harebox record stop`	Stop a recording
`harebox computer`	Screenshot, click, type or scroll
`harebox host list`	List public endpoints
`harebox host`	Expose a port
`harebox host set`	Change auth, domain or title
`harebox host hide`	Stop exposing a port
`harebox host rotate`	Rotate a URL token atomically
`harebox ssh-key add`	Authorize an SSH key
`harebox tunnel`	Open a byte stream to a port inside a sandbox, over WebSocket: what SSH, SCP and port forwarding use
`harebox firewall`	Get host-enforced firewall rules
`harebox firewall set`	Replace firewall rules
`harebox ip list`	List reserved IPs
`harebox ip reserve`	Reserve an IP
`harebox ip attach`	Attach an IP to a sandbox
`harebox ip release`	Release an IP
`harebox domain list`	List custom domains
`harebox domain add`	Add a custom domain
`harebox domain rm`	Remove a custom domain
`harebox mesh list`	List private meshes
`harebox mesh new`	Create a private mesh
`harebox mesh rm`	Delete a private mesh
`harebox snapshots`	List snapshots
`harebox snapshots ID`	List snapshots of a sandbox
`harebox snapshot`	Take a disk or memory snapshot now
`harebox snapshot rm --all`	Delete all snapshots of a sandbox
`harebox snapshot latest`	Get the latest snapshot
`harebox snapshot rm`	Delete a snapshot
`harebox snapshot tree`	Browse a snapshot
`harebox snapshot get`	Download a file or folder from a snapshot
`harebox snapshot pull`	Get a signed archive URL
`harebox template list`	List templates
`harebox template save`	Save a sandbox as a new template version
`harebox template info`	Get a template and its versions
`harebox template rm`	Delete a template or a version
`harebox template shares`	List share codes
`harebox template share`	Create a share code
`harebox template unshare`	Revoke a share code
`harebox fleet list`	List fleets
`harebox fleet new`	Create a fleet
`harebox fleet info`	Get a fleet
`harebox fleet set`	Change a fleet or scale it
`harebox fleet rm`	Delete a fleet and its sandboxes
`harebox fleet prompt`	Send one prompt to every member
`harebox schedule list`	List wake timers and schedules
`harebox schedule new`	Create a wake timer or schedule
`harebox schedule rm`	Delete a schedule
`harebox billing`	Get the plan
`harebox billing plan`	Change the plan
`harebox wallet`	Get the wallet
`harebox wallet quote`	Quote a top-up with its bonus
`harebox wallet pay`	Add money to the wallet
`harebox wallet auto-top-up`	Set auto top-up
`harebox billing card`	Add a payment card
`harebox billing invoices`	List invoices
`harebox usage --all`	Get usage by project, fleet, label, member or size
`harebox usage export`	Export usage per sandbox, with labels, as CSV or JSON Lines
`harebox budget list`	List budgets
`harebox budget new`	Create a hard or soft dollar budget
`harebox budget set`	Change a budget
`harebox budget rm`	Delete a budget
`harebox reserve list`	List reservations
`harebox reserve new`	Commit to capacity for one year
`harebox copilot forecast`	Forecast this month
`harebox copilot`	List savings recommendations with evidence
`harebox copilot apply`	Apply a recommendation

Local commands: login, logout, push, browser, doctor, completion, version, self-update (checks the download's SHA-256), run (one command in a fresh sandbox, then delete it), ssh, scp, forward, ssh-config and tunnel (see SSH and editors).