Interactive TUI
Redactyl includes a terminal user interface (TUI) for exploring and managing findings interactively.
Starting the TUI
Section titled “Starting the TUI”redactyl scan # TUI is the default modeKeyboard Shortcuts
Section titled “Keyboard Shortcuts”Navigation
Section titled “Navigation”| Key | Action |
|---|---|
j / ↓ | Move down |
k / ↑ | Move up |
g | Go to top |
G | Go to bottom |
Enter | Expand/collapse finding |
Tab | Switch panels |
Filtering
Section titled “Filtering”| Key | Action |
|---|---|
/ | Search findings |
f | Filter by severity |
F | Clear filters |
s | Sort findings |
Actions
Section titled “Actions”| Key | Action |
|---|---|
o | Open file in editor |
b | Baseline finding |
i | Ignore finding |
e | Export findings |
r | Refresh scan |
| Key | Action |
|---|---|
p | Toggle preview panel |
c | Toggle context lines |
d | Diff view |
? | Show help |
q | Quit |
Severity Colors
Section titled “Severity Colors”Findings are color-coded by severity:
- Critical - Red background
- High - Red text
- Medium - Yellow text
- Low - Gray text
Preview Panel
Section titled “Preview Panel”Press Enter on a finding to see:
- Full file path with line numbers
- Syntax-highlighted code context
- Secret value (partially redacted)
- Detector information
- Suggested remediation
Baseline Workflow
Section titled “Baseline Workflow”- Scan your project:
redactyl scan - Review findings in the TUI
- Press
bto baseline known/acceptable secrets - Baseline is saved to
.redactyl-baseline.json - Future scans will skip baselined findings
Export Options
Section titled “Export Options”Press e to export findings:
- JSON - Machine-readable format
- SARIF - GitHub Code Scanning format
- CSV - Spreadsheet format
- Markdown - Documentation format
Virtual File Extraction
Section titled “Virtual File Extraction”For secrets found in archives or containers:
- Select the finding
- Press
xto extract - File is extracted to a temp directory
- Opens in your default editor
Environment Variables
Section titled “Environment Variables”Customize TUI behavior:
# Set default editorexport EDITOR=code
# Disable colorsexport NO_COLOR=1
# Set terminal widthexport COLUMNS=120