zsh-cheat

zsh-cheat plugin for zsh.

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

• zsh-core
• gomplate
• python
• taskfile

Installation

oh-my-zsh users

If you're using oh-my-zsh, install this plugin by doing the following:

1. Go to your oh-my-zsh custom plugins directory -cd ~/.oh-my-zsh/custom/plugins
2. Clone the plugin bash git clone https://github.com/hadenlabs/zsh-cheatbash
3. Edit your .zshrc and add plugins=( ... zsh-cheat ) to your list of plugins
4. Open a new terminal and enjoy!

antigen users

If you're using Antigen, install this plugin by doing the following:

1. Add antigen bundle hadenlabs/zsh-cheat to your .zshrc where you're adding your other plugins.
2. Either open a new terminal to force zsh to load the new plugin, or run antigen bundle hadenlabs/zsh-cheat in a running zsh session.
3. Enjoy!

antibody users

If you're using Antibody, install this plugin by doing the following:

1. Add :

antibody bundle hadenlabs/zsh-cheat

to your .zshrc where you're adding your other plugins.

2. Either open a new terminal to force zsh to load the new plugin, or run antibody bundle hadenlabs/zsh-cheat in a running zsh session.
3. Enjoy!

Usage

🚀 How to use this project

task setup

Examples

Common

Install Dependencies

task setup

Functions

zsh cheat includes a small utility cheat to fetch and install new packages.

cheat::install

Install cheat.

cheat::post_install

Install sync config and cheatsheets.

cheat::cheatsheets::install

Install all cheatsheet to path cheat.

cheat::sync

sync config cheatsheet to local.

fcheat

search cheat using fzf.

Help

Got a question?

File a GitHub issue.

Contributing

See Contributing.

Module Versioning

This Module follows the principles of Semantic Versioning (SemVer).

Using the given version number of MAJOR.MINOR.PATCH, we apply the following constructs:

1. Use the MAJOR version for incompatible changes.
2. Use the MINOR version when adding functionality in a backwards compatible manner.
3. Use the PATCH version when introducing backwards compatible bug fixes.

Backwards compatibility in 0.0.z and 0.y.z version

• In the context of initial development, backwards compatibility in versions 0.0.z is not guaranteed when z is increased. (Initial development)
• In the context of pre-release, backwards compatibility in versions 0.y.z is not guaranteed when y is increased. (Pre-release)

Copyright

Copyright © 2018-2025 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

License

The code and styles are licensed under the LGPL-3.0 license See project license..

Don't forget to 🌟 Star 🌟 the repo if you like zsh-cheat

Your feedback is appreciated