Skip to main content

Package Managers

Install rs-tunnel globally using your preferred package manager:
npm install -g @ripeseed/rs-tunnel

System Requirements

Node.js 20+

Required for running the CLI

Supported Platforms

macOS, Linux, Windows
The CLI will automatically download and install cloudflared on first tunnel creation if not already present.

Verify Installation

After installation, verify that rs-tunnel is available:
rs-tunnel --version
This should output the installed version number:
0.1.2

Configuration Directory

On first run, rs-tunnel creates a configuration directory at ~/.rs-tunnel/ to store:
  • Session credentials (encrypted)
  • API domain configuration
  • Downloaded binaries (cloudflared)
The configuration directory is created with secure permissions (0700) and credentials are encrypted at rest.

Next Steps

Authentication

Log in with Slack OAuth

Create Your First Tunnel

Start exposing local services

Build docs developers (and LLMs) love