aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9127aaf..7c7374f 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,9 @@ A local text assistant daemon. Questions arrive on a Unix socket, the
model already loaded in a local llama-server answers, calling read-only
tools when a question needs them, and the reply streams back token by
token. Every conversation is kept in a local SQLite history with
-full-text search. The model and the history stay on the machine; only
-tools you enable (weather, web search) reach the network.
+full-text search. The history stays on the machine. So does the model, unless a chat is
+switched to a cloud model you configured; only tools you enable (weather,
+web search) reach the network otherwise.
The front end is the assistant canvas of the quickshell desktop
(`desktop/assistant/` in the quickshell repo, on SUPER+Home). Anything
@@ -110,6 +111,11 @@ cp -r examples/tools ~/.config/desktop-assistant/
- `config.toml`: every key is optional, the example lists the defaults.
`[env]` is added to every tool's environment; put instance URLs and
key file paths there.
+- `[[cloud]]` in `config.toml`: providers with an OpenAI-compatible API,
+ each with a `key_cmd` that prints its key (see the example). A chat
+ picks a model in the canvas header; a cloud chat is sent its history,
+ attachments and the results of the tools marked `cloud = true`, and
+ nothing from the others. Voice is always transcribed locally.
- `tools/<name>.toml`: one tool each, enabled by being there. A tool is a
command run without a shell, its stdout goes back to the model:
@@ -117,6 +123,7 @@ cp -r examples/tools ~/.config/desktop-assistant/
description = "What the tool does, for the model"
command = ["script.sh", "{param}"] # looked up in tools/ first, then PATH
timeout = 10
+cloud = false # true: also offered to cloud models
[params.param]
type = "string"