14个版本
3.0.0-rc.3 | 2024年6月26日 |
---|---|
3.0.0-rc.2 | 2024年5月7日 |
3.0.0-rc.1 | 2024年4月17日 |
3.0.0-beta.3 | 2024年2月8日 |
3.0.0-alpha.1 | 2023年10月22日 |
#329 in 命令行工具
131 每月下载量
375KB
4K SLoC
asciinema
asciinema (又称asciinema CLI或asciinema录制器) 是一个用于录制终端会话的命令行工具。
与典型的screen录制软件不同,后者将屏幕的视觉输出记录到重量级的视频文件中(例如.mp4
,.mov
),asciinema录制器在终端内运行,捕获终端会话输出到轻量级的.cast
格式的录制文件中。
录制可以在终端中回放,嵌入带有asciinema播放器
的网页中,或发布到asciinema服务器(例如asciinema.org)以进一步共享。
主要功能
- 录制和回放终端内的会话,
- 带有本地HTTP服务器模式和转发模式的终端会话实时流,
- 轻量级录制格式,具有高度可压缩性(例如使用
zstd
或gzip
压缩到原始大小的15%), - 与asciinema服务器(例如asciinema.org)集成,便于录制托管。
要在您的shell中录制会话,请运行以下命令
asciinema rec demo.cast
要通过内置HTTP服务器流会议,请运行
asciinema stream --serve
要通过中继(asciinema服务器)流会议,请运行
asciinema stream --relay
查看入门指南,了解安装和使用概述。
构建
从源代码构建asciinema需要Rust编译器(1.70或更高版本),以及Cargo包管理器。如果它们通过系统包管理器不可用,则使用rustup。
要下载源代码,构建asciinema二进制文件,并将其安装在$HOME/.cargo/bin
,请运行
cargo install --locked --git https://github.com/asciinema/asciinema
然后,确保$HOME/.cargo/bin
已添加到您的shell的$PATH
中。
或者,您可以直接下载源代码,并使用以下命令构建asciinema二进制文件
git clone https://github.com/asciinema/asciinema
cd asciinema
cargo build --release
这将生成在发布模式(--release
)下位于target/release/asciinema
的二进制文件。您只需将二进制文件复制到您的$PATH
目录中的一个目录即可。
要生成手册页和shell完成文件,将ASCIINEMA_GEN_DIR
设置为存储这些工件的位置。例如
ASCIINEMA_GEN_DIR=/foo cargo build --release
上述命令将构建二进制文件,并将手册页放在/foo/man/
,并将shell完成文件放在/foo/completion/
目录中。
[!注意] Windows目前不支持。(见#467)
开发
此分支包含asciinema CLI的下一代,使用Rust编写(关于重写)。它仍然处于工作状态,因此如果您想提出任何代码更改,请先通过论坛、Matrix或IRC联系团队。
asciinema CLI的前一代,使用Python编写,可以在main
分支中找到。
捐赠
asciinema开发的可持续性依赖于捐赠和赞助。
asciinema由以下公司赞助
咨询
如果您对asciinema的集成或定制感兴趣,以适应您的需求,请查看asciinema咨询服务。
许可证
© 2011 Marcin Kulik。
所有代码都根据GPL,v3或更高版本授权。有关详细信息,请参阅LICENSE文件。
依赖项
~28–63MB
~1M SLoC