3 个版本 (breaking)
0.3.0 | 2022年4月23日 |
---|---|
0.2.0 | 2020年9月28日 |
0.1.0 | 2020年9月12日 |
#1 in #asciicast
每月下载量52次
14KB
244 行
asciinema-scenario
从文本文件创建asciinema视频。
你是否曾经反复重录asciinema视频以达到完美的速度并避免输入错误?我也是,太多了,这就是我写这个工具的原因。
安装
如果你已经安装了 Nix,则输入 nix-build
,asciinema-scenario
可执行文件将在 ./result/bin/
中可用。
$ nix-build
$ result/bin/asciinema-scenario
用法
如何编写.scenario文件?
-
如果第一行以
#!
开头,则其后必须跟一个JSON对象。对象可以包含名称 类型 默认值 描述 步骤 浮点数 0.10 单个事件的打字速度的时间(秒)。 宽度 整数 77 一行中的最大字符数。 高度 整数 20 视频的行数 -
空行将添加
3 x 步骤
的超时。 -
以
#timeout: 1.5
开头的行将创建一个 1.5 秒的超时。当需要自定义超时时,选择所需的超时时间。 -
以
#
开头的行将被跳过,可以作为注释使用。 -
以
#
开头的行将以步骤
超时逐一输入。在#
之后的所有字符都将更亮。 -
以 "(nix-shell) $ " 开头的行将以绿色显示
(nix-shell)
。 -
以 "--" 开头的行将清除屏幕。在终端屏幕清除之前,将有一个
18 * 步骤
的超时。 -
其他所有内容都将立即显示。
技巧
-
要立即显示一个shell命令行示例(而不是像默认行为那样逐个输入),请在
$
前面加上一个 zero-width space -
为了快速播放您正在工作的场景(或任何场景),请使用
$ asciinema-scenario my.scenario | asciinema play - # or $ asciinema play <(asciinema-scenario my.scenario)
发布
详细的发布说明可在本仓库的CHANGES.md中查看。
问题报告
发现了bug?我很乐意了解它!
请在GitHub 问题跟踪器上报告所有问题。
许可
以下任一许可下授权
- Apache License, Version 2.0, (LICENSE-APACHE 或 https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT 或 https://opensource.org/licenses/MIT)
依赖
~4–13MB
~144K SLoC