Getting Started with Broch

Install the CLI and expose your local service to the internet in minutes.

Quick Install

Install Broch globally using npm:

npm install -g broch

Create your first tunnel:

broch share my-app --target http://localhost:3000

That's it! Your local service is now accessible at a public HTTPS URL.

Complete Documentation

Get the full setup guide, detailed CLI reference, deployment guides, and identity provider configuration in our documentation.

Read the Documentation →

Learn installation, CLI commands, deployment options, and more.

Prerequisites

Before you begin, make sure you have the following installed:

  • check_circle Node.js 20+ — download from nodejs.org
  • check_circle npm — included with Node.js
  • check_circle A web browser — for authentication

Need Help?

Check out the complete documentation for detailed guides, troubleshooting, and deployment instructions.

Questions? Email us at [email protected]