Skip to content

🪄 Cheatsheets 📋

ci convert publish task

Nicholas Wilde's personal cheatsheets — a central reference for commands and configurations used in homelab administration, software development, and system management.


📚 About

This collection is designed to be used with cheat, a command-line tool for managing and searching cheatsheets. It supplements the community-sourced cheatsheets and cheat.sheets.

Browse individual cheatsheets using the navigation on the left, or use the search bar above to find a specific command.


📄 Format

Cheatsheets are plain-text files with an optional YAML front matter header used to assign tags and specify syntax highlighting.

---
syntax: bash
tags:
  - vcs
  - development
---
# To stage all changes in the current directory:
git add --all

# To commit staged changes:
git commit -m <message>

Parameter placeholders follow docopt syntax where possible.


🛠 Installation

Clone the repository and mount it via NFS or a local path.

git clone https://github.com/nicholaswilde/cheatsheets.git personal

Configure cheatpaths in cheat:

# conf.yml
pager: bat -p
cheatpaths:
  - name: personal
    path: /path/to/cheatsheets/sheets
    tags: [ personal ]
    readonly: false

📝 Usage

cheat -e git        # open or create the "git" cheatsheet
cheat git           # view the "git" cheatsheet
cheat -t homelab    # list all cheatsheets tagged "homelab"
cheat -s <keyword>  # search across all cheatsheets

Use the cgit bash function to sync with the remote repo from any directory:

cgit pull    # pull latest changes
cgit push    # push committed changes
cgit status  # check repo status

🔗 Source

Source code and full documentation is available on GitHub.