Non-interactive use

Run the revenexx CLI in CI and scripts — authenticate with a token, pass the tenant and endpoint through flags or environment variables, and avoid interactive prompts.

The CLI runs headless, without prompts or a saved session, so you can use it in a continuous integration pipeline or any script. You supply the token, tenant, and endpoint up front, and the CLI never has to ask. This is the counterpart to interactive use: the same commands, with every value passed as a flag instead of prompted for.

Authenticate with a token

In a pipeline, sign in by passing the token and tenant directly:

Shell
revenexx login --token <token> --tenant <slug>

The token is a gateway API key, created in the customer console. Give it the permissions the commands you run will need.

Or use environment variables

Instead of flags, set the credentials in the environment. The CLI picks them up automatically for every command:

Shell
export REVENEXX_API_KEY=<token>
export REVENEXX_TENANT=<slug>
export REVENEXX_API_URL=https://api.revenexx.com

revenexx products list --json

Environment variables take precedence over config files. For the full precedence rules, see credential resolution.

Skip prompts

Commands that would otherwise ask for confirmation accept --force to proceed without prompting. Use it, for example, when switching tenants from a pipeline without gateway validation:

Shell
revenexx tenants use acme --force

Machine-readable output

For output you can parse, add --json:

Shell
revenexx orders list --json

The CLI also renders JSON Lines, CSV, YAML, and Markdown, projects fields with --fields, exits with a meaningful code on failure, and reads request bodies from a file or stdin. See Scripting & output for the full automation surface.

Example: GitHub Actions

Store the token as a repository secret, then run the CLI in a step:

.github/workflows/deploy.yml
- name: Deploy App
  env:
    REVENEXX_API_KEY: ${{ secrets.REVENEXX_API_KEY }}
    REVENEXX_TENANT: acme
    REVENEXX_API_URL: https://api.revenexx.com
  run: |
    npm install -g @revenexx/cli
    revenexx apps register --manifest manifest.json
    revenexx apps create-deployment --function-id locations --activate true --code .

What's next

Was this page helpful?