Skip to main content

Quickstart

The Corellium CLI is a command line tool that allows you to manage your Corellium instances from the terminal. It can be used to create, delete, and manage instances, projects and more.

It is especially useful in CI/CD workflows. For example, see how to you can use the CLI in a GitHub Actions workflow.

To get started, install the Corellium CLI with:

npm install -g @corellium/corellium-cli

You can run the corellium command in your terminal to see the available commands.

> corellium
Usage: corellium [OPTIONS]

Commands:
  corellium login      Login and save authentication token to local profile
  corellium logout     Logout and remove local profile
  corellium signup     Create subscriber invite account
  corellium extension  Extension-related commands
  corellium instance   Instance-related commands
  corellium firmware   Firmware-related commands
  corellium image      Image-related commands
  corellium project    Project-related commands

Options:
  --help     Show help  [boolean]
  --version  Show version number  [boolean]

Run 'corellium --help' for more information on a command.