cheat-fzf

Browse UNIX/Linux Command Cheatsheets from cht.sh|cheat.sh using fzf

---

Table of Contents

Click to expand table of contents

---

• cheat-fzf

• Table of Contents

• Overview

  • Description

• Installation

  • Dependencies
  • Setup

• Usage

• Other

  • Contributing

  ---

  (back to top)

Overview

Description

Browse UNIX/Linux Command Cheatsheets from cht.sh|cheat.sh using fzf

Installation

Dependencies

• fzf
• curl

Make fzf is installed as it is the meat and potatoes of this script.

Setup

1. Clone this repository

git clone https://github.com/ConnerWill/cheat-fzf.git

2. To source this script, add the line below to your .zshrc|.bashrc|etc... Replace the example path to the location of cheat-fzf

zsh

  [[ -f "${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh" ]] && source "${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh"

(back to top)

Usage

Once cht-fzf is sourced, you can start it by running either cheat-fzf, cht-fzf, or chtfzf

chtfzf

cht-fzf

cheat-fzf

---

If the script is run without a search query, and it will display the main screen of cht.sh.

Running the command with a search query is will open the cheetsheet for that query.

Running the command with 'special flags' will display those pages

---

Example of running cht-fzf with the search query of 'fzf' will open available cheetsheets for 'fzf'.

chtfzf fzf

Example of running cht-fzf with the search query of ':list' will open all of the available cheetsheets in fzf. (personal favorite)

chtfzf :list

---

List of some of the available 'special pages' in cht.sh Visit cht.sh for more information.

    Special pages:

        :help               this page
        :list               list all cheat sheets
        :post               how to post new cheat sheet
        :cht.sh             shell client (cht.sh)
        :bash_completion    bash function for tab completion
        :styles             list of color styles
        :styles-demo        show color styles usage examples
        :random             fetches a random cheat sheet

I suggest reading the fzf and cheat.sh documentation if you would like more information about those programs specifically

(back to top)

Other

Contributing

Click to expand contributing section

---

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

fzf

cheat.sh

cht.sh

(back to top)