Full reference

Expose a local service with a tunnel

Connect a local development port to a configured public tunnel service. Verify the destination and access controls before sharing its URL.

Updated

Reviewed against Console v0.2.2. Available actions depend on project access and runtime configuration; check your installed CLI version for command differences.

Check the prerequisites

The CLI uses a configured frps service and a local tunnel process. You need the service’s control host, port, domain and token. Ask the service operator for these values; the CLI does not provision the server.

Configure the tunnel service

stimulir tunnel configure stores the connection settings for the active environment. Its required token is sensitive. Run configuration in a private terminal and avoid recording it in shared shell history or transcripts. The catalogue below lists the exact required options.

Expose one local port

bash
stimulir tunnel start --port 3000 --label app-preview

Confirm that port 3000 is the intended application and that the reported public URL reaches it. Add application authentication before exposing private functionality.

Inspect tracked tunnels

bash
stimulir tunnel list

Tracked tunnels can be running or stale. Check the local process and the target service if a URL stops responding.

Close the tunnel

bash
stimulir tunnel stop app-preview

Verify that the public URL no longer reaches the service. Stopping a tunnel does not stop the application listening on the local port.

Keep the local executor available

The tunnel process runs on the machine whose port is exposed. A browser-only Console session cannot expose a port on your laptop by itself. Keep that machine and process available for the intended session, then close the tunnel.

Command catalogue

Expand a command for its arguments. These commands follow the released CLI source; check stimulir --version and the command’s --help for your installation. Required flags are marked; some operations also validate combinations of inputs.

stimulir tunnel configure

Persist frps connection settings for tunnel start (once per environment).

--control-host required
frps control host (tunnel_control CNAME for this environment).
--control-port
frps control port.
--domain required
Tunnel wildcard domain, e.g. tunnel.stimulir.com.
--token required
frps auth.token for this environment (from Secrets Manager).
stimulir tunnel list

List tracked tunnels (running or stale).

No command-specific arguments.

stimulir tunnel start

Start a public HTTPS tunnel to a local port via our self-hosted frps.

--port, -p required
Local port to expose.
--label, -l required
Name for this tunnel (used by stop/list, and as the subdomain).
stimulir tunnel stop

Stop a running tunnel.

label required
Positional argument. Tunnel label to stop.