From 2f37974a4c84f7ffdd07e2c223eba2d8bd981b61 Mon Sep 17 00:00:00 2001
From: twells46 <173561638+twells46@users.noreply.github.com>
Date: Wed, 1 Apr 2026 15:20:50 -0500
Subject: Initial commit

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..534001e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# cheat
+
+Local command-helper retrieval system using JSONL, SQLite, and sentence-transformers.
+
+## Setup
+
+```sh
+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 scripts/init_db.py
+python scripts/build_index.py
+```
+
+Then run a query like this:
+
+```sh
+python scripts/query_index.py "get free disk space"
+```
+
+To add commands, add to `./cards.jsonl` and rebuild the index:
+
+```sh
+python scripts/build_index.py
+```
-- 
cgit v1.2.3