tomi/Toak
1
0
Fork 0
Code Activity

feat: Add dynamic JSON skill management via toak skill command and introduce an uninstallation script.

Browse Source
This commit is contained in:
Tomi Eckert
2026-02-28 13:52:31 +01:00
parent 7b144aedd7
commit ab48bdabcc
2 changed files with 32 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -42,6 +42,11 @@ The script will:
3. Install **Zsh completions** to `/usr/share/zsh/site-functions/`.
4. Install and enable the `toak.service` systemd user service so the background daemon runs automatically.
To remove Toak from your system, simply run:
```bash
./uninstall.sh
```
---
## 🎮 Usage
@@ -54,6 +59,7 @@ The script will:
- **`toak latency-test`**: Benchmarks your network and API latency to ensure optimal performance.
- **`toak show`**: Displays your current configuration in a clean table.
- **`toak config <key> <value>`**: Quickly update a specific setting (e.g., `toak config whisper whisper-large-v3-turbo`).
- **`toak skill`**: Manage dynamic JSON skills via `list`, `add`, or `remove` subcommands.
### Flags
@@ -65,14 +71,27 @@ The script will:
## 🤖 Skills System
Toak includes a modular skills system triggered by saying the **"System"** hotword at the start of your dictation.
Toak includes a robust, data-driven skills system triggered by saying hotwords (like **"System"**) at the start of your dictation. Skills are defined as simple JSON files entirely configurable without modifying the C# codebase.
| Skill | Hotwords | Description |
| :--- | :--- | :--- |
| **Terminal** | "System terminal", "System run" | Executes the spoken command in your shell. |
| **Translate** | "System translate to [language]" | Translates your dictation into the target language. |
| **Professional**| "System professional", "System formalize" | Rewrites your text to be articulate and formal. |
| **Summary** | "System summary", "System concise" | Strips fluff and provides a direct, crisp summary. |
At runtime, skills are loaded from `~/.config/toak/skills/`.
### Default Skills
| Skill | Hotwords | Description | Type |
| :--- | :--- | :--- | :--- |
| **Terminal** | "System terminal", "System run" | Passes the command to `terminal_action.sh` to execute the spoken shell command. | `script` |
| **Translate** | "System translate to [language]" | Translates your dictation into the target language. | `type` |
| **Professional**| "System professional", "System formalize" | Rewrites your text to be articulate and formal. | `type` |
| **Summary** | "System summary", "System concise" | Strips fluff and provides a direct, crisp summary. | `type` |
### Customizing & Adding Skills
You can build infinite capabilities using the CLI wizard:
```bash
toak skill add
```
This generates a JSON file in `~/.config/toak/skills/`. Skills support two actions:
1. **`type` Action**: Transforms the dictated text via a custom System Prompt and types it into the active window (or pipes/copies if flags are requested).
2. **`script` Action**: Transforms the text and passes the result as `$1` to a local shell script, allowing Toak to control system functions, APIs, or smart home devices completely autonomously.
---