Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ConnerWill/cheat-fzf
Browse UNIX/Linux Command Cheatsheets from cht.sh/cheat.sh using fzf
https://github.com/ConnerWill/cheat-fzf
cheat-sh cheatsheet cheatsheet-fzf cht fzf
Last synced: 3 months ago
JSON representation
Browse UNIX/Linux Command Cheatsheets from cht.sh/cheat.sh using fzf
- Host: GitHub
- URL: https://github.com/ConnerWill/cheat-fzf
- Owner: ConnerWill
- License: gpl-3.0
- Created: 2022-02-14T13:00:44.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-15T07:14:02.000Z (over 2 years ago)
- Last Synced: 2024-08-02T13:34:54.670Z (7 months ago)
- Topics: cheat-sh, cheatsheet, cheatsheet-fzf, cht, fzf
- Language: Shell
- Homepage: https://cheat.sh/
- Size: 7.05 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### **cheat-fzf**
> *Browse UNIX/Linux Command Cheatsheets from [cht.sh](https://cht.sh)|[cheat.sh](https://cheat.sh) using [fzf](https://github.com/junegunn/fzf)*
[](https://gitlab.com/ConnerWill/cheat-fzf)
---
# Table of Contents
Click to expand table of contents
---
* [cheat-fzf](https://github.com/ConnerWill/cheat-fzf)
* [Table of Contents](#table-of-contents)
* [Overview](#overview)
* [Description](#description)
* [Installation](#installation)
* [Dependencies](#dependencies)
* [Setup](#setup)
* [Usage](#usage)
* [Other](#other)
* [Contributing](#contributing)
---
# Overview
## Description
**Browse UNIX/Linux Command Cheatsheets from [cht.sh](https://cht.sh)|[cheat.sh](https://cheat.sh) using [fzf](https://github.com/junegunn/fzf)**
# Installation
## Dependencies
* **fzf**
* **curl**
*Make [fzf](https://github.com/junegunn/fzf) is installed as it is the meat and potatoes of this script.*
## Setup
1. *Clone* this repository
```gitattributes
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
```zsh
[[ -f "${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh" ]] && source "${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh"
```
# Usage
Once cht-fzf is sourced, you can start it by running either `cheat-fzf`, `cht-fzf`, or `chtfzf`
```shell-script
chtfzf
```
```shell-script
cht-fzf
```
```shell-script
cheat-fzf
```
---
If the script is run without a search query, and it will display the main screen of [cht.sh](https://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'*.
```shell-script
chtfzf fzf
```
> Example of running *`cht-fzf`* with the search query of '*`:list`*' will open all of the available cheetsheets in fzf. *(personal favorite)*
```shell-script
chtfzf :list
```
---
List of some of the available '*special pages*' in `cht.sh`
Visit [cht.sh](https://cht.sh/:help) for more information.
```yml
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`](https://github.com/junegunn/fzf) and [`cheat.sh`](https://github.com/chubin/cheat.sh) documentation if you would like more information about those programs specifically*
# 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](https://github.com/junegunn/fzf)
[cheat.sh](https://github.com/chubin/cheat.sh)
[cht.sh](https://cht.sh)