mirror of
https://github.com/cheat/cheat.git
synced 2026-03-07 03:03:32 +01:00
80e0e0d3ae
Iterates over configured cheatpaths and runs git pull on each one that is a git repository with a clean worktree. Supports SSH remotes via key file discovery and SSH agent fallback. Works with --path filtering. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
230 lines
4.7 KiB
Markdown
230 lines
4.7 KiB
Markdown
% CHEAT(1) | General Commands Manual
|
|
|
|
NAME
|
|
====
|
|
|
|
**cheat** — create and view command-line cheatsheets
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
| **cheat** \[options] \[_CHEATSHEET_]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
**cheat** allows you to create and view interactive cheatsheets on the
|
|
command-line. It was designed to help remind \*nix system administrators of
|
|
options for commands that they use frequently, but not frequently enough to
|
|
remember.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
--init
|
|
: Print a config file to stdout.
|
|
|
|
--conf
|
|
: Display the config file path.
|
|
|
|
-a, --all
|
|
: Search among all cheatpaths.
|
|
|
|
-b, --brief
|
|
: List cheatsheets without file paths.
|
|
|
|
-c, --colorize
|
|
: Colorize output.
|
|
|
|
-d, --directories
|
|
: List cheatsheet directories.
|
|
|
|
-e, --edit=_CHEATSHEET_
|
|
: Open _CHEATSHEET_ for editing.
|
|
|
|
-l, --list
|
|
: List available cheatsheets.
|
|
|
|
-p, --path=_PATH_
|
|
: Filter only to sheets found on path _PATH_.
|
|
|
|
-r, --regex
|
|
: Treat search _PHRASE_ as a regular expression.
|
|
|
|
-s, --search=_PHRASE_
|
|
: Search cheatsheets for _PHRASE_.
|
|
|
|
-t, --tag=_TAG_
|
|
: Filter only to sheets tagged with _TAG_.
|
|
|
|
-T, --tags
|
|
: List all tags in use.
|
|
|
|
-u, --update
|
|
: Update git-backed cheatpaths by pulling the latest changes.
|
|
|
|
-v, --version
|
|
: Print the version number.
|
|
|
|
--rm=_CHEATSHEET_
|
|
: Remove (deletes) _CHEATSHEET_.
|
|
|
|
--completion=_SHELL_
|
|
: Generate a shell completion script. _SHELL_ must be one of: **bash**,
|
|
**zsh**, **fish**, **powershell**.
|
|
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
To view the foo cheatsheet:
|
|
: cheat _foo_
|
|
|
|
To edit (or create) the foo cheatsheet:
|
|
: cheat -e _foo_
|
|
|
|
To edit (or create) the foo/bar cheatsheet on the 'work' cheatpath:
|
|
: cheat -p _work_ -e _foo/bar_
|
|
|
|
To view all cheatsheet directories:
|
|
: cheat -d
|
|
|
|
To list all available cheatsheets:
|
|
: cheat -l
|
|
|
|
To briefly list all cheatsheets whose titles match 'apt':
|
|
: cheat -b _apt_
|
|
|
|
To list all tags in use:
|
|
: cheat -T
|
|
|
|
To list available cheatsheets that are tagged as 'personal':
|
|
: cheat -l -t _personal_
|
|
|
|
To search for 'ssh' among all cheatsheets, and colorize matches:
|
|
: cheat -c -s _ssh_
|
|
|
|
To search (by regex) for cheatsheets that contain an IP address:
|
|
: cheat -c -r -s _'(?:[0-9]{1,3}\.){3}[0-9]{1,3}'_
|
|
|
|
To remove (delete) the foo/bar cheatsheet:
|
|
: cheat --rm _foo/bar_
|
|
|
|
To update all git-backed cheatpaths:
|
|
: cheat --update
|
|
|
|
To update only the 'community' cheatpath:
|
|
: cheat -u -p _community_
|
|
|
|
To view the configuration file path:
|
|
: cheat --conf
|
|
|
|
|
|
FILES
|
|
=====
|
|
|
|
Configuration
|
|
-------------
|
|
**cheat** is configured via a YAML file that is conventionally named
|
|
_conf.yml_. **cheat** will search for _conf.yml_ in varying locations,
|
|
depending upon your platform:
|
|
|
|
### Linux, OSX, and other Unixes ###
|
|
|
|
1. **CHEAT_CONFIG_PATH**
|
|
2. **XDG_CONFIG_HOME**/cheat/conf.yml
|
|
3. **$HOME**/.config/cheat/conf.yml
|
|
4. **$HOME**/.cheat/conf.yml
|
|
5. /etc/cheat/conf.yml
|
|
|
|
### Windows ###
|
|
|
|
1. **CHEAT_CONFIG_PATH**
|
|
2. **APPDATA**/cheat/conf.yml
|
|
3. **PROGRAMDATA**/cheat/conf.yml
|
|
|
|
**cheat** will search in the order specified above. The first _conf.yml_
|
|
encountered will be respected.
|
|
|
|
If **cheat** cannot locate a config file, it will ask if you'd like to generate
|
|
one automatically. Alternatively, you may also generate a config file manually
|
|
by running **cheat --init** and saving its output to the appropriate location
|
|
for your platform.
|
|
|
|
|
|
Cheatpaths
|
|
----------
|
|
**cheat** reads its cheatsheets from "cheatpaths", which are the directories in
|
|
which cheatsheets are stored. Cheatpaths may be configured in _conf.yml_, and
|
|
viewed via **cheat -d**.
|
|
|
|
For detailed instructions on how to configure cheatpaths, please refer to the
|
|
comments in conf.yml.
|
|
|
|
|
|
Autocompletion
|
|
--------------
|
|
**cheat** can generate shell completion scripts for **bash**, **zsh**,
|
|
**fish**, and **powershell** via the **--completion** flag:
|
|
|
|
cheat --completion bash
|
|
cheat --completion zsh
|
|
cheat --completion fish
|
|
cheat --completion powershell
|
|
|
|
Completions are dynamically generated and include cheatsheet names, tags, and
|
|
cheatpath names.
|
|
|
|
To install completions, pipe the output to the appropriate location for your
|
|
shell. For example, on **bash**:
|
|
|
|
cheat --completion bash > /etc/bash_completion.d/cheat
|
|
|
|
Or for the current user only:
|
|
|
|
cheat --completion bash > ~/.local/share/bash-completion/completions/cheat
|
|
|
|
For **zsh**, you may need to add the completions directory to your **fpath**:
|
|
|
|
cheat --completion zsh > "${fpath[1]}/_cheat"
|
|
|
|
For **fish**:
|
|
|
|
cheat --completion fish > ~/.config/fish/completions/cheat.fish
|
|
|
|
|
|
ENVIRONMENT
|
|
===========
|
|
|
|
**CHEAT_CONFIG_PATH**
|
|
|
|
: The path at which the config file is available. If **CHEAT_CONFIG_PATH** is
|
|
set, all other config paths will be ignored.
|
|
|
|
RETURN VALUES
|
|
=============
|
|
|
|
0. Successful termination
|
|
|
|
1. Application error
|
|
|
|
2. Cheatsheet(s) not found
|
|
|
|
|
|
BUGS
|
|
====
|
|
|
|
See GitHub issues: <https://github.com/cheat/cheat/issues>
|
|
|
|
|
|
AUTHOR
|
|
======
|
|
|
|
Christopher Allen Lane <chris@chris-allen-lane.com>
|
|
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
**fzf(1)**
|
|
|