agresdominik/cheat_sheet
1
0
Fork 0
mirror of https://github.com/agresdominik/cheat_sheet.git synced 2026-04-21 18:05:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
Dominik
2025-12-11 16:16:25 +01:00
parent 5bb45ca959
commit c6f677b169
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -2
View File
@@ -1,2 +1,15 @@
# cheat_sheet
A man-style cli cheatsheet tool for commands I use and forget a lot
# Cheat Sheet
A small TUI Tool which displays a pre-configured json file content in a menu and lets the user search for commands and select them. Once selected these are printed in the terminal for easy access.
I wrote this to simplify my search for commands I use often enough to need them multiple times but not often enoigh to remember alway exactly how they are called.
Written in go + used bubbletea for the TUI part of the application.
## Usage
Use the commands in the given makefile to run, build, test in a docker container or install the application on your device. Beforehand define your own commands.json based on the `commands_template.json` in the `data/` folder.
Once installed just run `cheatsh` in the terminal. If it's not found, make sure `~/.local/bin/` is in your `PATH` or change the path under the `PREFIX` variable in the `Makefile`.