Skip to content

Installation

Unfault requires a free account to use.

Why an account?

  • Analysis history. Your review results are stored so you can reference them later.
  • Cross-device access. Run reviews from your laptop, CI, or anywhere else with the same account.
  • Graph persistence. The code graph enables features like impact analysis and the ask command.

What does it cost?

Nothing right now. We’re gathering feedback and improving the product. No credit card required.

Create your free account

Once you have an account, continue with the installation below.

The fastest way to install the Unfault CLI:

Terminal window
mkdir -p ~/.local/bin
curl -L -o ~/.local/bin/unfault https://github.com/unfault/cli/releases/latest/download/unfault-aarch64-apple-darwin
chmod +x ~/.local/bin/unfault

This downloads the latest release from GitHub. Put the unfault binary somewhere on your PATH (for example ~/.local/bin).

Connect the CLI to your account:

  1. Run the login command:

    Terminal window
    unfault login

    You’ll see output like this:

    Initiating device authentication flow...
    Visit /auth/device and enter code: VZ8-VK3
    Waiting for authentication...
  2. Open app.unfault.dev/auth/device in your browser and enter the code.

  3. Verify everything is working:

    Terminal window
    unfault status

    You should see:

    Unfault CLI Status
    ────────────────────────────────────────
    ✓ Configuration: Found
    ℹ API Endpoint: https://app.unfault.dev
    ✓ API Status: Healthy
    ℹ API Key: sk_live_abc1...**
    ✓ Authentication: Configured
    🧩 Addons
    ✗ fault: missing
    → Run `unfault addon install fault`
    ✓ Ready to analyze code. Run `unfault review` to start.

Your credentials are stored in ~/.unfault/config.toml.

If you prefer working in your editor:

  1. Open VS Code
  2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)
  3. Search for “Unfault”
  4. Click Install

The extension uses the same credentials as the CLI. If you’re not authenticated yet, run unfault login (or set UNFAULT_API_KEY) and then reload VS Code.

If you want to run fault injection and generate scenario files from Unfault, install the fault CLI:

Terminal window
unfault addon install fault

Quick Start

Run your first review and understand the output. Get started

How It Works

Understand what happens when you run a review. Learn more