cheatsheet is a command-line reference manual providing a text-based user interface for reading tldr pages. Its purpose is to make command-line knowledge easy to access.
It's easy to get started and there are many ways to help cheatsheet grow into a useful tool.
See the contributing guidelines!
Run cheatsheet. The TUI lists common CLI commands and examples by
section, with sections grouped into pages.
Navigate the TUI with these keys:
| keys | function |
|---|---|
| ? | toggle full key hints |
| q | quit the app |
| c | clear on-screen errors |
| Enter | view commands or command page |
| Backspace | go back to the previous view |
| j, Down | select the next item |
| k, Up | select the previous item |
| l, Right, PageDown | select the next page |
| h, Left, PageUp | select the previous page |
cheatsheet's dataset can be supplemented with local data files in the same format.
See Data schema for a description of this format and the
data directory for working examples.
cheatsheet reads local data files from $XDG_CONFIG_HOME/cheatsheet or
$HOME/.config/cheatsheet if $XDG_CONFIG_HOME is not set.
If a package is available for your distro, install it using the instructions below:
-
git clone https://aur.archlinux.org/cheatsheet.git cd cheatsheet makepkg -si
-
Fedora (copr)
dnf copr enable jcrd/cheatsheet dnf install cheatsheet
- make [build]
- go >= 1.18 [build]
- git [runtime]
Ensure the above build dependencies are satisfied and build with: make.
After building cheatsheet, make install can be used to install it.
This project is licensed under the MIT License (see LICENSE).