Commands
Every command follows one shape:
revenexx [GROUP] [COMMAND] [OPTIONS]
Get help on any command, group, or the CLI itself by appending --help:
revenexx --help
revenexx products --help
revenexx orders get --help
Global commands
These manage the CLI and your workspace.
| Command | What it does |
|---|---|
login | Sign in with a token and validate it against the gateway. See Authentication. |
logout | Remove a saved session. |
whoami | Show the active auth method, tenant, and endpoint. |
register | Print the URL where you create an account. |
client | Configure the CLI: endpoint, API key, and TLS behavior (see below). |
tenants | Select and inspect the active tenant (use, current, list). |
tui | Launch the full-screen app — also what a bare revenexx opens on a terminal by default. |
repl | Open the interactive shell to run several commands in one session. |
types | Generate type definitions from your tenant's schema. See Type generation. |
generate | Generate a typed SDK tailored to your tenant. See Type generation. |
update | Update the CLI to the latest version. |
about | Print version and endpoint information. |
The CLI has no project file and no init/push commands. Configuration lives in your login session, environment variables, and an optional .revenexx.yaml — see Configuration.
Configure the CLI with client
Set the endpoint, key, or TLS behavior without re-running login:
revenexx client --endpoint https://api.revenexx.com
revenexx client --key <API_KEY>
revenexx client --self-signed true
revenexx client --sensitive-tenants "acme,globex"
--self-signed true lets the CLI trust a self-signed certificate. By default, requests to hosts with self-signed (or missing) certificates are rejected.
--sensitive-tenants accepts a comma-separated list of tenant slugs that the CLI treats as production regardless of endpoint. Once set, those tenants always show the prominent PRODUCTION safety banner.
Register and deploy Apps
To scaffold and ship an App in one command each, use revenexx create app and revenexx deploy app — see Scaffolding. The apps endpoint commands below give you finer-grained control over registration and deployments.
The apps group has two friendly shortcuts on top of the raw endpoint commands.
Register an App from its manifest.json:
revenexx apps register --manifest manifest.json
List the Apps in the active tenant:
revenexx apps list
To ship code, create a deployment and then activate it. Upload a code package and activate it in one step:
revenexx apps create-deployment --function-id locations --activate true --code .
Or deploy from a connected Git repository:
revenexx apps create-vcs-deployment --function-id locations --type branch --reference main --activate true
Inspect and switch deployments:
revenexx apps list-deployments --function-id locations
revenexx apps get-deployment --function-id locations --deployment-id <DEPLOYMENT_ID>
revenexx apps update-deployment --function-id locations --deployment-id <DEPLOYMENT_ID>
The exact flags vary per command — run revenexx apps <command> --help for the authoritative list.
Service command groups
The CLI mirrors the API: there's a command group per resource type, and a command for every endpoint that group exposes. Groups include:
apps, sites, storage, products, orders, customers, carts, payments, prices, categories, attributes, families, channels, markets, inventories, shipping, tokens, pages, settings, and more.
Within a group, each command is the endpoint's action with the redundant group prefix dropped — for example list, get, create-deployment, invoked as revenexx products list or revenexx orders get. Where the endpoint name repeats the group, only the leading prefix is removed, so a few commands keep the rest (revenexx pages pages-list, revenexx search search-documents). List a group's commands with revenexx <group> --help.
Examples
List products. --limit, --offset, and --order page and sort the results:
revenexx products list --limit 50 --order created_at.desc
Fetch one order by id:
revenexx orders get --id <ORDER_ID>
Output is a table by default. Most commands also accept --json for machine-readable output, which is what you want in scripts:
revenexx products list --json
Commands from plugins
Some command groups aren't generated from the API — they come from CLI plugins bundled at build time, so they're present depending on how your CLI was built and published. The public ones are documented here:
- Skills — browse and install AI agent skills from the Skill Registry (
skills list,skills show,skills add). - Scaffolding — scaffold and deploy apps and themes (
create,deploy, plus theapps generate/apps capabilitiescodegen). about— print how the CLI was generated.
What's next
- Generate types for your tenant's schema.
- Run the CLI in CI.