ui (Interactive Mode)
Launch the interactive terminal user interface for a guided experience.
oculum ui
Tip: Running oculum with no arguments also launches the UI.
Features
The interactive UI provides a menu-driven interface for all Oculum features:
Scan Wizard
Configure and run scans interactively:
- Select scan depth (cheap, validated, deep)
- Choose target directory
- Set output format
- View results in-terminal
History Browser
Browse and manage your scan history:
- View past scan results
- Export scans to different formats
- Delete individual scans
- Compare findings over time
Auth Management
Manage your authentication:
- Login with browser OAuth
- Login with API key
- View current status
- Logout
Usage Dashboard
Monitor your account:
- Current credit usage
- Recent scans
- Plan information
- Upgrade options
Help
Built-in documentation for quick reference:
- Scan depth comparison
- CI/CD setup guides
- Configuration help
- Troubleshooting
Navigation
| Key | Action |
|---|---|
↑ / k | Move up |
↓ / j | Move down |
Enter | Select item |
Escape / q | Go back / Exit menu |
Ctrl+C | Exit immediately |
Main Menu
When you launch the UI, you'll see:
┌─────────────────────────────────────────────┐
│ Oculum Security Scanner │
│ │
│ > Scan │
│ Watch │
│ History │
│ Account │
│ Help │
│ Quit │
│ │
│ user@example.com | Pro | 45/250 credits │
└─────────────────────────────────────────────┘
Scan Flow
The scan wizard walks you through:
1. Select Depth
Select scan depth:
> cheap Fast pattern matching
validated AI-validated (fewer false positives)
deep Full semantic analysis
2. Choose Directory
Select directory to scan:
> . (current directory)
src/
packages/
Custom path...
3. View Results
Results are displayed interactively with the ability to:
- Browse findings by severity
- View detailed information for each finding
- See remediation suggestions
- Export results
When to Use the UI
The interactive UI is best for:
- Learning Oculum - Guided menus help you discover features
- Manual security reviews - Browse findings interactively
- Quick one-off scans - No need to remember CLI flags
- Account management - Easy login/logout and usage checks
For automation, CI/CD, or scripting, use the direct CLI commands instead:
# These are better for automation
oculum scan --depth validated -f json
oculum scan --fail-on high --quiet
Terminal Requirements
The UI works best in terminals that support:
- 256 colors - For severity highlighting
- Unicode - For box-drawing characters
- Minimum 80x24 - Standard terminal size
Most modern terminals (iTerm2, Windows Terminal, VS Code terminal, etc.) work perfectly.