asciinema
Terminal session recorder, streamer and player πΉ
File Explorer
Download Latest Version (.zip)- config.toml
- bug-report.yml
- config.yml
- ci.yml
- release.yml
- PULL_REQUEST_TEMPLATE.md
- asciinema-player.css
- asciinema-player.min.js
- index.html
- SymbolsNerdFont-Regular.woff2
- util.rs
- v1.rs
- v2.rs
- v3.rs
- auth.rs
- cat.rs
- convert.rs
- mod.rs
- play.rs
- session.rs
- upload.rs
- asciicast.rs
- mod.rs
- raw.rs
- txt.rs
- default.rs
- inspect.rs
- macos.rs
- alis.rs
- api.rs
- asciicast.rs
- cli.rs
- config.rs
- fd.rs
- file_output.rs
- forwarder.rs
- hash.rs
- html.rs
- leb128.rs
- locale.rs
- main.rs
- notifier.rs
- output_writer.rs
- player.rs
- pty.rs
- server.rs
- session.rs
- status.rs
- stream.rs
- tty.rs
- util.rs
- demo.cast
- demo.json
- full-v1.json
- full-v2.cast
- full-v3.cast
- minimal-v1.json
- minimal-v2.cast
- minimal-v3.cast
- nulls-v1.json
- nulls-v2.cast
- integration.sh
- .gitattributes
- .gitignore
- build.rs
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- CONTRIBUTING.md
- default.nix
- Dockerfile
- flake.lock
- flake.nix
- LICENSE
- README.md
- shell.nix
# Installation Guide
1. Get the code
git clone https://github.com/asciinema/asciinema
Downloads the entire project code from GitHub to your computer.
cd asciinema
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Rust (rustup) Rust is required to use cargo.
cargo install --locked --git https://github.com/asciinema/asciinema
Builds and installs the package published on crates.io β no need to clone the repo yourself.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t asciinema .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 asciinema
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked --git https://github.com/asciinema/asciinema
Builds and installs the package published on crates.io β no need to clone the repo yourself.
cargo build --release
Compiles the Rust project.
ASCIINEMA_GEN_DIR=/foo cargo build --release
Compiles the Rust project.
If cargo build finishes without errors, it worked. The executable is created under target/.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)