rchst

Dependency

xdotool

Status Not yeat released but functional & usable

Things to to:

reduce no rofi customization properties
release official pkg - aur/deb

What rchst is?

browser & launcher for programmable & automated cheatsheets/cheatfiles - .chst actions model defintion that can used be both for key combinations or typing

What rchst is not?

man replacemnt
advanced documentation format browser like zeal

rchst how to use:

Manual

ARCH

rchst about itself:

PDF or HTML cheatsheets are not very usable and therfe is strong need for interactive easly searchable cheatsheets. 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.

rchst alternatives

.chst browsers & launchers: Planned:

dchst launcher style browser - just a tiny dmenu extension
fchst console style browser - just tiny command line fzf extension

Documenenation helepers:

man
zeal

Supported .chst file format and its versions

Currently rchst supports first draft version of .chst file format:

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

Command & Action Type

How Comamnd are interpreted depends on Action Type

Currently there are four action 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

Currently rchst does not yet support providing input values

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

Roadmap

Create/Update/Delete actions
Support for inputs gathering