Skip to content

Interactive Mode Walkthrough

Recording

When you run cis-hardening-tool without any subcommand, it launches the interactive menu — a rich, TUI-style interface powered by Rich and Questionary.

Launching Interactive Mode

sudo cis-hardening-tool

Note: The tool auto-escalates to root/admin unless you're running a read-only command (like --help, history, doctor).

The interactive menu dynamically adjusts based on the current state:

When Web Server is NOT running:

? What would you like to do?
❯ Start Web Server
  Manage Tools
  Run Quick Scan
  View Scan History
  Exit

When Web Server IS running:

? What would you like to do?
❯ Stop Web Server
  View Server Logs
  Manage Tools
  Run Quick Scan
  View Scan History
  Exit

Feature: Start Web Server

Launches the FastAPI web server on port 8000 in the background. Opens a full web dashboard for GUI-based operation.

Feature: Manage Tools

Opens a multi-select checkbox interface showing all tools:

? Select tools to install/ensure are ready:
  ☑ lynis (Missing)
  ☑ openscap (Missing)
  ☐ ciscat (Missing)
  ✗ hardeningkitty (Incompatible - Available on Windows)
  ✗ sct (Incompatible - Available on Windows)
  • Installed tools are unchecked by default
  • Missing tools are pre-checked for installation
  • Incompatible tools (wrong OS) are grayed out and disabled

Feature: Run Quick Scan

  1. Displays a checkbox selector of installed tools
  2. Runs each selected tool sequentially with real-time output
  3. Shows an output preview panel per tool
  4. Displays a summary table with pass/fail status
  5. Optionally generates an AI summary (if API key is configured)

Feature: View Scan History

Shows a table of all past scans with: - Scan ID - Status (Completed/Failed) - Duration - Tools used

Allows selecting a scan to view detailed findings.

  • Arrow keys: Navigate menu items
  • Enter: Select
  • Space: Toggle checkbox items
  • Ctrl+C (once): Prompts exit confirmation
  • Ctrl+C (double-tap): Force exit with cleanup

ASCII Banner

On startup and --version, the tool displays a branded ASCII art banner:

   ____ ___ ____            _   _            _ 
  / ___|_ _/ ___|  ___ _ __ | |_(_)_ __   ___| |
 | |    | |\___ \ / _ \ '_ \| __| | '_ \ / _ \ |
 | |___ | | ___) |  __/ | | | |_| | | | |  __/ |
  \____|___|____/ \___|_| |_|\__|_|_| |_|\___|_|

  CIS Hardening Sentinel v1.x.x