Skip to content

Commit 4e110cb

Browse files
author
Your Name
committed
docs(demo): ship readable vhs v2 with step-by-step pacing
1 parent 59edfaa commit 4e110cb

4 files changed

Lines changed: 35 additions & 11 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ go build ./cmd/secrethawk
2020

2121
## Demo
2222

23-
![SecretHawk vhs headless demo](docs/assets/demo-vhs.gif)
23+
![SecretHawk vhs headless demo](docs/assets/demo-vhs-v2.gif)
2424

2525
Regenerate demo GIF (headless flow with `vhs`):
2626

docs/assets/demo-vhs-v2.gif

2.14 MB
Loading

docs/assets/demo-vhs.gif

-192 KB
Binary file not shown.

docs/vhs/secrethawk-demo.tape

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,63 @@
1-
Output docs/assets/demo-vhs.gif
1+
Output docs/assets/demo-vhs-v2.gif
22
Set Shell "pwsh"
33
Set FontSize 18
44
Set Width 1200
55
Set Height 720
66
Set Theme "Catppuccin Mocha"
7-
Set TypingSpeed 0ms
7+
Set TypingSpeed 25ms
8+
9+
Type 'Write-Host "STEP 1/5 - Build CLI" -ForegroundColor Cyan'
10+
Enter
11+
Sleep 800ms
812

913
Type "go build ./cmd/secrethawk"
1014
Enter
11-
Sleep 200ms
15+
Sleep 1200ms
16+
17+
Type 'Write-Host "STEP 2/5 - Seed demo leak into file" -ForegroundColor Cyan'
18+
Enter
19+
Sleep 800ms
1220

1321
Type '$k="AKIA"+"A1B2C3D4E5F6G7H8"'
1422
Enter
15-
Sleep 200ms
23+
Sleep 600ms
1624

1725
Type 'Set-Content -Encoding utf8 docs/vhs/demo-src/app.py "AWS_ACCESS_KEY_ID = `"$k`""'
1826
Enter
19-
Sleep 200ms
27+
Sleep 600ms
2028

2129
Type 'Add-Content -Encoding utf8 docs/vhs/demo-src/app.py "SERVICE_URL = `"https://example.internal`""'
2230
Enter
23-
Sleep 200ms
31+
Sleep 1200ms
32+
33+
Type 'Write-Host "STEP 3/5 - Scan and detect secret" -ForegroundColor Cyan'
34+
Enter
35+
Sleep 800ms
2436

2537
Type "./secrethawk.exe scan docs/vhs/demo-src --format human"
2638
Enter
27-
Sleep 500ms
39+
Sleep 1800ms
40+
41+
Type 'Write-Host "STEP 4/5 - Export findings and run remediation dry-run" -ForegroundColor Cyan'
42+
Enter
43+
Sleep 800ms
2844

2945
Type "./secrethawk.exe scan docs/vhs/demo-src --format json --output docs/vhs/findings.json"
3046
Enter
31-
Sleep 300ms
47+
Sleep 1200ms
3248

3349
Type "./secrethawk.exe remediate --input docs/vhs/findings.json --auto --dry-run"
3450
Enter
35-
Sleep 300ms
51+
Sleep 1800ms
52+
53+
Type 'Write-Host "STEP 5/5 - Generate incident report" -ForegroundColor Cyan'
54+
Enter
55+
Sleep 800ms
3656

3757
Type "./secrethawk.exe report --input docs/vhs/findings.json --output docs/vhs/incident.md"
3858
Enter
39-
Sleep 500ms
59+
Sleep 2000ms
60+
61+
Type 'Write-Host "DONE - End-to-end flow complete" -ForegroundColor Green'
62+
Enter
63+
Sleep 1500ms

0 commit comments

Comments
 (0)