aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 31 insertions, 5 deletions
diff --git a/README.md b/README.md
index 534001e..65f5a36 100644
--- a/README.md
+++ b/README.md
@@ -7,22 +7,48 @@ Local command-helper retrieval system using JSONL, SQLite, and sentence-transfor
```sh
export HF_HOME="$PWD/models/hf"
export SENTENCE_TRANSFORMERS_HOME="$PWD/models/hf"
-python -m venv venv
+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
+python init_db.py
+python build_index.py
```
Then run a query like this:
```sh
-python scripts/query_index.py "get free disk space"
+python query_index.py "get free disk space"
```
To add commands, add to `./cards.jsonl` and rebuild the index:
```sh
-python scripts/build_index.py
+python build_index.py
+```
+
+For fast repeated queries, start the Unix-socket server once in another terminal:
+
+```sh
+python query_index.py --serve
+```
+
+Then keep using the same query command:
+
+```sh
+python query_index.py "get free disk space"
+```
+
+To run the server in the background:
+
+```sh
+nohup python query_index.py --serve >/tmp/cheat.log 2>&1 &
+```
+
+Useful controls:
+
+```sh
+python query_index.py --status
+python query_index.py --reload
+python query_index.py --stop
```