Command line

Drive revenexx Revenue Cloud from your terminal. Install the CLI, sign in with a token, manage products and orders, register and deploy Apps, and generate types — interactively or in CI.

The revenexx CLI (@revenexx/cli) lets you work with Revenue Cloud from your terminal and your scripts. It talks to the same API gateway as the SDKs — https://api.revenexx.com — so anything you can do over the API, you can do from the command line.

Use it to read and change data (products, orders, customers, prices), to register and deploy a revenexx App, and to generate typed clients from your tenant's schema. It works interactively for day-to-day tasks — guiding you with a command picker, prompts, and search — and non-interactively for CI.

Three ways to use it

There's one command tree, reachable three ways — every service command, plugin command, and alias behaves identically in all of them.

Mode	How to start it	When
Full-screen app (TUI)	a bare `revenexx` on a terminal (the default), or `revenexx tui`	Browse and run commands interactively — the default landing experience.
Interactive shell (REPL)	`revenexx repl`	Fire several commands in a row without re-typing `revenexx`.
Direct / one-shot	`revenexx products list --json …`	Scripting, CI, and pipes — flag-driven and non-interactive.

Running revenexx with no arguments on an interactive terminal launches the full-screen app (TUI) — the default landing experience. A partial or named invocation (revenexx p, revenexx products) still opens the guided command picker and resolves to a single one-shot command. Anything non-interactive — a pipe, CI, --json, or --help — prints help and never opens an interactive surface, so scripts stay byte-for-byte identical to before.

Opting out of the TUI default: set REVENEXX_NO_TUI=1 (any value other than 0/false) to make a bare revenexx fall back to the guided picker, or set a defaultMode: key in .revenexx.yaml — tui (default), guided, or help. Explicit subcommands (repl, tui, any service command) always win regardless of this setting.

When to use the CLI

Quick reads and one-off changes — list orders, fetch a product, update a price without writing code.
Scripts and CI — automate setup, run the same command on every deploy, drive the platform from a pipeline. See non-interactive use.
Apps — register an App from its manifest and deploy new versions with the apps commands.
Type generation — produce typed helpers for your tenant's schema.

For application code, reach for an SDK instead — the Web/JS client or the PHP client. For exploring the API by hand, use the API Explorer. The CLI is the right tool when the work belongs in a terminal or a pipeline. The CLI SDK page is the SDK-catalog entry point for the same tool.

The command model

Every command follows one shape:

Shell

revenexx [GROUP] [COMMAND] [OPTIONS]

Global commands manage the CLI itself and your workspace: login, logout, whoami, client, tenants, alias, repl, tui, types, generate, update, about.
Service command groups mirror the API — one group per resource type (products, orders, customers, prices, storage, and more). Each group has a command for every endpoint it exposes.

Get help on anything by appending --help:

Shell

revenexx products --help
revenexx orders get --help

What's in this section

Installation — install via npm or Homebrew, or download a release binary, and verify.
Authentication — token-based login, credential resolution, and tenant selection.
Commands — the global commands and the service command model.
Interactive use — the command picker, prompts for missing options, resource search, and destructive-action confirmations.
Aliases — built-in abbreviations (p ls → products list) and your own git-style aliases.
Interactive shell (REPL) — run several commands in one authenticated session, with completion and a production safety banner.
Full-screen app (TUI) — the default landing experience: a bare revenexx (or revenexx tui) browses every command, fills parameters with a guided form, and reads results in a table.
Project configuration — .revenexx.yaml, env vars, and the global config files.
Type generation — generate typed clients with revenexx types and revenexx generate.
Non-interactive use — run the CLI in CI with tokens and environment variables.
Scripting & output — output formats, field selection, exit codes, and feeding request bodies from files or stdin.

Where to go next

Start with Installation, then sign in.

Was this page helpful?