You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-24Lines changed: 7 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,30 +138,7 @@ bun run sandbox:stop
138
138
139
139
For the full architecture and security philosophy behind the sandbox, see [`sandbox/README.md`](sandbox/README.md).
140
140
141
-
### Step 2: Setup the search sandbox (Optional, required for /search)
142
-
143
-
The `/search` command uses an agentic search pipeline that depends on two local Docker containers: a **SearXNG** meta-search engine and a **Trafilatura** reader. This setup ensures that your search queries and the content you read remain entirely local.
144
-
145
-
**Prerequisite:**[Docker Desktop](https://www.docker.com/get-started) must be running.
Without this service running, the `/search` command will be disabled in the chat, but all other features will remain available.
161
-
162
-
For more details on the agentic search pipeline, see [docs/agentic-search.md](docs/agentic-search.md).
163
-
164
-
### Step 3: Install Thuki
141
+
### Step 2: Install Thuki
165
142
166
143
#### Download (Recommended)
167
144
@@ -197,6 +174,12 @@ bun run dev
197
174
198
175
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full development setup guide.
199
176
177
+
### Optional: Enable `/search`
178
+
179
+
The `/search` command runs a fully local agentic search pipeline backed by two Docker services (SearXNG + a Trafilatura reader). It is **not bundled with the `.dmg`**: enabling it currently requires cloning this repository to run the local services. Every other Thuki feature works without it. First-class, out-of-box `/search` support is on the roadmap.
180
+
181
+
See [docs/agentic-search.md#setup](docs/agentic-search.md#setup) for the setup steps.
Copy file name to clipboardExpand all lines: docs/agentic-search.md
+37Lines changed: 37 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,43 @@ A deep dive into Thuki's agentic RAG search pipeline: how retrieval-augmented ge
4
4
5
5
---
6
6
7
+
## Setup
8
+
9
+
> **Roadmap:** First-class, out-of-box `/search` support (bundled native sidecars or pre-built container images shipped with the app) is planned. Today, enabling `/search` requires cloning this repository to run the local Docker services described below. Track progress and contribute in the project's [GitHub issues](https://github.com/quiet-node/thuki/issues).
10
+
11
+
The `/search` command depends on two local Docker containers: a **SearXNG** meta-search engine and a **Trafilatura** reader. Both run on `127.0.0.1` only, so every query and every fetched page stays on your machine.
12
+
13
+
**Prerequisites**
14
+
15
+
-[Docker Desktop](https://www.docker.com/get-started) installed and running.
16
+
-[Bun](https://bun.sh) installed (used to launch the Compose stack).
Copy file name to clipboardExpand all lines: docs/commands.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ Runs agentic web search and answers from live sources with citations.
30
30
31
31
**Behavior:** Routes the message through Thuki's local search pipeline instead of plain chat. Answers are grounded in retrieved web sources and typically include inline citations plus a Sources footer.
32
32
33
-
**Limit:** Requires the search sandbox to be running. Use it for current, changing, or cutoff-sensitive information.
33
+
**Limit:** Requires the search sandbox to be running. See [agentic-search.md#setup](agentic-search.md#setup) for setup steps. Use it for current, changing, or cutoff-sensitive information.
"Routes the message through Thuki's local search pipeline instead of plain chat. Answers are grounded in retrieved web sources and typically include inline citations plus a Sources footer.",
71
71
limit:
72
-
'Requires the search sandbox to be running. Use it for current, changing, or cutoff-sensitive information.',
72
+
'Requires the search sandbox to be running. See [agentic-search.md#setup](agentic-search.md#setup) for setup steps. Use it for current, changing, or cutoff-sensitive information.',
73
73
},
74
74
promptHelp: {
75
75
summary: 'agentic web search for current or cutoff-sensitive questions.',
0 commit comments