Quick Start
Run your first review and understand the output. Get started
Unfault requires a free account to use.
Why an account?
ask command.What does it cost?
Nothing right now. We’re gathering feedback and improving the product. No credit card required.
Create your free accountOnce you have an account, continue with the installation below.
The fastest way to install the Unfault CLI:
mkdir -p ~/.local/bincurl -L -o ~/.local/bin/unfault https://github.com/unfault/cli/releases/latest/download/unfault-aarch64-apple-darwinchmod +x ~/.local/bin/unfaultmkdir -p ~/.local/bincurl -L -o ~/.local/bin/unfault https://github.com/unfault/cli/releases/latest/download/unfault-x86_64-apple-darwinchmod +x ~/.local/bin/unfaultmkdir -p ~/.local/bincurl -L -o ~/.local/bin/unfault https://github.com/unfault/cli/releases/latest/download/unfault-x86_64-unknown-linux-gnuchmod +x ~/.local/bin/unfaultmkdir -p ~/.local/bincurl -L -o ~/.local/bin/unfault https://github.com/unfault/cli/releases/latest/download/unfault-aarch64-unknown-linux-gnuchmod +x ~/.local/bin/unfault$dest = "$env:USERPROFILE\\bin\\unfault.exe"New-Item -ItemType Directory -Force (Split-Path $dest) | Out-NullInvoke-WebRequest -Uri "https://github.com/unfault/cli/releases/latest/download/unfault-x86_64-pc-windows-msvc.exe" -OutFile $destThis downloads the latest release from GitHub. Put the unfault binary somewhere on your PATH (for example ~/.local/bin).
Connect the CLI to your account:
Run the login command:
unfault loginYou’ll see output like this:
Initiating device authentication flow...
Visit /auth/device and enter code: VZ8-VK3Waiting for authentication...Open app.unfault.dev/auth/device in your browser and enter the code.
Verify everything is working:
unfault statusYou 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:
Cmd+Shift+X / Ctrl+Shift+X)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:
unfault addon install faultQuick Start
Run your first review and understand the output. Get started
How It Works
Understand what happens when you run a review. Learn more