Global commands reference

The command reference covers the service groups (products, orders, and so on). This page is the lookup for everything else: the global commands that manage the CLI itself, and the global options that work on every command. Each command has a narrative page with the why and the walkthroughs; this page holds the flags and the exit codes in one place.

Run revenexx <command> --help for the authoritative list on your installed version. This page was checked against CLI 0.5.0 (as of 2026-09). The tenants commands were rechecked on CLI 0.6.1 (as of 2026-10).

Global options

These work on every command, before or after the command name.

Output formats and field selection are covered in Scripting & output. How --endpoint, --token and --tenant rank against environment variables and files is in Configuration.

Exit codes

Failed API calls map to the exit codes in Scripting & output: 4 for authentication, 5 for not found, 8 for rate limited, 1 for everything else. A misspelled command or bad global flag exits 2.

Global commands do not all follow that scheme, and the gaps matter in a script:

An unknown flag or a missing argument on a subcommand (for example alias set -x foo) exits 1, not 2. The exit codes for watch are listed in its section below.

whoami

Show the active auth method, where the credential came from, the tenant, and the endpoint. It makes no network call.

revenexx whoami

No command-specific options. With no credential it prints No user is signed in and exits 0.

status

The same identity, tenant and endpoint as whoami, plus the token expiry and a gateway health probe. An SSO token that has expired is refreshed first, so the expiry shown is the session the next command will actually use.

revenexx status

No command-specific options. Same exit 0 when nobody is signed in.

tenants

Choose and inspect the tenant that commands run against. The saved choice lives in ~/.revenexx/tenant and beats REVENEXX_TENANT and every .revenexx.yaml — read the warning in Configuration before you rely on it. Sign-in is covered in Authentication.

revenexx tenants list
revenexx tenants use acme
revenexx tenants use
revenexx tenants current --check

• tenants list shows columns Tenant, Active, Sources and Access. Access is ok, the reason the gateway refused, or (not signed in) / (session expired).
• tenants use without a slug opens a picker when the CLI runs on a terminal, with the active tenant marked and preselected. In a script, or with --json, it never prompts: it prints the list of tenants, saves nothing and exits 1. (From CLI 0.6.1.)
• tenants use with a slug the gateway rejects as an invalid tenant prints Cannot switch and saves nothing; pass the global --force to save it anyway. In a script it prints the list of tenants and exits 1, or prints No tenants found and exits 1 when none are known. On a terminal it opens the picker instead, and picking a tenant switches to it and exits 0. Any other failed check (gateway unreachable, key rejected) or no credential at all only warns, and the slug is saved unchecked. The exit 1 and the picker are new in CLI 0.6.1; earlier versions exit 0.
• tenants use warns, when you run it, that the slug it saves overrides REVENEXX_TENANT or the tenant: in .revenexx.yaml. It still overrides them. See Project configuration.
• Under -q, use and current print the bare slug, which $(...) can capture. Under --json they print the rows Tenant and Active (current --check adds Access), but not as valid JSON, so jq can't parse them: use -q. (From CLI 0.6.1.)
• tenants current prints the slug as a status line, so capture it with -q, not by parsing the line. It reads only ~/.revenexx/tenant and REVENEXX_TENANT. It ignores --tenant and the tenant: in .revenexx.yaml, so it can print a different slug from the one your next command uses. To see the tenant a command really used, read the banner that API commands print, or run whoami.
• The only option specific to these commands is tenants current --check. When its check fails, current still exits 0. tenants list exits 0 on the failures described above.

alias

Manage your own short forms for commands. Built-in abbreviations are fixed and appear in alias list. How aliases resolve is in Aliases.

revenexx alias set deploy "apps create-deployment --activate true"
revenexx alias ls
revenexx alias rm deploy

• A name must be one word without spaces and not start with -. alias and help are reserved.
• A name that matches a real command is saved with a warning; the real command always wins, so the alias never resolves.
• Those errors, and removing a name that does not exist, exit 0. A missing argument exits 1.
• Aliases only resolve when the command name comes first; a global flag in front of it stops the rewrite.

repl

Open an interactive shell that stays signed in. See Interactive shell.

revenexx repl

No command-specific options. It needs an interactive terminal on both stdin and stdout, so it is for people, not CI. Without one it prints The REPL needs an interactive terminal and exits 0; in a script, call the command you want directly.

watch

Poll a get-by-id command until one field reaches a condition. The conditions, field paths and the app flow are in Background watchers.

watch add options:

watch rm takes --all to cancel every active watcher. --every below 2s and --for above one hour are raised or lowered to the limit, not rejected.

watch add needs an interactive terminal, so in a CI job it exits 2 at once; write your own loop around <get command> --json there. watch list and watch rm only see watchers of the current repl or tui session, so run on their own they find none.

Blocking watch add exits with:

update

Update the CLI to the latest release. It detects an npm or Homebrew install and runs the matching update; otherwise it asks which method to use.

revenexx update --dry-run
revenexx update

When you already run the latest version it says so and exits 0. If it cannot reach the release feed, it prints Failed to check for updates, and if the install step fails it prints the failure; both exit 0. revenexx --version reports the version and whether a newer one exists.

client

Set the API endpoint, key or TLS behavior stored by the CLI, or reset it.

revenexx client --sensitive-tenants "acme,globex"
revenexx client --self-signed false

Run with no options, client prints its help. To set up a new machine, use revenexx login or the environment variables in Configuration rather than client; that page explains why.

types and generate

For reference, the options they accept:

Use an SDK for typed calls, and see Type generation for the current state.

Commands documented elsewhere