Skip to content

docs: Improve Claude Code SKILL documentation (Issue #33) #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NTLx wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Improve Claude Code SKILL documentation (Issue #33) #44

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b95f88a
perf: Optimize TTS pool using deadpool (Issue #32)
NTLx Jan 31, 2026
c766aed
docs: Improve Claude Code SKILL documentation (Issue #33)
NTLx Jan 31, 2026
8493317
chore: revert accidental code changes, keep docs only
NTLx Jan 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,26 @@ Configure WiFi and server
**Chat:** press the `K0` button once or multiple times until the status bar shows "Ready". You can now speak and it will show "Listening ...". The device answers after it decides that you have done speaking.

**Config:** press `RST`. While it is restarting, press and hold `K0` to enter the configuration mode. Then [open the configuration UI](https://echokit.dev/setup/) to connect to the device via BT.

## 🤖 AI-Powered Development with Claude Code

EchoKit Server includes specialized **SKILLs** for [Claude Code](https://claude.ai/code) to automate configuration and environment setup.

### 1. Install SKILLs
Link the project's local skills to your Claude Code environment:

```bash
mkdir -p ~/.claude/skills/
ln -s $(pwd)/.claude/skills/echokit-config-generator ~/.claude/skills/
```

### 2. Available Slash Commands
Once installed, you can use the following commands within Claude Code:

* **/setup-echokit**: Interactive five-phase guide to generate a complete `config.toml`. It handles assistant definitions, platform selection (OpenAI, Groq, etc.), and server launch.
* **/sync-seekdb**: (If using SeekDB) Automatically generates `config.toml` tailored for SeekDB/OceanBase vector storage and verifies connectivity.
Copy link
Member

@alabulei1 alabulei1 Jan 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't see you changed the SKILL.md. Did you miss something?


### 3. Benefits
* **Zero-Config Setup**: Automatically detects available API endpoints and generates the correct TOML structure.
* **Context-Aware**: The generator can create sophisticated system prompts based on your specific use case.
* **Validation**: Built-in health checks ensure your API keys and server address are correct before finishing.