Getting Started

Quickstart: first successful run in 10 minutes

Use this guided flow to install the CLI, authenticate through ReactorAI, and complete your first successful run without self-hosted setup.

Time: 10 minAudience: Developers and tech leads

Step 1: Install the CLI

Install the public CLI first. External developers should use the hosted platform and do not need to run self-hosted services.

Install Refactor CLI

python -m pip install --upgrade refactorai-cli
refactor --help

Step 2: Register on ReactorAI and authenticate

Create your account at reactorai.codes, generate a developer key in the dashboard, then authenticate your CLI session. The CLI defaults to the hosted Refactor API, so no platform URL override is needed for the standard cloud workflow.

Hosted auth with developer key

# Sign up and create a key at https://reactorai.codes
refactor login --key <your_developer_key>
refactor whoami

Step 3: Run your first review in a repository

Initialize Refactor in your repository and execute the public review/refactor commands. This creates your first run and associated artifacts.

Create first run via CLI

git clone https://github.com/<your-org>/<your-repo>.git
cd <your-repo>

refactor init
refactor review .
refactor code .
refactor status

Step 4: Review results in ReactorAI

Open https://reactorai.codes and sign in.
Open your project and inspect findings, patch groups, and gate status.
Approve/reject based on your team policy and release criteria.

Dashboard review flow

# In https://reactorai.codes dashboard:
# 1) Open your project
# 2) Inspect findings, patches, and gate status
# 3) Approve or reject based on your team policy

Next, continue with Install & Setup to standardize onboarding for every external developer.