record-demo
GitHub使用 VHS 录制终端演示并生成 GIF。自动检查依赖、创建 .tape 文件、执行录制并打开结果目录,适用于 CLI 功能展示和文档制作。
Trigger Scenarios
Install
npx skills add slackapi/slack-cli --skill record-demo -g -y
SKILL.md
Frontmatter
{
"name": "record-demo",
"description": "Record terminal demos as GIFs using VHS tape files. Use when asked to record a demo, create a terminal recording, or generate a GIF of CLI usage.",
"argument-hint": "<description>"
}
Record a demo of $ARGUMENTS using VHS.
-
Check VHS is installed: Run
which vhs. If not found, tell the user to install it withbrew install vhs. -
Create a
.tapefile indemos/(create the directory if needed). Use this template:# Demo: <description> Output demos/<name>.gif # Always use .gif format Set Shell "zsh" Set FontSize 16 Set Width 1200 Set Height 600 Set Theme "Catppuccin Mocha" Set TypingSpeed 75ms Set Padding 20 Type "<command>" Sleep 500ms Enter Sleep 3s -
VHS Tape DSL reference: For the full command reference, see vhs-reference.md.
-
Tips for good demos:
- Add
Sleepafter commands to let output render and be readable - Use
Hide/Showto run setup commands invisibly - Keep demos short and focused (under 30 seconds)
- Add a
Sleep 3sat the end so viewers can see final output - Always add a
Sleep 500mspause after eachTypeline (beforeEnter) to mimic a human pause - For this project, use
./bin/slackdirectly as the CLI binary path (do NOT export PATH) - When demoing from an app directory, use
Hidetocdinto the app, then use../bin/slackas the binary path - Prefer passing app IDs directly (e.g.
--app A12345) to avoid interactive prompts when the ID is known
- Add
-
Run the recording: Execute
vhs <filename>.tapeto generate the output file. -
Review: Open the
demos/directory withopen demos/so the user can review the output.
Version History
- 2369f3e Current 2026-07-25 08:42


