Getting Started with Blackhole
From zero to a fully encrypted WireGuard mesh in under five minutes. Install the CLI, connect your first device, and invite a teammate — all with a single command.
Prerequisites
- macOS 12+, Linux kernel 5.6+, or Windows 10/11
- A Blackhole account (free tier works)
- Admin / sudo access on each device
Install & Connect
Install the Blackhole CLI
The one-liner installs the CLI and WireGuard kernel module. Run it on every machine you want to add to your mesh.
curl -fsSL https://blackhole.dev/install | shirm https://blackhole.dev/install.ps1 | iexhttps://blackhole.dev/install before running it.Log in and connect
Authenticate with your Blackhole account and bring the device online. The CLI opens a browser window for OAuth — no password is stored locally.
bh upAfter authentication completes, your device gets a stable 100.x.x.x address within your mesh. You can verify:
bh status
# Blackhole running
# Mesh IP: 100.64.0.1
# Peers: 0 connectedConnect a second device
Run bh up on your second machine — laptop, server, VPS, whatever. Both devices discover each other automatically. No port forwarding, no firewall rules.
# On device 1:
bh peers
# laptop 100.64.0.2 online 15ms
# Ping it:
bh ping laptop
# PING 100.64.0.2: 64 bytes, time=15msInvite a teammate
Generate a one-time invite link. Your teammate installs the CLI, opens the link, and their devices appear in your mesh automatically.
bh invite --email alice@example.com
# Invite link: https://app.blackhole.dev/join/abc123
# Expires: 48hOn the Team plan, invited users automatically receive ACL rules scoped to the member tag. Admins can tighten rules per user from the dashboard or via the API.