VS Code Extension
The Unfault VS Code extension VS Code extension provides real-time feedback as you write code.
Installation
Section titled “Installation”- Open VS Code
- Press
Cmd+Shift+X(macOS) orCtrl+Shift+X(Windows/Linux) - Search for “Unfault”
- Click Install
Authentication
Section titled “Authentication”On first use, the extension prompts you to sign in. Click the Unfault icon in the status bar, then “Sign In”.
Features
Section titled “Features”Real-time Diagnostics
Section titled “Real-time Diagnostics”As you edit code, Unfault highlights issues inline with squiggly underlines:
- Red - Critical issues that will likely cause production problems
- Yellow - Warnings worth addressing
- Blue - Informational suggestions
Hover over any highlight to see the full explanation.
Quick Fixes
Section titled “Quick Fixes”When Unfault detects an issue, click the lightbulb icon or press Cmd+. to see available fixes.
Select a fix to apply it immediately, or choose “Show Details” to learn more.
Problems Panel
Section titled “Problems Panel”All findings appear in VS Code’s Problems panel (View > Problems).
Click any entry to jump to the relevant code location.
Scan on Save
Section titled “Scan on Save”By default, Unfault scans your file every time you save. You can change this in settings.
Configuration
Section titled “Configuration”Open Settings (Cmd+,) and search for “Unfault”:
| Setting | Description | Default |
|---|---|---|
unfault.scanOnSave | Scan files when saved | true |
unfault.scanOnOpen | Scan files when opened | true |
unfault.showInlineHints | Show inline hints | true |
unfault.profiles | Active profiles | ["all"] |
unfault.severity | Minimum severity to show | warning |
Workspace Configuration
Section titled “Workspace Configuration”Configure Unfault in your project’s manifest file (pyproject.toml, Cargo.toml, package.json) or use a standalone unfault.toml. See the Configuration Reference for details.
Commands
Section titled “Commands”Access commands via Command Palette (Cmd+Shift+P):
| Command | Description |
|---|---|
| Unfault: Scan Current File | Run analysis on active file |
| Unfault: Scan Workspace | Analyze entire workspace |
| Unfault: Apply All Fixes | Apply all available fixes |
| Unfault: Show Rule Details | View documentation for selected issue |
| Unfault: Sign In | Authenticate with Unfault |
| Unfault: Sign Out | Remove credentials |
Status Bar
Section titled “Status Bar”The status bar shows:
- Unfault icon - Click to run a scan
- Issue count - Number of issues in current file
- Auth status - Connection state
Keyboard Shortcuts
Section titled “Keyboard Shortcuts”| Shortcut | Action |
|---|---|
Cmd+Shift+U | Scan current file |
Cmd+. | Show quick fixes |
F8 | Go to next problem |
Shift+F8 | Go to previous problem |
Troubleshooting
Section titled “Troubleshooting”Extension not loading
Section titled “Extension not loading”- Check that you have a valid subscription
- Run “Unfault: Sign In” from Command Palette
- Check Output panel for error messages
Scans are slow
Section titled “Scans are slow”The extension analyzes files on save. For large projects, consider:
- Closing files you’re not actively editing
- Using VS Code’s built-in file exclusions in Settings → Files: Exclude
Issues not matching CLI
Section titled “Issues not matching CLI”Ensure VS Code and CLI are using the same configuration file.