aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortwells46 <173561638+twells46@users.noreply.github.com>2026-04-01 15:54:58 -0500
committertwells46 <173561638+twells46@users.noreply.github.com>2026-04-01 15:54:58 -0500
commitdb1c2b8ce214bc555b8aa21114c6614e9071bf34 (patch)
treef01d5c945d90472226d280be205d9cfc4a64faad /README.md
parent1e72f44f28b97ef3f28627421bedca379d136a76 (diff)
Add simple shell executable
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/README.md b/README.md
index 65f5a36..c611a0a 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,13 @@ Then run a query like this:
python query_index.py "get free disk space"
```
+Or install the wrapper script and use `cheat` from anywhere:
+
+```sh
+ln -sf "$PWD/bin/cheat" ~/.local/bin/cheat
+cheat "get free disk space"
+```
+
To add commands, add to `./cards.jsonl` and rebuild the index:
```sh
@@ -36,19 +43,19 @@ python query_index.py --serve
Then keep using the same query command:
```sh
-python query_index.py "get free disk space"
+cheat "get free disk space"
```
To run the server in the background:
```sh
-nohup python query_index.py --serve >/tmp/cheat.log 2>&1 &
+nohup cheat --serve >/tmp/cheat.log 2>&1 &
```
Useful controls:
```sh
-python query_index.py --status
-python query_index.py --reload
-python query_index.py --stop
+cheat --status
+cheat --reload
+cheat --stop
```