Skip to content

📋 cheat

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.

I use this rather than cheat.sh because I can more easily add and edit my own cheatsheets.

🛠 Installation

curl https://installer.l.nicholaswilde.io/cheat/cheat?type=script | bash

⚙ Config

Make the config dir

mkdir -p ~/.config/cheat

~/.config/cheat/conf.yml

cat > ~/.config/cheat/conf.yml <<EOF
---
cheatpaths:
  - name: community                
    path: /mnt/storage/cheat/cheatsheets/community
    tags: [ community ]            
    readonly: true

  - name: personal
    path: /mnt/storage/cheat/cheatsheets/personal  # this is a separate directory and repository than above
    tags: [ personal ]
    readonly: false
EOF

---
cheatpaths:
  - name: community                
    path: /mnt/storage/cheat/cheatsheets/community
    tags: [ community ]            
    readonly: true

  - name: personal
    path: /mnt/storage/cheat/cheatsheets/personal
    tags: [ personal ]
    readonly: false

Download cheatsheets locally

(
  mkdir -p /mnt/storage/cheat/cheatsheets
  git clone [email protected]:nicholaswilde/cheatsheets.git /mnt/storage/cheat/cheatsheets/personal
)

📝 Usage

Show gpg cheatsheet

cheat gpg

Edit gpg cheatsheet

cheat -e gpg

🔗 References