.chst

What .chst is?

PDF or HTML cheatsheets are not very usable and if you don't have a lot of spare slots in your memory (as me :) ) you most probably need interactive easly searchable cheatsheets.

programmable & automated cheatsheets/cheatfiles actions model defintion that can used be both for key combinations or typing

What .chst is not?

man replacemnt
advanced documentation format

What .chst repository exists or why it's not part of .chst browser ?

Sometimes it's good to reinvent the wheel.. , but maybe not this time.

If you feel that something could be done better contribute first!

If you have some personal magic (credentials etc) put ityour personal .chst files .pchst.

.chst how to use:

(Step 1) It is recomended to clone ( or fork and then clone if you plan to have some own customization) this repo into your ~/ directory, or maintain as part of your dotfiles.

.chst browser should search for cheatsheets/cheatfiles in ~/.pchst & ~/.chst direcotries, and should prioritize the files from ~/.pchst - personal chst, the one you may want to maintain sepretly.

(Step 2) It is recomended to use one of .chst browsers:

rchst launcher style browser - just a tiny rofi extension Planned:
fchst console style browser - just tiny command line fzf extension
dchst launcher style browser - just a tiny dmenu extension

.chst about itself:

As simple as possible, text based cheatsheets are the fundamenetal building block of final solution.

Key priciples:

Single line & simple command
Single line, simple & easy searchable intuitive description

This is not inteded to be few-lines per command, or documentation style formart.

.chst format/model was orginaly designed mainly for rofi - a window switcher & application launcher, simply more advanced dmenu - and its extension rchst.

Format is more or less generic and can be used by any type of software that will be able to cosume it as a source of commands or key combinanations cheatsheets.

.chst alternatives

Documenenation helepers:

man
zeal

File format and its versions

I didn't use .chst extesion in filenames as I beleve this will be redundant information (I'm open for comments) .

File format version	Format Defintion
`0.0.1`	`Category =\|= Subcategory =\|= Command =\|= Description =\|= Action Type`

Command special tags: It is possible to use user-input required tag, in command pacman -Qs [$pkg] where [$...] is special tag and pkg is the name/tile of the user input.

In this case chst browser could ask user for input before firing the command.

.chst contract for browsers

Possible on roadmap:

Special character e.g. $ that could be used for placeholder for user input (need to verify if it makes sense on daily basis rutine)
Action type run for running application (need to verify if it makes sense on daily basis rutine)
Utilities script - e.g. to clenaup tabulation

Command & Action Type

How Comamnd are interpreted depends on Action Type

Currently there are two actions types:

key - inform .chst browser that command should be executed as key press
type- inform .chst browser that command should be executed just by regular letter typing (e.g. in previously focued window/console)
input+key - inform .chst browser that command should be executed as key press, but before that browser should ask user for input parameters defined in command
input+type - inform .chst browser that command should be executed just by regular letter typing, but before that browser should ask user for input parameters defined in command

If the key action type is used, command should contains key combination that is based on the X Keysym strings e.g.

Super_l+n

If the type action type is used, command can conatins any text e.g.

git status

Current list of .chst

pacman - Pacman most usefull commands set
git - Git most usefull commands set
xmonad - Xmonad all the default key bindings

Examples of .chst

type command example (git - version controll system):

git =|= basics =|= git init                                 =|= Initialize a repository                               =|= type
git =|= basics =|= git status                               =|= Show status of working tree                           =|= type
git =|= basics =|= git add [$file]                           =|= Start tracking [file]                                  =|= input+type
git =|= basics =|= git add [$file]                           =|= Stage modified [file]                                   =|= input+type
git =|= basics =|= git diff                                  =|= Show what's changed but not yet stagedt               =|= type
git =|= basics =|= git commit                               =|= Commit changest                                       =|= type
git =|= basics =|= git commit -a                            =|= Stage files and committ                                =|= type
git =|= basics =|= git mv [$fiele1] [$file2]                  =|= Rename [fiele1] to [file2]                              =|= input+type
git =|= basics =|= git fetch [$br]                          =|= Pull data from remote [br] without merging            =|= input+type
git =|= basics =|= git pull origin [$br]                    =|= Fetch and merge branch [$br] from origin              =|= input+type
git =|= basics =|= git clone [$url]                         =|= Create local copy of remote repository at [$url]      =|= input+type

key command example (xmonad - tiling windows manager):

xmonad =|= actions      =|= Super_L+q                       =|= Restart XMonad                         =|= key
xmonad =|= actions      =|= Super_L+shift+q                 =|= Quit XMonad                            =|= key
xmonad =|= launchers    =|= Super_L+shift+Enter             =|= Launch Terminal                        =|= key
xmonad =|= launchers    =|= Super_L+p                       =|= Launch demnu                           =|= key
xmonad =|= launchers    =|= Super_L+shift+p                 =|= Launch gmrun                           =|= key

hicolour/.chst