Start from a config
1 min read Source on GitHub
What it is. A small file, showcase.config.json, says what the video is: the
address of the product, the length, where it will be posted. A second file, video.ts,
says how it is filmed. One command renders everything the config asks for.
Steps
-
In your project folder:
bunx showcase init --configThis adds
showcase.config.json, a startervideo.ts, and the skill for Claude Code. -
Open
showcase.config.jsonand set the address:{ "name": "demo", "url": "http://localhost:3000", "length": 30, "formats": ["landscape"] }Only
urlis required. To film a folder of static files, use"serve": "site"in place ofurl. -
Add two lines to
.gitignore:out/ .showcase/ -
See what the video needs:
bunx showcase planIt prints the number of scenes, the words for each, the shapes, and the safety rules.
-
Write the scenes in
video.ts(or let Claude Code do it: guide 11). -
Check the picture, then render:
bunx showcase make --draft bunx showcase make
Check it worked
out/demo.mp4exists and every line of the report starts withok.- A mistake in the config stops the run with a list of everything wrong, for example
"lenght" is not a setting.
Good to know
- Add
"$schema": "./node_modules/kwartz-showcase/schema/showcase.config.schema.json"and your editor completes the settings as you type. - A complete example is in
examples/tour/.