Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt

Use this file to discover all available pages before exploring further.

If you are an agent reading this doc, visit llms.txt or llms-full.txt instead.

​
Ways to use boxd

SSH

No install needed. Run ssh boxd.sh to manage machines, ssh name.boxd.sh to connect directly.

External CLI

Install the boxd binary on your machine. Token auth, shell completions, best for automation.

Internal CLI

Pre-installed inside every VM as boxd. Auto-auth by IP. Manage VMs from within a VM.

HTTPS

Every machine gets https://name.boxd.sh. TLS terminated automatically, WebSocket supported.

​
Create your first machine

ssh boxd.sh
If your key isn’t linked yet, you’ll see a URL — open it, sign in with GitHub, and your key is linked.Then create a machine:
ssh boxd.sh new --name=myapp

creating myapp...
name: myapp
  id: 9645b1e8-193d-4d11-86b1-f91deff5bbfb
 url: myapp.boxd.sh
boot: 1.3s
Connect via SSH: ssh myapp.boxd.sh

Or from your browser: https://myapp.boxd.sh
Your machine is running with its own HTTPS domain.

​
Make it live

nginx is pre-installed on port 8000 (the default proxy port). Start it: 
ssh boxd.sh exec myapp -- sudo systemctl start nginx
Visit https://myapp.boxd.sh — your machine is live on the internet.

​
What’s next

Machines

Create, configure, and manage VMs.

Fork

Branch an entire machine in seconds.

Proxies

Automatic and subdomain proxy routing.