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 and a personal access token. That alone lets you log in to Cockpit and look around. To deploy your first function via the CLI you also need Node.js 18+ and an ~/.npmrc configured for GitHub Packages (because the CLI is published there, not to public npm). 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, jump to sections 2 and 4 and skip the rest until you need them.

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

If you install the CLI via npm, Node.js 18 or higher is required.

Check your version

Bash
node --version
# v18.19.0

Install Node.js

  • macOS (Homebrew): brew install node@18
  • 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. GitHub Personal Access Token

The revenexx CLI is published to GitHub Packages, which requires authentication. You need a GitHub token with read:packages scope.

Create a GitHub token

  1. Go to github.com/settings/tokens
  2. Click Generate new token → Personal access tokens (classic)
  3. Set scopes:
    • ✓ read:packages
    • ✓ repo (optional, if you use git-based deployments)
  4. Click Generate and copy the token
  5. Store securely — treat this like a password

Configure npm (for CLI installation)

Create or update ~/.npmrc (in your home directory):

text
@revenexx:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN

Replace YOUR_GITHUB_TOKEN with the token you copied.

Alternatively, run:

Bash
npm login --scope=@revenexx --registry=https://npm.pkg.github.com
# Enter username: (your GitHub username)
# Enter password: (paste your GitHub token)
# Email: (your GitHub email)

This stores the token in ~/.npmrc automatically.

3. revenexx Account (Cockpit Access)

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

Sign up

  1. Go to app.revenexx.com
  2. Click Sign up
  3. Enter your email and password (you sign in through ID)
  4. Verify your email
  5. You're automatically provisioned a Tenant with default apps

Verify access

Once signed up, 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

4. Personal Access Token (for CLI login)

Once you have a revenexx account, generate a CLI token in Cockpit.

Create a CLI token

  1. Log in at app.revenexx.com
  2. Click Account (top-right menu)
  3. Navigate to Tokens → API Tokens
  4. Click Create Token
  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.

5. 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

6. Text Editor or IDE (Optional)

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

  • VS Code (recommended) — Install Revenexx extension (coming soon)
  • 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.

7. (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 18+ installed (or prebuilt binary method chosen)
  • ✓ GitHub token created with read:packages scope
  • ✓ npm configured with GitHub Packages (or prebuilt binary method chosen)
  • ✓ revenexx account created and logged into Cockpit
  • ✓ CLI token generated in Cockpit
  • ✓ 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?