CLI Documentation & Usage Guide

🛠️ Command Line Flags (open command)

--local <port> (Required)

Specifies the local port where your application is running (e.g. --local 3000 for React/Next.js or --local 8080 for Spring Boot).

--port <port> (Optional)

Requests a specific public port on the remote server. Defaults to port 80 for standard HTTP/HTTPS web traffic.

--name <subdomain> (Optional)

Requests a custom public subdomain (e.g. --name myapp creates myapp.cloudfireman.com). If omitted, a random secure hash is assigned.

--protocol <http|tcp> (Optional)

Defines the tunneling protocol. Use http for web applications and REST APIs, or tcp for raw socket services like Databases or SSH. Defaults to http.

--auth <user:pass> (Optional)

Enables HTTP Basic Authentication on your public endpoint. Visitors will be prompted for credentials before accessing your local server (e.g. --auth "admin:secret123").

--allow-ips <ip_list> (Optional)

Enables strict IP Whitelisting. Accepts comma-separated IP addresses or CIDR blocks. All other external IPs will be instantly blocked at the proxy layer (e.g. --allow-ips "192.168.1.50,10.0.0.0/8").

--api-key <key> (Optional)

Authenticates your CLI session with your CloudFireman account. If already saved in config.json, this flag is not required.

💡 Practical Usage Examples

1. Exposing a Local Web Application (React, Vue, Node.js)

fireman_client open --local 3000 --port 80 --name myapp

2. Password-Protected Staging Environment (Basic Auth)

fireman_client open --local 8080 --port 80 --name staging --auth "team:SuperSecret2026"

3. Exposing a Local Database with IP Whitelisting (PostgreSQL)

fireman_client open --local 5432 --port 9000 --protocol tcp --name mydb --allow-ips "192.168.1.50,10.0.0.0/8"

4. Viewing Live Account & Tunnel Statistics

fireman_client stats