docs consolidation and others
This commit is contained in:
233
docs/modules/cli/guides/keyboard-shortcuts.md
Normal file
233
docs/modules/cli/guides/keyboard-shortcuts.md
Normal file
@@ -0,0 +1,233 @@
|
||||
# Keyboard Shortcuts Reference
|
||||
|
||||
**Sprint:** SPRINT_3600_0001_0001
|
||||
**Task:** TRI-MASTER-0010 - Document keyboard shortcuts in user guide
|
||||
|
||||
## Overview
|
||||
|
||||
StellaOps supports keyboard shortcuts for efficient triage and navigation. Shortcuts are available in the Web UI and CLI interactive modes.
|
||||
|
||||
## Triage View Shortcuts
|
||||
|
||||
### Navigation
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `j` / `↓` | Next finding | Finding list |
|
||||
| `k` / `↑` | Previous finding | Finding list |
|
||||
| `g g` | Go to first finding | Finding list |
|
||||
| `G` | Go to last finding | Finding list |
|
||||
| `Enter` | Open finding details | Finding list |
|
||||
| `Esc` | Close panel / Cancel | Any |
|
||||
|
||||
### Decision Actions
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `a` | Mark as Affected | Finding selected |
|
||||
| `n` | Mark as Not Affected | Finding selected |
|
||||
| `w` | Mark as Won't Fix | Finding selected |
|
||||
| `f` | Mark as False Positive | Finding selected |
|
||||
| `u` | Undo last decision | Any |
|
||||
| `Ctrl+z` | Undo | Any |
|
||||
|
||||
### Evidence & Context
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `e` | Toggle evidence panel | Finding selected |
|
||||
| `g` | Toggle graph view | Finding selected |
|
||||
| `c` | Show call stack | Finding selected |
|
||||
| `v` | Show VEX status | Finding selected |
|
||||
| `p` | Show provenance | Finding selected |
|
||||
| `d` | Show diff | Finding selected |
|
||||
|
||||
### Search & Filter
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `/` | Open search | Global |
|
||||
| `Ctrl+f` | Find in page | Global |
|
||||
| `Ctrl+k` | Quick filter | Global |
|
||||
| `x` | Clear filters | Filter active |
|
||||
|
||||
### View Controls
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `1` | Show all findings | View |
|
||||
| `2` | Show untriaged only | View |
|
||||
| `3` | Show affected only | View |
|
||||
| `4` | Show not affected | View |
|
||||
| `[` | Collapse all | List view |
|
||||
| `]` | Expand all | List view |
|
||||
| `Tab` | Next panel | Multi-panel |
|
||||
| `Shift+Tab` | Previous panel | Multi-panel |
|
||||
|
||||
### Bulk Actions
|
||||
|
||||
| Key | Action | Context |
|
||||
|-----|--------|---------|
|
||||
| `Space` | Toggle selection | Finding |
|
||||
| `Shift+j` | Select next | Selection mode |
|
||||
| `Shift+k` | Select previous | Selection mode |
|
||||
| `Ctrl+a` | Select all visible | Finding list |
|
||||
| `Shift+a` | Bulk: Affected | Selection |
|
||||
| `Shift+n` | Bulk: Not Affected | Selection |
|
||||
|
||||
## CLI Batch Mode Shortcuts
|
||||
|
||||
### Navigation
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `j` / `↓` | Next finding |
|
||||
| `k` / `↑` | Previous finding |
|
||||
| `Page Down` | Skip 10 forward |
|
||||
| `Page Up` | Skip 10 back |
|
||||
| `Home` | First finding |
|
||||
| `End` | Last finding |
|
||||
|
||||
### Decisions
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `a` | Affected |
|
||||
| `n` | Not affected |
|
||||
| `w` | Won't fix |
|
||||
| `f` | False positive |
|
||||
| `s` | Skip (no decision) |
|
||||
| `u` | Undo last |
|
||||
|
||||
### Information
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `e` | Show evidence |
|
||||
| `i` | Show full info |
|
||||
| `?` | Show help |
|
||||
|
||||
### Control
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `q` | Save and quit |
|
||||
| `Q` | Quit without saving |
|
||||
| `Ctrl+c` | Abort |
|
||||
|
||||
## Graph View Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `+` / `=` | Zoom in |
|
||||
| `-` | Zoom out |
|
||||
| `0` | Reset zoom |
|
||||
| `Arrow keys` | Pan view |
|
||||
| `f` | Fit to screen |
|
||||
| `h` | Highlight path to root |
|
||||
| `l` | Highlight dependents |
|
||||
| `Enter` | Select node |
|
||||
| `Esc` | Deselect |
|
||||
|
||||
## Dashboard Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `r` | Refresh data |
|
||||
| `t` | Toggle sidebar |
|
||||
| `m` | Open menu |
|
||||
| `s` | Open settings |
|
||||
| `?` | Show shortcuts |
|
||||
|
||||
## Scan View Shortcuts
|
||||
|
||||
| Key | Action |
|
||||
|-----|--------|
|
||||
| `j` / `k` | Navigate scans |
|
||||
| `Enter` | Open scan details |
|
||||
| `d` | Download report |
|
||||
| `c` | Compare scans |
|
||||
| `r` | Rescan |
|
||||
|
||||
## Configuration
|
||||
|
||||
### Enable/Disable Shortcuts
|
||||
|
||||
```yaml
|
||||
# ~/.stellaops/ui.yaml
|
||||
keyboard:
|
||||
enabled: true
|
||||
vim_mode: true # Use vim-style navigation
|
||||
|
||||
# Customize keys
|
||||
custom:
|
||||
next_finding: "j"
|
||||
prev_finding: "k"
|
||||
affected: "a"
|
||||
not_affected: "n"
|
||||
```
|
||||
|
||||
### CLI Configuration
|
||||
|
||||
```yaml
|
||||
# ~/.stellaops/cli.yaml
|
||||
interactive:
|
||||
keyboard_enabled: true
|
||||
confirm_quit: true
|
||||
auto_save: true
|
||||
```
|
||||
|
||||
### Web UI Settings
|
||||
|
||||
Access via **Settings → Keyboard Shortcuts**:
|
||||
|
||||
- Enable/disable shortcuts
|
||||
- Customize key bindings
|
||||
- Import/export configurations
|
||||
|
||||
## Accessibility
|
||||
|
||||
### Screen Reader Support
|
||||
|
||||
All keyboard shortcuts have equivalent menu actions:
|
||||
- Use `Alt` to access menu bar
|
||||
- Tab navigation for all controls
|
||||
- ARIA labels for all actions
|
||||
|
||||
### Motion Preferences
|
||||
|
||||
When `prefers-reduced-motion` is set:
|
||||
- Instant transitions replace animations
|
||||
- Focus indicators remain visible longer
|
||||
|
||||
## Quick Reference Card
|
||||
|
||||
```
|
||||
┌────────────────────────────────────────────┐
|
||||
│ STELLAOPS KEYBOARD SHORTCUTS │
|
||||
├────────────────────────────────────────────┤
|
||||
│ NAVIGATION │ DECISIONS │
|
||||
│ j/k Next/Prev │ a Affected │
|
||||
│ g g First │ n Not Affected │
|
||||
│ G Last │ w Won't Fix │
|
||||
│ Enter Open │ f False Positive │
|
||||
│ Esc Close │ u Undo │
|
||||
├─────────────────────┼──────────────────────┤
|
||||
│ EVIDENCE │ VIEW │
|
||||
│ e Evidence panel │ 1 All findings │
|
||||
│ g Graph view │ 2 Untriaged │
|
||||
│ c Call stack │ 3 Affected │
|
||||
│ v VEX status │ / Search │
|
||||
├─────────────────────┼──────────────────────┤
|
||||
│ BULK │ CONTROL │
|
||||
│ Space Select │ q Save & quit │
|
||||
│ Ctrl+a Select all │ ? Help │
|
||||
│ Shift+a Bulk affect │ Ctrl+z Undo │
|
||||
└─────────────────────┴──────────────────────┘
|
||||
```
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [Triage CLI Reference](./triage-cli.md)
|
||||
- [Web UI Guide](../UI_GUIDE.md)
|
||||
- [Accessibility Guide](../accessibility.md)
|
||||
Reference in New Issue
Block a user