CLI Reference and Use Cases

Command Reference

broch share

Create a tunnel to a local service.

Syntax:

broch share <name> [--target <url>]

Options:

• <name> — Name for this tunnel (used in your URL)
• --target <url> — Target service URL (default: http://localhost:80)

Examples:

broch share my-app
broch share my-app --target http://localhost:3000
broch share my-app --target https://myapp.local:8443

broch status

View the status of your setup, including server health, authentication status, and tunnel URL format.

broch status

broch user slug

Set or change your personal slug — the memorable part of your tunnel URLs.

Syntax:

broch user slug <slug>

Example:

broch user slug myname

After setting your slug, tunnel URLs follow the format: {name}-myname.trial.broch.io

broch config

View and manage your local configuration.

Subcommands:

broch config show

View your current configuration:

broch config show

broch config set

Change a configuration value:

broch config set --request-log false
broch config set --server https://broch.yourcompany.com

broch auth

Manage authentication.

Subcommands:

broch auth login

Authenticate with the Broch server:

broch auth login

Your browser will open for sign-in.

broch auth logout

Log out and remove stored credentials:

broch auth logout

broch -i (Interactive Mode)

Launch Broch in interactive mode for a persistent session with tab completion.

broch -i

Interactive commands:

• sessions — List all active sessions
• close <name> — Close a specific tunnel by name
• close --all — Close all tunnels
• replay <name> — Replay HTTP requests from a tunnel
• help — Show available commands

broch feedback

Send feedback directly to the Broch team (requires authentication):

broch feedback "Your message here"

broch --version

Check the installed version:

broch --version

Configuration Options

Common configuration keys you can set with broch config set:

Key	Description	Default
--request-log	Enable/disable HTTP request logging	true
--server	Broch server URL	https://trial.broch.io

More Help

Get help on any command:

broch --help
broch share --help
broch config --help