Installation

The outray CLI connects a running local service to a public HTTP, TCP, or UDP endpoint. It does not start your application for you.

Install the CLI

Use a supported Node.js release and npm:

npm install -g outray
outray --version

The CLI package declares Node.js 16 or later, but authentication uses the built-in fetch API. Use Node.js 18 or later for the complete CLI workflow.

For a one-off session, you can run the package without a global installation:

npx outray --help

Authenticate and connect

Start your application in one terminal. In another, authenticate and forward its port:

outray login
outray 3000

Keep both processes running while the tunnel is in use. The CLI prints the public endpoint once the connection is ready.

Read Authentication for API tokens and organization selection, then Opening a tunnel for traffic inspection and multiple services.

Update or uninstall

npm install -g outray@latest

To remove the globally installed CLI:

npm uninstall -g outray

Uninstalling the package does not revoke API tokens or delete resources in your OutRay organization. Use outray logout to remove the CLI's saved local login.

Looking for an SDK?

The CLI is a tunnel client. To send application traces, logs, and metrics, install the Node.js SDK or a framework adapter. Observability does not require a tunnel.