docs: refresh README demo screencast for current devbox experience#2842
Merged
Conversation
The old demo used outdated syntax (python2, go_1_18). Replace it with a fresh animated SVG that uses the modern python@3.10 / go@1.18 syntax, shows the real CLI output (Info: ... / ✓ Computed the Devbox environment.), and demonstrates both `devbox run python --version` and `devbox shell`. Adds scripts/gen_cast.py to regenerate the asset via svg-term.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README’s demo screencast to reflect the current Devbox CLI workflow, and adds a small generator script to make future refreshes reproducible.
Changes:
- Replaces the outdated README demo description and image with a new animated terminal SVG.
- Adds
scripts/gen_cast.pyto generate an asciinema v2 cast used to render the SVG. - Commits the regenerated
docs/app/static/img/devbox_demo.svgasset.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| scripts/gen_cast.py | Adds a generator for a deterministic asciinema cast representing the current CLI experience. |
| README.md | Updates the Demo section text and points the image to the new in-repo SVG asset. |
| docs/app/static/img/devbox_demo.svg | Adds the updated animated terminal SVG used by the README demo. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+127
to
+130
| with open(sys.argv[1], "w") as f: | ||
| f.write(json.dumps(header) + "\n") | ||
| for ev in events: | ||
| f.write(json.dumps(ev) + "\n") |
| prompt() | ||
| type_cmd("devbox init") | ||
| output([ | ||
| "Created devbox.json in .", |
Collaborator
There was a problem hiding this comment.
I think this is fine to handwave
| # 5. drop into an interactive shell | ||
| prompt() | ||
| type_cmd("devbox shell") | ||
| output([f"{DIM}Starting a devbox shell...{RESET}"]) |
Collaborator
There was a problem hiding this comment.
Also fine --- maybe we should even set this to {DIM} in the actual devbox... it looks better
Lagoja
approved these changes
Jun 1, 2026
Collaborator
Lagoja
left a comment
Lagoja
left a comment
There was a problem hiding this comment.
LGTM, up to you if you want to address the arg feedback from Copilot
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
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.
What
The README "Demo" screencast was badly out of date — it used long-removed
syntax (
devbox add python2 go_1_18) and only showeddevbox shell.This replaces it with a fresh animated terminal SVG that matches the current
devbox experience:
go version→command not found(tool absent on the host)devbox initdevbox add python@3.10 go@1.18— modern@versionsyntaxdevbox run python --version— running a one-off command in the envdevbox shell— interactive shell, withpython/gonow onPATHAll printed output mirrors what the CLI emits today (
Info: …,✓ Computed the Devbox environment., etc.), pulled from the current source ininternal/boxcli,internal/devbox, andinternal/ux.How
The asset was generated with
svg-term(same tool as the original) from an asciinema cast.
scripts/gen_cast.pygenerates the cast and documents the regenerate recipe in its docstring, so the
demo can be refreshed when CLI messages change.
Notes
docs/directory, so the asset is committed atdocs/app/static/img/devbox_demo.svgand referenced by a relative path,which resolves on any branch/fork. GitHub animates CSS-based SVGs loaded as
<img>. If you'd rather host it on the Jetify CDN like the previous demo,drag-drop the file into this PR and swap the URL.
https://claude.ai/code/session_013G36YikMTv7NnYe76cyxpy
Generated by Claude Code