cheat

Local command-helper retrieval system using JSONL, SQLite, and sentence-transformers.

Setup

export HF_HOME="$PWD/models/hf"
export SENTENCE_TRANSFORMERS_HOME="$PWD/models/hf"
python -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install -r requirements.txt
python init_db.py
python build_index.py

Then run a query like this:

python query_index.py "get free disk space"

Or install the wrapper script and use cheat from anywhere:

ln -sf "$PWD/bin/cheat" ~/.local/bin/cheat
cheat "get free disk space"

To add commands, add to ./cards.jsonl and rebuild the index:

python build_index.py

For fast repeated queries, start the Unix-socket server once in another terminal:

python query_index.py --serve

Then keep using the same query command:

cheat "get free disk space"

To run the server in the background:

nohup cheat --serve >/tmp/cheat.log 2>&1 &

Useful controls:

cheat --status
cheat --reload
cheat --stop