DocumentationGetting StartedInstallation

Installation

Prerequisites

To use the Rollout CLI, ensure you have the following:

  • Node.js version 14 or above
  • NPM (Node Package Manager) or Yarn

Install the CLI

To install the Rollout CLI globally, run the following command in your terminal:

npm install -g rollout-cli

Verifying Installation

After installation, you can verify the CLI is correctly installed by running:

rollout --help

This should display a list of available commands.

Example output:

Usage: rollout <command> [options]

Commands:
  register     Register a new account
  login        Log in to your account
  deploy       Deploy the current directory
  apps         Manage your apps
  analytics    View app analytics
  domains      Manage custom domains
  ...

Options:
  --version    Show version number
  --help       Show help information

Initial Setup

  1. Authenticate Your Account: Start by logging in or registering for an account. See Authentication for details.

  2. Create Your First App: Use the apps:create command to create an app and associate it with a directory. See App Management for details.