summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 273fb83..20a0bb4 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@ Post `$NVDA` or `$AAPL is mooning` in any stream and slopbot replies with the cu
```bash
pip install -r requirements.txt
cp .zuliprc.example .zuliprc
+cp .env.example .env
# edit .zuliprc with your bot credentials
+# edit .env with agent/provider settings if needed
python main.py
```
@@ -22,6 +24,10 @@ Get your `.zuliprc` from Zulip: Settings → Bots → your bot → download conf
- `main.py` — single-file bot, raw `zulip` event loop (no framework)
- `fetch_price(ticker)` — isolated data layer, easy to swap yfinance for a real API
- `ask_agent(msg, content)` — runs the Rust `agent` binary once per mention
+- `prompts/system.md` — bot persona, research workflow, and response behavior
+- `slop-search QUERY` — Kagi search helper available to the agent shell
+- `slop-fetch URL` — trafilatura page extraction helper available to the agent shell
+- `.env.example` — operational defaults, including `KAGI_API_KEY`
- Regex: `\$([A-Z]{1,5})` — matches 1-5 uppercase letters after `$`
- Deduplicates tickers per message, replies in-place (same stream + topic)
- `flake.nix` — packages slopbot with `agent` from `/home/ben/src/bsima/agentd` as a Nix input