]> git.giacomolli.uk - onechat/blobdiff - README.rst
Share general review and documentation rules
[onechat] / README.rst
index bbb4475d3cc89d416bc62dbf898ca00b7bc3e8bc..3c458d64089be27b3fcf427208ccc47c13f1fcb7 100644 (file)
@@ -77,6 +77,14 @@ or Telegram:
 The session file gives full access to the account. If it leaks, remove
 the device in Linked devices on the phone.
 
+External events
+===============
+
+Use ``onechat notify --source CHECK --id EVENT --text TEXT`` to send
+external data to the root at its next turn. Add ``--agent-id ID`` to
+select a permanent child by its stable ID. Success means accepted, not
+processed. See ``onechat notify --help`` for the local test limits.
+
 User service
 ============
 
@@ -198,6 +206,13 @@ Images
    Its memory keeps what the image shows, and it can look at an older
    image again. Ask it to show an image or send one to a WhatsApp chat.
 
+Voice notes
+   The agent hears Telegram and WhatsApp voice notes through local
+   Whisper. Nix includes the small model. Outside Nix, set
+   ``voice.model`` in ``config.json`` and install ``whisper-cli``.
+   ``voice.transcriber`` selects another executable. No audio goes to a
+   transcription service.
+
 Schedules
    Ask for reminders and timed tasks, such as "every weekday at 8, tell
    me what my groups talked about". Each run uses the quota, so runs are