{"id":13683117,"url":"https://github.com/ConnerWill/cheat-fzf","last_synced_at":"2025-04-30T12:33:30.713Z","repository":{"id":156419592,"uuid":"459163898","full_name":"ConnerWill/cheat-fzf","owner":"ConnerWill","description":"Browse UNIX/Linux Command Cheatsheets from cht.sh/cheat.sh using fzf","archived":false,"fork":false,"pushed_at":"2022-08-15T07:14:02.000Z","size":7391,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-02T13:34:54.670Z","etag":null,"topics":["cheat-sh","cheatsheet","cheatsheet-fzf","cht","fzf"],"latest_commit_sha":null,"homepage":"https://cheat.sh/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ConnerWill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-02-14T13:00:44.000Z","updated_at":"2024-03-28T12:48:29.000Z","dependencies_parsed_at":"2024-01-14T16:20:02.922Z","dependency_job_id":null,"html_url":"https://github.com/ConnerWill/cheat-fzf","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConnerWill%2Fcheat-fzf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConnerWill%2Fcheat-fzf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConnerWill%2Fcheat-fzf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConnerWill%2Fcheat-fzf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ConnerWill","download_url":"https://codeload.github.com/ConnerWill/cheat-fzf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224212013,"owners_count":17274347,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cheat-sh","cheatsheet","cheatsheet-fzf","cht","fzf"],"created_at":"2024-08-02T13:02:01.051Z","updated_at":"2024-11-12T03:30:28.130Z","avatar_url":"https://github.com/ConnerWill.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\r\n\u003c!---\r\n\u003cimg width=\"480\" height=\"320\" src=\"/media/cht-fzf-banner.png\"\u003e\r\n---\u003e\r\n\r\n### **cheat-fzf**\r\n\u003e *Browse UNIX/Linux Command Cheatsheets from [cht.sh](https://cht.sh)|[cheat.sh](https://cheat.sh) using [fzf](https://github.com/junegunn/fzf)*\r\n\r\n![GitHub last commit](https://img.shields.io/github/last-commit/ConnerWill/cheat-fzf)\r\n![GitHub issues](https://img.shields.io/github/issues-raw/ConnerWill/cheat-fzf)\r\n![GitHub repo size](https://img.shields.io/github/repo-size/ConnerWill/cheat-fzf)\r\n[![GitLab](https://img.shields.io/static/v1?label=gitlab\u0026logo=gitlab\u0026color=E24329\u0026message=mirrored)](https://gitlab.com/ConnerWill/cheat-fzf)\r\n![GitHub](https://img.shields.io/github/license/ConnerWill/cheat-fzf)\r\n![GitHub Repo stars](https://img.shields.io/github/stars/ConnerWill/cheat-fzf?style=social)\r\n\r\n\u003c/div\u003e\r\n\r\n---\r\n\r\n# Table of Contents\r\n\u003cdetails\u003e\r\n    \u003csummary\u003eClick to expand table of contents\u003c/summary\u003e\r\n\r\n  ---\r\n\r\n* [\u003cstrong\u003echeat-fzf\u003c/strong\u003e](https://github.com/ConnerWill/cheat-fzf)\r\n* [Table of Contents](#table-of-contents)\r\n* [Overview](#overview)\r\n   * [Description](#description)\r\n* [Installation](#installation)\r\n   * [Dependencies](#dependencies)\r\n   * [Setup](#setup)\r\n* [Usage](#usage)\r\n* [Other](#other)\r\n   * [Contributing](#contributing)\r\n\r\n  ---\r\n\r\n  \u003cp align=right\u003e(\u003ca href=#top\u003eback to top\u003c/a\u003e)\u003c/p\u003e\r\n\u003c/details\u003e\r\n\r\n\r\n# Overview\r\n## Description\r\n\r\n**Browse UNIX/Linux Command Cheatsheets from [cht.sh](https://cht.sh)|[cheat.sh](https://cheat.sh) using [fzf](https://github.com/junegunn/fzf)**\r\n\r\n\r\n\u003c!---\r\n## Demo\r\n\r\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\r\n---\u003e\r\n\r\n# Installation\r\n## Dependencies\r\n\r\n*   **fzf**\r\n*   **curl**\r\n\r\n*Make [fzf](https://github.com/junegunn/fzf) is installed as it is the meat and potatoes of this script.*\r\n\r\n## Setup\r\n\r\n1. *Clone* this repository\r\n\r\n  ```gitattributes\r\n  git clone https://github.com/ConnerWill/cheat-fzf.git\r\n  ```\r\n  \r\n2. To source this script, add the line below to your `.zshrc`|`.bashrc`|*etc...*\r\n*Replace the example path to the location of **cheat-fzf***\r\n\r\n\u003e   zsh\r\n  ```zsh\r\n    [[ -f \"${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh\" ]] \u0026\u0026 source \"${ZDOTDIR:-$HOME}/plugins/cheat-fzf/cht-fzf.sh\"\r\n  ```\r\n\r\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\r\n\r\n# Usage\r\n\r\nOnce cht-fzf is sourced, you can start it by running either `cheat-fzf`, `cht-fzf`, or `chtfzf`\r\n\r\n```shell-script\r\nchtfzf\r\n```\r\n```shell-script\r\ncht-fzf\r\n```\r\n```shell-script\r\ncheat-fzf\r\n```\r\n---\r\n\r\nIf the script is run without a search query, and it will display the main screen of [cht.sh](https://cht.sh).\r\n\r\nRunning the command with a search query is will open the cheetsheet for that query.\r\n\r\nRunning the command with '*special flags*' will display those pages\r\n\r\n---\r\n\r\n\u003e Example of running *`cht-fzf`* with the search query of *'fzf'* will open available cheetsheets for *'fzf'*. \r\n```shell-script\r\nchtfzf fzf\r\n```\r\n\r\n\u003e Example of running *`cht-fzf`* with the search query of '*`:list`*' will open all of the available cheetsheets in fzf. *(personal favorite)*\r\n```shell-script\r\nchtfzf :list\r\n```\r\n---\r\n\r\nList of some of the available '*special pages*' in `cht.sh`\r\nVisit [cht.sh](https://cht.sh/:help) for more information.\r\n\r\n```yml\r\n    Special pages:\r\n\r\n        :help               this page\r\n        :list               list all cheat sheets\r\n        :post               how to post new cheat sheet\r\n        :cht.sh             shell client (cht.sh)\r\n        :bash_completion    bash function for tab completion\r\n        :styles             list of color styles\r\n        :styles-demo        show color styles usage examples\r\n        :random             fetches a random cheat sheet\r\n```\r\n\r\n\u003e *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*\r\n\r\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\r\n\r\n# Other\r\n\r\n\u003c!-- CONTRIBUTING --\u003e\r\n## Contributing\r\n\r\n\u003cdetails\u003e\r\n  \u003csummary\u003eClick to expand contributing section\u003c/summary\u003e\r\n\r\n  ---\r\n\r\nAny contributions you make are **greatly appreciated**.\r\n\r\nIf 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.\r\n\r\n1. Fork the Project\r\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\r\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\r\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\r\n5. Open a Pull Request\r\n\r\n\u003c/details\u003e\r\n\r\n[fzf](https://github.com/junegunn/fzf)\r\n\r\n[cheat.sh](https://github.com/chubin/cheat.sh)\r\n\r\n[cht.sh](https://cht.sh)\r\n\r\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConnerWill%2Fcheat-fzf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FConnerWill%2Fcheat-fzf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FConnerWill%2Fcheat-fzf/lists"}