Skip to content

Commit ec6e368

Browse files
authored
docs: refresh README and configurations for shipped features (#124)
Signed-off-by: Logan Nguyen <lg.131.dev@gmail.com>
1 parent 81f133e commit ec6e368

2 files changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,13 @@ Most AI tools require accounts, API keys, or subscriptions that bill you per tok
7171
- **Isolated sandbox:** optionally run models in a hardened Docker container with capability dropping, read-only volumes, and localhost-only networking
7272
- **Image input:** paste or drag images and screenshots directly into the chat
7373
- **Screen capture:** type `/screen` to instantly capture your entire screen and attach it to your question as context
74+
- **Agentic search:** type `/search` to run a fully local, multi-step search pipeline (SearXNG + Trafilatura reader) with a live trace of every query, fetch, and judgement step
7475
- **Slash commands:** built-in commands for live search and prompt shortcuts: `/search`, `/translate`, `/rewrite`, `/tldr`, `/refine`, `/bullets`, `/todos`. Highlight text anywhere, summon Thuki, type a command, and hit Enter
7576
- **Extended reasoning:** type `/think` to have the model reason through a problem step by step before answering
77+
- **In-app model picker:** browse the models installed in your local Ollama and switch the active model from the ask bar without ever opening a config file
78+
- **Cross-model continuity:** swap models mid-conversation and Thuki sanitizes history and filters capabilities (vision, thinking) to whatever the new model supports
79+
- **Settings panel:** a four-tab native window (⌘,) for inference, prompt, window, and search settings, including a log-scale context-window slider and a tunable image-attachment cap (up to 20)
80+
- **Contextual tip bar:** lightweight in-overlay hints surface the right shortcut or command at the right moment
7681
- **Privacy-first:** zero-trust architecture, all data stays on your device
7782

7883
## Getting Started
@@ -160,7 +165,7 @@ The `/search` command uses an agentic search pipeline that depends on two local
160165

161166
#### Download (Recommended)
162167

163-
1. Download `Thuki.dmg` from the [latest release](https://github.com/quiet-node/thuki/releases/latest)
168+
1. Download `Thuki.dmg` from the [latest stable release](https://github.com/quiet-node/thuki/releases/latest), or grab the bleeding-edge build from the [`nightly`](https://github.com/quiet-node/thuki/releases/tag/nightly) channel which is rebuilt automatically from `main`.
164169
2. Double-click `Thuki.dmg` to open it. A window appears showing the Thuki app icon next to an Applications folder shortcut.
165170
3. Drag `Thuki` onto the `Applications` folder shortcut.
166171
4. Eject the disk image (drag it to Trash in the Finder sidebar, or right-click and choose Eject).
@@ -217,9 +222,11 @@ The app starts hidden. The hotkey or tray menu shows it. The window close button
217222

218223
## Configuration
219224

220-
See [docs/configurations.md](docs/configurations.md) for the full configuration reference (quote display limits and system prompt).
225+
Thuki reads a single typed TOML file at `~/Library/Application Support/com.quietnode.thuki/config.toml`, seeded with sensible defaults on first launch. The in-app Settings panel (⌘,) writes to the same file, so you can edit by hand or click through tabs, whichever you prefer.
221226

222-
See [docs/commands.md](docs/commands.md) for the full slash command reference.
227+
See [docs/configurations.md](docs/configurations.md) for the full schema covering the `[inference]`, `[prompt]`, `[window]`, `[quote]`, and `[search]` sections (Ollama URL, system prompt, context window, image cap, agentic-search timeouts, and more).
228+
229+
See [docs/commands.md](docs/commands.md) for the full slash command reference, and [docs/tuning-context-window.md](docs/tuning-context-window.md) for guidance on picking a `num_ctx` value.
223230

224231
## Contributing
225232

@@ -247,15 +254,13 @@ Thuki is just getting started. Here's where it's headed:
247254

248255
The big leap: from answering questions to taking action.
249256

250-
- **Internet search:** let Thuki look things up in real time, not just reason from its training data
251257
- **Tool integrations via [MCP](https://modelcontextprotocol.io/):** connect Thuki to Gmail, Slack, Discord, Google Calendar, and any other MCP-compatible service; ask it to draft a reply, summarize a thread, or schedule a meeting without ever leaving your current app
252-
- **More slash commands:** `/screen`, `/think`, `/translate`, `/rewrite`, `/tldr`, `/refine`, `/bullets`, and `/todos` are live. More domain-specific commands are on the way
258+
- **More slash commands:** more domain-specific commands on top of the existing `/search`, `/screen`, `/think`, `/translate`, `/rewrite`, `/tldr`, `/refine`, `/bullets`, and `/todos`
253259

254260
### Better AI Control
255261

256262
More flexibility over the model powering Thuki.
257263

258-
- **Native settings panel (⌘,):** a proper macOS preferences window to configure your model, Ollama endpoint, activation shortcut, slash commands, and system prompt. No config files needed.
259264
- **Multiple provider support:** opt in to OpenAI, Anthropic, or any OpenAI-compatible endpoint as an alternative to local Ollama
260265
- **Custom activation shortcut:** change the double-tap trigger to any key or combo you prefer
261266

docs/configurations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Thuki reads its runtime configuration from a single TOML file located at:
66
~/Library/Application Support/com.quietnode.thuki/config.toml
77
```
88

9-
The file is created automatically the first time the app launches. You can edit it with any text editor; changes take effect on the next launch. A future Settings panel will let you make the same changes from inside the app, writing to the same file.
9+
The file is created automatically the first time the app launches. You can edit it with any text editor; changes take effect on the next launch. The in-app Settings panel (⌘,) writes to this same file, so editing by hand and clicking through the panel are interchangeable.
1010

1111
## First launch
1212

0 commit comments

Comments
 (0)