@ripeseed/rs-tunnel
v0.4.0
Published
CLI for running secure public tunnels to localhost through Cloudflare.
Readme
@ripeseed/rs-tunnel
CLI for exposing your local HTTP service through a self-hosted rs-tunnel API and Cloudflare Tunnel.
Install
npm i -g @ripeseed/rs-tunnelQuick Start
# point CLI to your deployed API
export RS_TUNNEL_API_URL=https://api.your-domain.com
# authenticate
rs-tunnel login --email [email protected]
rs-tunnel login --email [email protected] --skip-browser-open
# expose local app on port 3000
rs-tunnel up --port 3000If no API URL is configured, the CLI prompts once and stores it in ~/.rs-tunnel/config.json.
Commands
rs-tunnel login --email <email> [--skip-browser-open] [--domain <api-url>]
rs-tunnel up --port <port> [--url <slug>] [--verbose] [--domain <api-url>]
rs-tunnel list [--domain <api-url>]
rs-tunnel stop <tunnel-id-or-hostname> [--domain <api-url>]
rs-tunnel logout [--domain <api-url>]
rs-tunnel doctor [--domain <api-url>]Configuration
RS_TUNNEL_API_URL: preferred API base URL override.RS_TUNNEL_API_BASE_URL: legacy alias (still supported).--domain: command-level API override; also persists for future commands.--skip-browser-open: skips automatically launching a browser, prints the Slack authorize URL, and keeps waiting for the API-side auth flow to complete.
Notes
- This package is only the CLI. The API must be running separately.
- Cloudflare credentials stay on the API side; the CLI only receives short-lived tunnel tokens.
Troubleshooting
- Run
rs-tunnel doctorto verify API reachability and local setup. - Run
rs-tunnel up --verboseto include rawcloudflaredlines.
Repository
- Monorepo: https://github.com/RipeSeed/rs-tunnel
- Full project docs: https://github.com/RipeSeed/rs-tunnel/blob/main/README.md
