Betamax records terminal sessions from VHS-style tape files as GIFs, screenshots, videos, and JSON snapshots for tests, on macOS and Linux. The docs site has the details; this page points to them.
| To | See |
|---|---|
| See what Betamax does | The docs site or the crates.io page |
| Install and render a first tape | Quick start |
| Write tapes | Writing tapes and the Tape reference |
| Test a terminal app | Terminal testing and State JSON |
| Render tapes on pull requests | GitHub Action |
| Move tapes over from VHS | Differences from VHS |
| Embed Betamax in Rust | betamax-core on docs.rs |
| Browse rendered examples | Examples |
| Ask a question or share a project | Discussions and Show and tell |
| Get help or report a bug | SUPPORT.md and Issues |
| Report a vulnerability | SECURITY.md |
| Build from source or contribute | CONTRIBUTING.md and Development |
| Path | Contents |
|---|---|
crates/betamax |
The betamax CLI |
crates/betamax-core |
Tape parsing, the runner, rendering, media, and state JSON |
crates/betamax-fonts |
Font data embedded for the default font |
examples/ |
Small tapes used as smoke tests and documentation examples |
site/ |
Source for the docs site |
docs/ |
Contributor and maintainer docs, starting at docs/README.md |
scripts/ |
Helpers behind the mise run tasks |
For local development, mise install sets up the pinned toolchain, including Zig 0.15.2, and
mise run check runs the CI checks. Before changing this file or the crate READMEs, see
READMEs and media.
Betamax is licensed under MIT or Apache-2.0. Third-party notices are in THIRD_PARTY.md.