Add VHS demo tape files for terminal GIF recordings#242
Merged
Conversation
Add docs/vhs/ with a flagship overview tape (mcpc-demo.tape) plus six focused per-feature tapes (quickstart, tools, shell, scripting, grep, proxy) and a README explaining how to render them with VHS. The flagship tape replays the Quickstart from the main README and produces the GIF embedded at docs/images/mcpc-demo.gif. All tapes share the same Set block for visual consistency.
The v0.3.0 release commit (cfd3add) blanked out the <!-- AUTO-GENERATED: mcpc --help --> code block in README.md but did not regenerate it, causing test/unit/cli/readme-help.test.ts to fail on every branch built from that commit (Node.js 20/22/24 CI jobs). Repopulate the block from the current `mcpc --help` output, restoring parity with the test's expectation. Equivalent to running `pnpm run build:readme` (sans TOC + link check, which require globally installed tooling). Refs #242
Resolves a README.md conflict from #243 (shell command deprecation) by adopting main's help block — the `shell <@session>` row is gone from `mcpc --help`. Also removes docs/vhs/shell.tape and its references from docs/vhs/README.md and docs/vhs/mcpc-demo.tape so the templates don't showcase a now-deprecated command. Refs #242, #243
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add a collection of VHS tape files for recording terminal demo GIFs of mcpc. These tapes automate the creation of high-quality demo videos showing mcpc's key features and workflows.
Changes
docs/vhs/README.md— Comprehensive guide to the VHS demo system, including prerequisites, tape descriptions, recording instructions, customization tips, and best practicesdocs/vhs/mcpc-demo.tape— Flagship overview demo covering the full user journey: discovery → connection → tool listing → grep search → tool inspection → tool invocation → JSON mode → session closuredocs/vhs/quickstart.tape— Minimal "connect → list → call" flow optimized for README hero GIFdocs/vhs/tools.tape— Focused demo of tool discovery and invocation (tools-list,tools-get,tools-call, JSON stdin)docs/vhs/shell.tape— Interactive REPL session (mcpc @session shell) with help, listing, grep, and tool callsdocs/vhs/scripting.tape— JSON mode integration withjqandxargsfor scripting and CI/contract testing workflowsdocs/vhs/grep.tape— Dynamic tool discovery across sessions usingmcpc grepwith regex and filteringdocs/vhs/proxy.tape— MCP proxy / AI sandboxing pattern: credentialed upstream session exposed as localhost proxy without token leakagedocs/README.md— Added link to new VHS demos sectionImplementation Details
PS1) so they don't appear in the final GIFSleepdirectives after each command to give viewers time to read output before the next actionmcpc-demo.tapeserves as the template; other tapes are focused variants for specific featuresOutput,Set Width/Height,Set FontSize, server URL, and tool namesmcpc-demo.gifis checked intodocs/images/separatelyhttps://claude.ai/code/session_01E9BFtMrNCigm3YFCotFSg9