Skip to main content
The boxd CLI manages machines from your local terminal. It talks to the boxd API directly, so it works without SSH keys, and it is the recommended surface for automation and coding agents.

One command installs the binary, the agent skills, and shell completions.

Install

The installer puts the boxd binary in ~/.local/bin/boxd. It supports macOS (Apple Silicon) and Linux (x86_64 and arm64).

What you get

One install sets up three things:
  • The binary. Every command in the reference, plus an interactive REPL. Running bare boxd in a terminal drops into boxd (org)>, where you type the same commands without the boxd prefix, with tab completion and arrow-key pickers for missing arguments.
  • Client utilities. The bridge that brings your clipboard, local files, and browser into a machine (macOS Apple Silicon for now) is built into the same binary. It’s off by default. Turn it on with boxd config set client-utils.enable true.
  • Agent skill. The installer drops the boxd-cli skill for Claude Code, Codex, and OpenCode. It teaches the agent to drive the CLI and loads automatically whenever the agent works with boxd. Claude Code picks it up from ~/.claude/skills/, and when Codex or OpenCode is on your laptop the same skill lands in their skill directories too.

Verify

Shell completions

Tab-completes commands, flags, and your machine, snapshot, org, proxy, and key names, fetched live. Completions are set up automatically by the installer and on boxd auth login. To (re)install manually:

Upgrade

Re-run the installer any time. It upgrades the binary and the skills together.

Next step

The CLI is installed. Log in next, then browse the full command reference.