Project configuration

How the revenexx CLI is configured — the credential resolution order, the .revenexx.yaml project file, the global prefs.json and tenant files written by login and tenants use, and the environment variables that drive non-interactive runs.

The CLI reads its settings from a few places: flags, environment variables, an optional per-project .revenexx.yaml, and the global files it writes itself. There is no revenexx.json project file and no init step. Knowing which source holds what makes the CLI predictable across a local workspace and a CI pipeline.

How credentials resolve

Any command that needs auth resolves three values — the API key, the endpoint, and the tenant — from the first source that has them. The order:

  1. CLI flag — --token, --endpoint, --tenant
  2. Environment variables — REVENEXX_API_KEY, REVENEXX_API_URL, REVENEXX_TENANT
  3. Project file — the nearest .revenexx.yaml, walking up from the current directory
  4. Global config — ~/.revenexx/prefs.json, written by revenexx login
  5. Built-in default — the endpoint defaults to https://api.revenexx.com

The tenant slug has its own order: --tenant, then ~/.revenexx/tenant (set by tenants use), then REVENEXX_TENANT, then .revenexx.yaml. See Authentication for the full picture.

Configuration files

FileScopeHolds
.revenexx.yamlProject (nearest, walking up)Endpoint, API key (token:), tenant, and the defaultMode for this workspace. You write this by hand; it's read during credential resolution.
~/.revenexx/prefs.jsonGlobal (per machine)Saved login session and endpoint, written by revenexx login.
~/.revenexx/tenantGlobal (per machine)The active tenant slug, written by revenexx tenants use.

A .revenexx.yaml lets you commit per-project context (endpoint and tenant) to a repo and keep the key in the environment. A minimal one:

.revenexx.yaml
apiUrl: https://api.revenexx.com
tenant: acme
# token: rvxk_...     # prefer REVENEXX_API_KEY in the environment for secrets
# defaultMode: tui    # tui (default) | guided | help — see Default mode below

You can also set the global defaults with the client command instead of editing files:

Shell
revenexx client --endpoint https://api.revenexx.com
revenexx client --key <API_KEY>
revenexx client --self-signed true

Environment variables

For CI and scripts, set credentials in the environment instead of files. These override the config files during credential resolution:

VariableSets
REVENEXX_API_KEYThe gateway API key (the token used to authenticate).
REVENEXX_API_URLThe API endpoint. Defaults to https://api.revenexx.com.
REVENEXX_TENANTThe tenant slug.
REVENEXX_SENSITIVE_TENANTSComma-separated list of tenant slugs always treated as production (same as revenexx client --sensitive-tenants).
REVENEXX_NO_TUISet to 1 (any value other than 0/false) to stop a bare revenexx from launching the full-screen app — see Default mode.

Default mode

On an interactive terminal, a bare revenexx — with no command and no --json or --help — launches the full-screen app (TUI) by default. Two settings change what that bare invocation does; explicit subcommands (repl, tui, any service command) always win regardless of either.

SourceValueEffect
REVENEXX_NO_TUI env var1 / any value other than 0/falseA bare revenexx falls back to the guided picker.
defaultMode: in .revenexx.yamltuiA bare revenexx launches the full-screen app (the default).
guidedA bare revenexx opens the guided command picker.
helpA bare revenexx prints usage and exits.

REVENEXX_NO_TUI takes precedence over the config file, and both apply only to an interactive terminal — a pipe, CI, --json, or --help always prints help and never opens an interactive surface.

.revenexx.yaml
defaultMode: guided

What's next

Was this page helpful?