Quickstart

Install, connect, and verify in 2 minutes.

1. Install the CLI

npm install -g shellroute

# or
brew install shellroute/tap/shellroute

Or download the binary from the releases page. Supports macOS and Linux.

Want to inspect first? The CLI source is on GitHub.

2. Log in

New accounts are created automatically on first login — no separate registration needed.

$ shellroute login
  Email: [email protected]
  Enter code sent to your email: 847291
  ✓ Logged in successfully

After login, shellroute enters interactive mode automatically. For CI/scripts, use SHELLROUTE_API_KEY env var or shellroute --api-key pk_... run ... with direct commands. Get your key with shellroute reveal-key.

3. Connect

Inside the interactive shell, use /connect:

● shellroute · not connected · direct traffic
~ ❯ /connect US
  Connecting to US (residential)...
  ✓ Connected to US (United States) — New IP: 203.0.113.42

● shellroute us · 203.0.113.42
~ ❯

All HTTP-aware tools in this shell now route through the US exit. Your other terminals and system processes are unaffected.

4. Verify

● shellroute us · 203.0.113.42
~ ❯ curl https://ipinfo.io/ip
203.0.113.42

~ ❯ /status
connected · US · residential · 203.0.113.42 · 0.8 MB · $0.002

5. Disconnect

● shellroute us · 203.0.113.42
~ ❯ /disconnect

  ✓ Disconnected.

  Session:
  Duration: 4m 12s
  Data used: 12.4 MB
  Cost: $0.04
  Balance: $9.93

● shellroute · not connected · direct traffic
~ ❯

/disconnect stops routing but keeps the shell open. /exit disconnects and quits. Press Ctrl+C twice to force exit.

One-shot commands

Don't need an interactive session? Run a single command through a proxy. This is how agents and automation use shellroute:

# Agent or script — route any command through a country exit
shellroute run US -- curl https://httpbin.org/ip
shellroute run DE -- python agent.py
shellroute run JP -- node worker.js
shellroute run --iptype datacenter FR -- npm run test

Next steps