Federico Del Gaudio
chtrs docs Quick start Contents
Back to project
•
2 min read

Quick start

Table of Contents

Requirements

Install a current Rust toolchain with Cargo, then clone the repository:

git clone https://github.com/delaudio/chtrs.git
cd chtrs

Install the binary and examples

Copy the bundled sheets into your personal configuration and install the binary into Cargo’s binary directory:

mkdir -p "$HOME/.config/chtrs/cheat-sheets"
cp -R cheat-sheets/. "$HOME/.config/chtrs/cheat-sheets/"
cargo install --path .

Ensure ~/.cargo/bin is in your PATH, then launch:

chtrs

Use j/k or the arrow keys to move through matching sheets, type letters to filter them, press Backspace to edit the filter, and press Escape to clear it. Press q to quit.

Add a first personal sheet

Create a .yaml or .yml file under ~/.config/chtrs/cheat-sheets/. chtrs discovers it the next time it starts. Continue with Writing cheat sheets for the complete structure.