Add demos

Author: vikin91

.gitignore

@@ -27,3 +27,6 @@ go.work.sum
 *.tmp
 *.log
 
+# Demo GIFs (hosted on vhs.charm.sh)
+demo/*.gif
+

README.md

@@ -2,10 +2,16 @@
 
 A standalone Go binary that analyzes StackRox Sensor Prometheus metrics using declarative TOML rule files.
 
-![Made with VHS](https://vhs.charm.sh/vhs-33cWV6RkqrjaeabNAcxVmc.gif)
-
 <a href="https://vhs.charm.sh"><img src="https://stuff.charm.sh/vhs/badge.svg" alt="Made with VHS"></a>
 
+## 🎬 Demos
+
+### Interactive TUI Mode
+![TUI Demo](https://vhs.charm.sh/vhs-33cWV6RkqrjaeabNAcxVmc.gif)
+
+### CLI Mode (Console & Markdown)
+![CLI Demo](https://vhs.charm.sh/vhs-5slvsgOGnyRd7JsWNA7vMu.gif)
+
 ## ✨ Features
 
 - **🎮 Interactive TUI**: Beautiful terminal UI with keyboard navigation (powered by [Bubble Tea](https://github.com/charmbracelet/bubbletea))
@@ -116,17 +122,20 @@ go run testdata/compare_outputs.go /tmp/python-output.txt /tmp/go-report.md
 
 ## Recording Demos
 
-This project uses [VHS](https://github.com/charmbracelet/vhs) for recording terminal demos:
+This project uses [VHS](https://github.com/charmbracelet/vhs) for recording terminal demos.
+See the [`demo/`](demo/) folder for scripts and instructions.
 
 ```bash
 # Install VHS
 brew install vhs
 
-# Record the demo
-vhs demo.tape
+# Record demos
+cd demo
+vhs demo.tape       # Full TUI demo
+vhs demo-cli.tape   # CLI mode demo
 
-# Or record the short version
-vhs demo-short.tape
+# Publish to charm servers
+vhs publish demo.gif
 ```
 
 ## Dependencies

demo-short.gif

@@ -0,0 +1,32 @@
+# Demo Recordings
+
+This folder contains [VHS](https://github.com/charmbracelet/vhs) scripts for recording terminal demos.
+
+## Scripts
+
+| File | Description | Output |
+|------|-------------|--------|
+| `demo.tape` | Full TUI demo (~45s) | [View on Charm](https://vhs.charm.sh/vhs-33cWV6RkqrjaeabNAcxVmc.gif) |
+| `demo-cli.tape` | CLI mode demo (~40s) | [View on Charm](https://vhs.charm.sh/vhs-5slvsgOGnyRd7JsWNA7vMu.gif) |
+| `demo-short.tape` | Short TUI preview (~15s) | - |
+
+## Recording
+
+```bash
+# Install VHS
+brew install vhs
+
+# Record a demo (from project root)
+cd demo
+vhs demo.tape
+
+# Publish to Charm servers
+vhs publish demo.gif
+```
+
+## Notes
+
+- GIF files are gitignored (hosted on vhs.charm.sh instead)
+- Edit `.tape` files to modify the demos
+- See [VHS documentation](https://github.com/charmbracelet/vhs) for syntax
+

demo.gif

@@ -0,0 +1,106 @@
+# VHS Demo Script - CLI Mode (Console + Markdown)
+# Run with: vhs demo-cli.tape
+
+Output demo-cli.gif
+Set FontSize 15
+Set Width 1400
+Set Height 900
+Set Theme "Dracula"
+Set Padding 20
+Set Framerate 24
+Set PlaybackSpeed 0.7
+Set WindowBar Colorful
+Set BorderRadius 8
+
+# Title
+Type "# 📊 Sensor Metrics Analyzer - CLI Demo"
+Enter
+Sleep 1s
+Type "clear"
+Enter
+Sleep 300ms
+
+# Show help
+Type "# First, let's see the available options"
+Enter
+Sleep 800ms
+Type "./bin/metrics-analyzer analyze --help"
+Enter
+Sleep 4s
+
+Type "clear"
+Enter
+Sleep 300ms
+
+# Console output (default)
+Type "# 🖥️  Console Output (default mode)"
+Enter
+Sleep 800ms
+Type "./bin/metrics-analyzer analyze --rules ./automated-rules ../metrics.txt"
+Enter
+Sleep 5s
+
+Type "clear"
+Enter
+Sleep 300ms
+
+# Generate markdown report
+Type "# 📝 Generate Markdown Report"
+Enter
+Sleep 800ms
+Type "./bin/metrics-analyzer analyze --format markdown --rules ./automated-rules --output report.md ../metrics.txt"
+Enter
+Sleep 3s
+
+# Show the generated file
+Type "ls -la report.md"
+Enter
+Sleep 1.5s
+
+# Display with bat
+Type "# 👀 View the report with syntax highlighting"
+Enter
+Sleep 800ms
+Type "bat report.md"
+Enter
+Sleep 6s
+
+# Show just the summary section
+Type "clear"
+Enter
+Sleep 300ms
+Type "# 🔍 Quick peek at critical issues"
+Enter
+Sleep 800ms
+Type "bat report.md --line-range 1:50"
+Enter
+Sleep 5s
+
+# Validate rules
+Type "clear"
+Enter
+Sleep 300ms
+Type "# ✅ Validate rule files"
+Enter
+Sleep 800ms
+Type "./bin/metrics-analyzer validate ./automated-rules"
+Enter
+Sleep 2s
+
+# List rules
+Type "# 📋 List all available rules"
+Enter
+Sleep 800ms
+Type "./bin/metrics-analyzer list-rules ./automated-rules"
+Enter
+Sleep 4s
+
+# Cleanup
+Type "rm report.md"
+Enter
+Sleep 500ms
+
+Type "# ✨ That's the CLI mode!"
+Enter
+Sleep 2s
+