Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 11:48:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Marcin Kulik
2025-09-11 20:57:29 +02:00
parent d8393a69aa
commit 19f440a3c4
1 changed files with 32 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -4,35 +4,39 @@
[![license](http://img.shields.io/badge/license-GNU-blue.svg)](https://raw.githubusercontent.com/asciinema/asciinema/master/LICENSE) [![license](http://img.shields.io/badge/license-GNU-blue.svg)](https://raw.githubusercontent.com/asciinema/asciinema/master/LICENSE)
__asciinema__ (aka asciinema CLI or asciinema recorder) is a command-line tool __asciinema__ (aka asciinema CLI or asciinema recorder) is a command-line tool
for recording terminal sessions. for recording and live streaming terminal sessions.
Unlike typical _screen_ recording software, which records visual output of a Unlike typical _screen_ recording software, which records visual output of a
screen into a heavyweight video files (`.mp4`, `.mov`), asciinema recorder runs screen into a heavyweight video files (`.mp4`, `.mov`), asciinema CLI runs
_inside a terminal_, capturing terminal session output into a lightweight _inside a terminal_, capturing terminal session output into a lightweight
recording files in the recording files in the
[asciicast](https://docs.asciinema.org/manual/asciicast/v2/) format (`.cast`). [asciicast](https://docs.asciinema.org/manual/asciicast/v3/) format (`.cast`),
or streaming it live to viewers in real-time.
The recordings can be replayed in a terminal, embedded on a web page with the The recordings can be replayed in a terminal, embedded on a web page with the
[asciinema player](https://docs.asciinema.org/manual/player/), or published to [asciinema player](https://docs.asciinema.org/manual/player/), or published to
an [asciinema server](https://docs.asciinema.org/manual/server/), such as an [asciinema server](https://docs.asciinema.org/manual/server/), such as
[asciinema.org](https://asciinema.org), for further sharing. [asciinema.org](https://asciinema.org), for further sharing. Live streams allow
viewers to watch terminal sessions as they happen.
asciinema runs on GNU/Linux, macOS and FreeBSD.
[![asciinema CLI [![asciinema CLI
demo](https://asciinema.org/a/85R4jTtjKVRIYXTcKCNq0vzYH.svg)](https://asciinema.org/a/85R4jTtjKVRIYXTcKCNq0vzYH?autoplay=1) demo](https://asciinema.org/a/85R4jTtjKVRIYXTcKCNq0vzYH.svg)](https://asciinema.org/a/85R4jTtjKVRIYXTcKCNq0vzYH?autoplay=1)
Notable features: Notable features:
* [recording](https://docs.asciinema.org/manual/cli/usage/#asciinema-rec-filename) - recording and replaying of sessions inside a terminal,
and - local and remote [live
[replaying](https://docs.asciinema.org/manual/cli/usage/#asciinema-play-filename) streaming](https://docs.asciinema.org/manual/cli/quick-start/#stream-a-terminal-session)
of sessions inside a terminal, of terminal sessions to multiple viewers in real-time,
* live streaming of terminal sessions, via local HTTP server, and via remote asciinema server, - [lightweight recording
* [light-weight recording format](https://docs.asciinema.org/manual/asciicast/v3/), which is highly
format](https://docs.asciinema.org/manual/asciicast/v2/), which is highly
compressible (down to 15% of the original size e.g. with `zstd` or `gzip`), compressible (down to 15% of the original size e.g. with `zstd` or `gzip`),
* integration with [asciinema - integration with [asciinema
server](https://docs.asciinema.org/manual/server/), e.g. server](https://docs.asciinema.org/manual/server/), e.g.
[asciinema.org](https://asciinema.org), for easy recording hosting. [asciinema.org](https://asciinema.org), for easy recording hosting and live
streaming.
To record a session run this command in your shell: To record a session run this command in your shell:
@@ -43,13 +47,13 @@ asciinema rec demo.cast
To stream a session via built-in HTTP server run: To stream a session via built-in HTTP server run:
```sh ```sh
asciinema stream --local asciinema stream -l
``` ```
To stream a session via a relay (asciinema server) run: To stream a session via a relay (asciinema server) run:
```sh ```sh
asciinema stream --remote asciinema stream -r
``` ```
Check out the [Getting started Check out the [Getting started
@@ -64,7 +68,7 @@ manager](https://doc.rust-lang.org/cargo/). If they are not available via your
system package manager then use [rustup](https://rustup.rs/). system package manager then use [rustup](https://rustup.rs/).
To download the source code, build the asciinema binary, and install it in To download the source code, build the asciinema binary, and install it in
`$HOME/.cargo/bin` run: `$HOME/.cargo/bin` in one go run:
```sh ```sh
cargo install --locked --git https://github.com/asciinema/asciinema cargo install --locked --git https://github.com/asciinema/asciinema
@@ -81,9 +85,8 @@ cd asciinema
cargo build --release cargo build --release
``` ```
This produces the binary in _release mode_ (`--release`) at This produces the binary at `target/release/asciinema`. You can just copy the
`target/release/asciinema`. You can just copy the binary to a directory in your binary to a directory in your `$PATH`.
`$PATH`.
To generate man pages and shell completion files, set `ASCIINEMA_GEN_DIR` to the To generate man pages and shell completion files, set `ASCIINEMA_GEN_DIR` to the
path where these artifacts should be stored. For example: path where these artifacts should be stored. For example:
@@ -96,27 +99,26 @@ The above command will build the binary and place the man pages in `/foo/man/`,
and the shell completion files in the `/foo/completion/` directory. and the shell completion files in the `/foo/completion/` directory.
> [!NOTE] > [!NOTE]
> Windows is currently not supported. _(See [#467](https://github.com/asciinema/asciinema/issues/467))_ > Windows is currently not supported. See [#467](https://github.com/orgs/asciinema/discussions/278).
## Development ## Development
This branch contains the next generation of the asciinema CLI, written in Rust All development happens on `develop` branch. This branch contains the current
([about the generation (3.x) of the asciinema CLI, written in Rust.
rewrite](https://discourse.asciinema.org/t/rust-rewrite-of-the-asciinema-cli/777)).
It is still in a work-in-progress stage, so if you wish to propose any code The previous generation (2.x), written in Python, can be found in the `v2`
changes, please first reach out to the team via branch.
[forum](https://discourse.asciinema.org/),
If you wish to propose non-trivial code changes, please first reach out to the
team via [forum](https://discourse.asciinema.org/),
[Matrix](https://matrix.to/#/#asciinema:matrix.org) or [Matrix](https://matrix.to/#/#asciinema:matrix.org) or
[IRC](https://web.libera.chat/#asciinema). [IRC](https://web.libera.chat/#asciinema).
The previous generation of the asciinema CLI, written in Python, can be found in
the `main` branch.
## Donations ## Donations
Sustainability of asciinema development relies on donations and sponsorships. Sustainability of asciinema development relies on donations and sponsorships.
Please help the software project you use and love. Become a If you like the project then consider becoming a
[supporter](https://docs.asciinema.org/donations/#individuals) or a [corporate [supporter](https://docs.asciinema.org/donations/#individuals) or a [corporate
sponsor](https://docs.asciinema.org/donations/#corporate-sponsorship). sponsor](https://docs.asciinema.org/donations/#corporate-sponsorship).