otty / dotfiles

All tools/cheat

cheat

cheat allows you to create and view interactive cheatsheets on the command-line.

Detected by cheat | macOS, Linux, Windows |github.com

Sync it cheat.toml

Sync rules

What travels, what stays, what never leaves

cheat in your home directory Every rule on this page, by file

cheatpaths.*.path

Each machine keeps its own copy of these.

cheatpaths.*.path

Each machine keeps its own copy of these.

cheatpaths.*.path

Each machine keeps its own copy of these.

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/cheat.tomlThe file this page is generated from

id = "cheat"

name = "cheat"

homepage = "https://github.com/cheat/cheat"

description = "cheat allows you to create and view interactive cheatsheets on the command-line."

detect = ["cheat"]

# internal/config/paths.go, Paths(): $CHEAT_CONFIG_PATH wins outright; failing

# that the search order on aix/android/darwin/dragonfly/freebsd/illumos/ios/

# linux/netbsd/openbsd/plan9/solaris is $XDG_CONFIG_HOME/cheat/conf.yml,

# $HOME/.config/cheat/conf.yml, $HOME/.cheat/conf.yml, /etc/cheat/conf.yml, and

# on windows it is %APPDATA%\cheat\conf.yml then %PROGRAMDATA%\cheat\conf.yml.

# INSTALLING.md says the same in prose: "By default, the config file is assumed

# to exist on an XDG-compliant configuration path like ~/.config/cheat/conf.yml".

# The XDG lookup is a real $XDG_CONFIG_HOME read, so it is [configHome]; macOS

# takes the same dotted path, not ~/Library. %APPDATA% is a location of its own

# and keeps its literal spelling. The system-wide /etc and %PROGRAMDATA% copies

# are not user-level and are not listed.

paths = [

"[configHome]/cheat/conf.yml",

"~/.cheat/conf.yml",

"%APPDATA%/cheat/conf.yml",

]

exclude = []

# cheat reads and writes plain-text cheatsheets; it authenticates against

# nothing.

secret = []

# Read once at startup on every invocation.

side_effect = false

# `cheatpaths` is a list of directories on this disk — the community checkout

# and the personal sheets both carry an absolute path, and the same config on

# another machine points at a home directory that does not exist there. Every

# spelling of the file, or the lines only stay behind on the platform that

# happens to be listed first. `editor`, `colorize`, `style` and `formatter` are

# deliberately absent: those are the preferences a user wants carried. The

# cheatpaths are where the user's own sheets live, so they are kept for a

# rebuild of this machine rather than discarded: backup.

[[machine_lines]]

file = ["[configHome]/cheat/conf.yml", "~/.cheat/conf.yml", "%APPDATA%/cheat/conf.yml"]

match = { key_path = ["cheatpaths.*.path"] }

scope = "backup"

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/cheat. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page. None of them splits cheatpaths.*.path and cheatpaths.*.path for you — that part is Otty’s own sync, or a template you write by hand.