Prerequisites

What you need before starting with revenexx Revenue Cloud

This page lists what you need on your machine and in your accounts before you can follow the Quick Start.

The minimum is short: a revenexx account. That lets you sign in to Cockpit and look around, and it's all the CLI needs too — revenexx login opens your browser. It is also the one item with a lead time — during the soft launch an account is granted individually, so start section 2 before you need it. To deploy your first app you also need the CLI, which installs from public npm, Homebrew, or a prebuilt binary; no registry configuration and no token are needed to get it. An API key is needed the moment you call your deployed app from outside the platform — the Quick Start's last two steps do exactly that — and for CI. The rest of the list — Git, Docker, a particular editor — depends on what you're going to build, and you can add them later.

If you're in a hurry, read section 2 and skip the rest until you need them.

1. Node.js 22+ (Optional, for npm install)

If you install the CLI via npm, Node.js 22 or higher is required. The Quick Start also runs npm install and npm test inside the scaffolded app, which expect the same version.

Check your version

Bash
node --version
# v22.11.0

Install Node.js

  • macOS (Homebrew): brew install node@22
  • Linux (Ubuntu/Debian): sudo apt update && sudo apt install nodejs npm
  • Windows: Download from nodejs.org

Tip: You can skip this if you install the CLI with Homebrew (brew install revenexx-sdks/cli/revenexx) or download a binary from the release page — neither needs Node.js.

2. revenexx Account (Cockpit Access)

You need a revenexx account and access to Cockpit, the central admin interface.

How you get one depends on where we are in the launch

There are two ways in, and which one you meet is a platform setting rather than something about you. Start at console.revenexx.com/signup and the page tells you which applies — either a short form that creates your instance, or a reservation request.

During the soft launch, access is granted individually. The signup page asks you to reserve a place, and we unlock requests in batches and contact you. Expect hours to a few days, not minutes. Plan a first-app session around an instance you already have, not around signing up on the day.

Reserving a place. The form asks for your name, email, company, and what you plan to build. Submitting it creates no instance and no login — it puts you in the queue. You get a mail when your instance is unlocked, and you sign in from there.

When self-service is open, the same form provisions your instance while you wait:

  1. Go to console.revenexx.com/signup
  2. Fill in the form
  3. Confirm your email — you sign in through ID, our identity service
  4. Your Organization and first Tenant are provisioned. Budget about five minutes; the page shows progress per step

What your Tenant contains

Provisioning brings up the services your Tenant runs on: billing, identity, mail and messaging with a transactional template library, a domain, search, the event bus, analytics, media storage, and document generation. The progress panel names each step as it completes.

No apps are installed. A fresh Tenant is a working platform with an empty app list — installing the first one is your first task, not something you inherit. See Quick Start.

Verify access

Log in to app.revenexx.com. You should see:

  • Dashboard with your tenant name
  • Left sidebar with navigation to Apps, Integrations, Analytics
  • Top-right menu for Account, Settings, Logout

If a step failed during provisioning, the dashboard says so rather than looking empty — the pipeline is re-runnable, so contact support instead of signing up a second time.

3. API Key

You don't need a key to run the CLI at a terminal — revenexx login signs you in through your browser. You do need one to call your app on the public gateway, which is how the Quick Start verifies a deploy, and for automation that has no browser. Creating one takes a minute, so do it now rather than mid-walkthrough.

Create an API key

  1. Log in at app.revenexx.com
  2. Open your avatar menu (top right) and click Account
  3. In the settings sidebar, choose API-Keys (under Developer)
  4. Create a new key
  5. Choose:
    • Name: CLI Development (or any descriptive name)
    • Scope: Full access (for development) or granular scopes in production
  6. Click Create and copy the token immediately (not shown again)

Security: Treat this token like a password. Store it securely, rotate it regularly, and never commit it to git.

4. Git (Optional, for version control)

While not required, Git is recommended for version control and deploying apps.

Check if Git is installed

Bash
git --version
# git version 2.39.0

Install Git

  • macOS: brew install git
  • Linux: sudo apt install git
  • Windows: Download from git-scm.com

5. Text Editor or IDE (Optional)

Any text editor works, but these provide JSON Schema autocompletion for app files:

  • VS Code (recommended)
  • JetBrains IDE (IntelliJ, WebStorm, etc.) — JSON schema autocompletion built-in
  • Vim / Nano — Works, but no autocompletion

App files (manifest.json, schema.json, etc.) reference JSON schemas that enable IDE validation and autocompletion.

6. (Optional) Docker for Local Function Testing

To test cloud functions locally before deployment, Docker is helpful.

Check if Docker is installed

Bash
docker --version
# Docker version 20.10.21

Install Docker

  • macOS / Windows: Download Docker Desktop
  • Linux: sudo apt install docker.io

Checklist

Before moving on to Quick Start, verify:

  • ✓ Node.js 22+ installed (only if you install the CLI with npm)
  • ✓ revenexx account unlocked, Tenant provisioned, and logged into Cockpit
  • ✓ API key generated in Cockpit (the Quick Start's verify step needs it)
  • ✓ Git installed (optional but recommended)

Once everything is set up, you're ready to:

  1. Install the CLI
  2. Authenticate
  3. Create your first App

Let's go! → Quick Start

Was this page helpful?