CLI (external)

curl -fsSL https://boxd.sh/downloads/install.sh | sh

boxd login                    # opens browser for OAuth login
boxd logout                   # remove stored credentials
boxd whoami                   # show your user ID and SSH keys

boxd --token=<TOKEN> list              # pass token directly
BOXD_TOKEN=<TOKEN> boxd list           # or via env var

boxd keys create NAME                            # mint a new key, raw value to stdout
boxd keys create NAME --expires-in-secs=86400    # with an expiry (1 day in this example)
boxd keys list                                   # name, prefix, last-used, expires (alias: ls)
boxd keys delete ID                              # revoke a key (alias: rm)

KEY=$(boxd keys create "gh-actions deploy owner/repo")
gh secret set BOXD_API_KEY --repo owner/repo --body "$KEY"

boxd new --name=myapp                           # create a machine
boxd new --name=myapp --restart=never           # restart policy (default: always)
boxd new --name=myapp --auto-suspend-timeout=60 # idle secs before auto-suspend (0 disables)
boxd new --name=myapp --shared                  # in an org context: shared with the whole org from birth
boxd list                                       # list your machines (alias: ls)
boxd info myapp                                 # detailed info (status, image, auto-suspend)
boxd fork myapp --name=myapp-v2                 # fork with full disk copy
boxd fork myapp --auto-suspend-timeout=0        # fork with auto-suspend disabled
boxd fork shared-vm --shared                    # keep a fork of a shared VM shared (default: private to you)
boxd reboot myapp                               # reboot (cold — memory lost, ~2s)
boxd pause myapp                                # pause (warm — memory preserved, sub-ms resume)
boxd resume myapp                               # resume a paused machine
boxd auto-suspend myapp 300                     # suspend after 5 min idle (0 = off, the default)
boxd auto-hibernate myapp 0                     # never hibernate (default: 4 hours idle)
boxd destroy myapp -y                           # destroy (requires -y or --confirm; alias: rm)

boxd exec myapp -- uname -a                           # run a command
boxd exec myapp 'cd /app && npm start'             # shell constructs work
boxd exec myapp -e API_KEY=secret -e DEBUG=1 CMD   # env vars
boxd exec myapp --timeout 30 CMD                   # timeout
boxd exec myapp --tty htop                         # allocate a pseudo-TTY (for interactive tools)
boxd exec myapp --json echo hello                  # JSON: {"output":"hello\n","exit_code":0}

boxd exec myapp -- gcc -v 2>/dev/null               # drop the version banner (it's on stderr)
boxd exec myapp -- cargo build 2>build.log          # only warnings/errors land in build.log
boxd exec myapp -- make 1>/dev/null                 # see only the warnings

boxd connect myapp             # drops you into a shell
boxd ssh myapp                 # alias of `connect`

boxd exec myapp -- uptime         # one-shot, scriptable

boxd ssh-config                                     # write/refresh entries for all your VMs
boxd ssh-config --remove                            # remove the boxd block (no API call)
boxd ssh-config --print                             # render to stdout, don't touch the file (shows each Port)
boxd ssh-config --user=ubuntu                       # override the User line (default: boxd)
boxd ssh-config --prefix=vm-                        # prepend a host-alias prefix (default: none → <vm>.boxd)
boxd ssh-config --identity-file=~/.ssh/boxd_key     # set IdentityFile in each stanza
boxd ssh-config --path=/etc/ssh/ssh_config.d/boxd   # write somewhere other than ~/.ssh/config

ssh myapp.boxd                                      # plain SSH (alias carries HostName + Port)
cursor --remote ssh-remote+myapp.boxd /home/boxd    # Cursor (Remote-SSH)
code   --remote ssh-remote+myapp.boxd /home/boxd    # VS Code
# JetBrains Gateway / Zed: pick `myapp.boxd` from their host picker

boxd cp ./local.txt myapp:/home/boxd/remote.txt    # upload
boxd cp myapp:/home/boxd/remote.txt ./local.txt     # download
boxd cp myapp:/path/file -                          # download to stdout
echo data | boxd cp - myapp:/path/file              # upload from stdin

boxd proxy list --vm=myapp                             # list proxies
boxd proxy new api --vm=myapp --port=3001              # create subdomain
boxd proxy set-port --vm=myapp --port=3000             # change port
boxd proxy set-port --vm=myapp --port=auto             # auto-detect
boxd proxy delete api --vm=myapp                       # remove

boxd expose myapp 5432                  # forward a public port -> :5432 in the VM (TCP)
boxd expose myapp 9999 --udp           # UDP instead
boxd expose myapp 7777 --tcp --udp     # both protocols on one allocated public port
boxd expose --list                     # list all your exposed ports
boxd expose myapp 5432 --remove        # remove a forward, freeing the public port

exposed myapp.boxd.sh:48211 -> 5432 (tcp)

boxd plan list                   # shapes + prices, your current plan marked (alias: ls)
boxd plan upgrade --shape=4x16   # upgrade from free — opens Stripe Checkout in your browser
boxd plan change --shape=8x32    # swap shapes in place, prorated
boxd billing status              # current tier, shape, status, next renewal
boxd billing portal              # Stripe Customer Portal — payment method, invoices, cancel

boxd org list                    # organizations you belong to (active context marked)
boxd org switch acme             # work in the "acme" org context
boxd org switch personal         # back to your personal context
boxd org share myapp             # share a machine with the whole org (every member can reach it)
boxd org unshare myapp           # stop sharing — private to you again (org keeps paying)

boxd completions bash >> ~/.bashrc
boxd completions zsh >> ~/.zshrc

boxd docs                        # opens https://docs.boxd.sh in your browser