cli-kneeboard

cli-kneeboard is a small tool that reads Markdown Checklists and lets you programmatically run through them.

It can also save the progress of a checklist in TOML allowing you to have reusable todo lists.

When the app exits it will close with an ExitCode equal to the number of unresolved checklist items. This means you can use it as a git hook example here.

Setup

from our pipeline

• Go to releases and download the latest binary for your architecture.
• Extract the file and copy the binary to your PATH.

from crates.io

• run cargo install cli-kneeboard

from source

• clone or download the repo
• use cargo run -- [OPTIONS] to run the app in debug mode
• or compile it with cargo build --release and get the binary from ./target/release/kneeboard

Usage

```bash $ kneeboard --help cli-kneeboard 0.1.0 Alexis Lowe agl314@chimbosonic.com Checklist Tool

USAGE: kneeboard [OPTIONS] --checklist-path

OPTIONS: -c, --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 is required and is the path to the Markdown checklist you want to load
• --save || -s tells cli-kneeboard to save the progress of the checklist in the same folder as the checklist named .<checklist-name>.kb.toml
• --verbose || -v lets you set verbosity the more v's provided the higher the verbosity

cli-kneeboard will read in a Checklist following the specification described in SPEC.md