Skip to content
unfault

Installation

Unfault can be installed as a CLI tool or as a VS Code extension. Choose the method that fits your workflow.

Quick Install

Section titled “Quick Install”

The fastest way to install the Unfault CLI:

Terminal window
curl -sSL https://unfault.dev/get | bash

This downloads the latest release from GitHub and installs it to your system.

Authentication

Section titled “Authentication”

  1. Authenticate with your Unfault account:

    Terminal window
    unfault login

    This will output the following:

     Initiating device authentication flow...
    

     Visit /auth/device and enter code: VZ8-VK3
     Waiting for authentication...

    Copy the code and visit https://app.unfault.dev/auth/device to complete the login.

  2. Verify your installation:

    Terminal window
    unfault status

    This should output the following:

     Unfault CLI Status
     ────────────────────────────────────────
    

     ✓ Configuration: Found
    

     ℹ API Endpoint: https://app.unfault.dev
     ✓ API Status: Healthy
    

     ℹ API Key: sk_live_abc1...**
     ✓ Authentication: Configured
    

     ✓ Ready to analyze code. Run `unfault review` to start.

Once complete, your credentials are stored in ~/.unfault/config.toml.

VS Code Extension

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

The extension will prompt you to sign in on first use.

Next Steps

Section titled “Next Steps”

Quick Start

Run your first scan and understand the output. Get started →