sheets

A simple command-line cheat sheet manager.

Installation

Pre-built binary (recommended)

curl -fsSL https://github.com/antonysastre/sheets/releases/latest/download/install.sh | bash

Or download from Releases.

From source

go install github.com/antonysastre/sheets/cmd/she@latest

Usage

she <tool>            View cheat sheet
she --list, -l        List all cheat sheets
she --edit, -e <tool> Edit cheat sheet (creates if missing)
she --new, -n <tool>  Create new cheat sheet
she --sync, -s [repo] Sync sheets to a git repo (pass repo to set up)
she --help, -h        Show help
she --version, -v     Print version and exit

Syncing

she --sync keeps your sheets in step across machines through a central git repository.

Set it up once per machine, pointing at a dedicated git repository — one created just for your sheets, empty on first use, with a main branch:

she --sync git@github.com:you/sheets.git

This turns ~/.sheets into a git repository, merges in anything already on the remote, and pushes your local sheets up. she writes a small .shetag marker file into the repository to identify it as a sheets repo; setup refuses a non-empty repository that lacks this marker, so you can't accidentally point --sync at an unrelated project.

From then on, just run:

she --sync

Each run commits your local changes, rebases onto the latest remote, and pushes — so every machine ends up with every machine's sheets. If the same sheet was edited on two machines between syncs, she stops and tells you which sheet to resolve by hand; your local changes are committed and safe in the meantime.

If two machines run she --sync <repo> against the same empty remote at exactly the same time, one push wins and the other is rejected. To recover on the losing machine, delete ~/.sheets/.git and run she --sync <repo> again — it will adopt the winner's marker. Your sheet files in ~/.sheets/ are untouched.

Sheet Format

Sheets use a small markdown-flavored format. Each line is one of:

• A section header — any line whose first non-whitespace character is an uppercase letter. Rendered in bold.
• A comment — a line whose first non-whitespace character is #. Free-standing notes; rendered dim.
• A command, optionally with a description — the command is the text from the start of the line up to the first #; anything after that # is the description. A line with no # is just a bare command.
• A blank line — left blank in the output.

Example:

List
git tag                      # all tags, alphabetical
git tag -l 'v1.*'            # filter by pattern

Delete
git tag -d v1.2.3            # local
# or: git push origin :refs/tags/v1.2.3

The first # on a line always ends the command, so commands that contain a literal # (e.g. URL fragments) can't carry a description on the same line — drop the description or move it to a free-standing # comment on the next line.

Note: This is a hard cutover from the older command > description / // syntax. Existing sheets in that format will render as plain command lines until you port them.

Configuration

Set your preferred editor (VISUAL takes precedence over EDITOR, per Unix convention):

export VISUAL=vim  # or EDITOR

Sheets are stored in ~/.sheets/.

Releasing

Releases are cut by pushing a semver tag — GitHub Actions runs goreleaser and publishes the binaries plus install.sh as release assets.

git tag -a v0.1.0 -m "v0.1.0"
git push origin v0.1.0

To dry-run goreleaser locally without publishing:

goreleaser release --snapshot --clean --skip=publish