CLI

Drive the revenexx platform from your terminal — sign in, select a tenant, and script the API from the command line.

The revenexx CLI is a command-line tool for working with the platform from your terminal and scripts. It signs in once, then talks to the API on your behalf, so you can automate tasks instead of clicking through a UI. The command is revenexx.

Status: first version.

Install

The CLI is distributed three ways: as an npm package, as a Homebrew formula, and as prebuilt binaries.

npm
npm install -g @revenexx/cli
Homebrew
brew install revenexx-sdks/cli/revenexx

If you use neither npm nor Homebrew, download the binary for your platform from the latest release and put it on your PATH. See Installation for the full instructions.

Verify the install:

Verify
revenexx -v

Sign in

Authenticate before running any command. The CLI prompts for your credentials and the API endpoint.

Sign in
revenexx login

Point it at the API gateway, https://api.revenexx.com, when prompted for the endpoint. Your sign-in is the same identity you use everywhere else, issued through ID.

Select a tenant

There's no project file or init step. The CLI gets its context from your login session, environment variables, and the active tenant. Sign in with a token and tenant:

Sign in
revenexx login --token <your-token> --tenant <your-tenant-slug>

Switch the active tenant any time:

Select tenant
revenexx tenants use <your-tenant-slug>

From there you can drive the platform from scripts and CI. See Authentication for the full credential-resolution order.

Auth

The CLI uses the same auth contract as the SDKs. revenexx login obtains a user token from ID and sends it as Authorization: Bearer <token>. For unattended use — CI, cron, automation — use a machine-to-machine API key (X-Revenexx-Api-Key) created in the customer console instead of an interactive login. Every request is scoped to your tenant by its slug (X-Revenexx-Tenant), set by --tenant, revenexx tenants use, or the REVENEXX_TENANT environment variable.

When to reach for the CLI

Use the CLI for one-off operational tasks, scripting, and CI steps where a full SDK integration would be overkill. For application code, use a typed client — @revenexx/sdk for JavaScript, @revenexx/node for Node, or revenexx/sdk for PHP.

Where to go next

Was this page helpful?