cli-kneeboard

cli-kneeboard 是一个读取 Markdown 清单并允许您以编程方式运行它们的工具。

它能够将清单进度保存为 TOML，让您拥有可重用的待办事项列表。

当应用程序退出时，它将以等于未解决清单项数的 ExitCode 退出。这意味着您可以用作 git 钩子 示例。

安装

从二进制文件

• 前往 发布版 并下载适用于您的架构的最新二进制文件。
• 提取文件并将二进制文件复制到您的 PATH。

从 crates.io 的源

• 运行 cargo install cli-kneeboard

从 Github.com 的源

• 克隆或下载仓库
• 使用 cargo run -- [OPTIONS] 以调试模式运行应用程序
• 或使用 cargo build --release 编译，并从 ./target/release/kneeboard 获取二进制文件

用法

$ kneeboard --help
cli-kneeboard 0.1.0
Alexis Lowe <[email protected]>
Checklist Tool

USAGE:
    kneeboard [OPTIONS] --checklist-path <CHECKLIST_PATH>

OPTIONS:
    -c, --checklist-path <CHECKLIST_PATH>    Path to the checklist
    -h, --help                               Print help information
    -s, --save                               Save progress of the checklist
    -v, --verbose                            Turn debugging information on
    -V, --version                            Print version information

• --checklist-path 或 -c 是必需的，是您想要加载的 Markdown 清单的路径
• --save 或 -s 告诉 cli-kneeboard 将清单进度保存到与清单相同的文件夹中，命名为 .<checklist-name>.kb.toml
• --verbose 或 -v 允许您设置详细程度，提供的 v 越多，详细程度越高

cli-kneeboard 将读取遵循 SPEC.md 中描述的规范的清单