verbalcoding 0.2.6 → 0.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +5 -0
  2. package/docs/i18n/CONFIGURATION.es.md +150 -0
  3. package/docs/i18n/CONFIGURATION.fr.md +150 -0
  4. package/docs/i18n/CONFIGURATION.ja.md +150 -0
  5. package/docs/i18n/CONFIGURATION.ko.md +49 -146
  6. package/docs/i18n/CONFIGURATION.ru.md +150 -0
  7. package/docs/i18n/CONFIGURATION.zh.md +150 -0
  8. package/docs/i18n/FRESH_INSTALL.es.md +124 -0
  9. package/docs/i18n/FRESH_INSTALL.fr.md +124 -0
  10. package/docs/i18n/FRESH_INSTALL.ja.md +124 -0
  11. package/docs/i18n/FRESH_INSTALL.ko.md +37 -114
  12. package/docs/i18n/FRESH_INSTALL.ru.md +124 -0
  13. package/docs/i18n/FRESH_INSTALL.zh.md +124 -0
  14. package/docs/i18n/MULTI_INSTANCE.es.md +121 -0
  15. package/docs/i18n/MULTI_INSTANCE.fr.md +121 -0
  16. package/docs/i18n/MULTI_INSTANCE.ja.md +121 -0
  17. package/docs/i18n/MULTI_INSTANCE.ko.md +28 -86
  18. package/docs/i18n/MULTI_INSTANCE.ru.md +121 -0
  19. package/docs/i18n/MULTI_INSTANCE.zh.md +121 -0
  20. package/docs/i18n/README.es.md +50 -86
  21. package/docs/i18n/README.fr.md +50 -86
  22. package/docs/i18n/README.ja.md +50 -86
  23. package/docs/i18n/README.ko.md +41 -113
  24. package/docs/i18n/README.ru.md +50 -86
  25. package/docs/i18n/README.zh.md +50 -86
  26. package/docs/i18n/RELEASE.es.md +58 -0
  27. package/docs/i18n/RELEASE.fr.md +58 -0
  28. package/docs/i18n/RELEASE.ja.md +58 -0
  29. package/docs/i18n/RELEASE.ko.md +36 -50
  30. package/docs/i18n/RELEASE.ru.md +58 -0
  31. package/docs/i18n/RELEASE.zh.md +58 -0
  32. package/docs/i18n/USAGE.es.md +134 -0
  33. package/docs/i18n/USAGE.fr.md +134 -0
  34. package/docs/i18n/USAGE.ja.md +134 -0
  35. package/docs/i18n/USAGE.ko.md +63 -101
  36. package/docs/i18n/USAGE.ru.md +134 -0
  37. package/docs/i18n/USAGE.zh.md +134 -0
  38. package/package.json +1 -1
@@ -1,91 +1,66 @@
1
1
  # VerbalCoding
2
2
 
3
- <p align="center">
4
- <strong>Pilotez vos agents de code CLI à la voix dans Discord, comme au téléphone.</strong>
5
- </p>
6
-
7
- <p align="center">
8
- <a href="../../README.md">English</a> ·
9
- <a href="README.ko.md">한국어</a> ·
10
- <a href="README.ja.md">日本語</a> ·
11
- <a href="README.zh.md">中文</a> ·
12
- <a href="README.es.md">Español</a> ·
13
- <a href="README.fr.md">Français</a> ·
14
- <a href="README.ru.md">Русский</a>
15
- </p>
16
-
17
- <p align="center">
18
- <img alt="Node.js" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=node.js&logoColor=white">
19
- <img alt="Discord" src="https://img.shields.io/badge/Discord-voice%20bridge-5865F2?logo=discord&logoColor=white">
20
- <img alt="STT" src="https://img.shields.io/badge/STT-whisper.cpp-7C3AED">
21
- <img alt="TTS" src="https://img.shields.io/badge/TTS-Edge%20%7C%20OpenVoice%20%7C%20Supertonic%20%7C%20SpeechSwift-0EA5E9">
22
- </p>
23
-
24
- <p align="center">
25
- <img src="../assets/figures/verbalcoding-flow.svg" alt="VerbalCoding voice-to-agent flow" width="860">
26
- </p>
3
+ **Parlez à vos agents de code en CLI via la voix Discord, comme lors d’un appel.**
4
+
5
+ [English](../../README.md) · [한국어](README.ko.md) · [日本語](README.ja.md) · [中文](README.zh.md) · [Español](README.es.md) · [Français](README.fr.md) · [Русский](README.ru.md)
6
+
7
+ ![VerbalCoding voice-to-agent flow](../assets/figures/verbalcoding-flow.svg)
27
8
 
28
9
  ## Why
29
10
 
30
- VerbalCoding transforme un salon vocal Discord en interface mains libres pour agents de code. Dictez une demande, laissez le CLI travailler, puis écoutez une réponse concise avec transcription texte, événements de progression et garde-fous pour éviter de lire de longs blocs de code ou logs.
11
+ VerbalCoding transforme un salon vocal Discord en interface mains libres pour agents de programmation. Vous dictez une demande, l’agent CLI travaille, puis vous recevez une réponse vocale concise avec transcription texte et événements de progression.
31
12
 
32
- ## Points forts
13
+ ## Highlights
33
14
 
34
- | Fonction | Pourquoi c’est utile |
15
+ | Feature | What it means |
35
16
  |---|---|
36
- | Contrôle vocal d’abord | Pilotez Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw ou un CLI personnalisé à la voix. |
37
- | Boucle vocale locale | Voix Discord → STT `whisper.cpp` → agent → lecture TTS par segments. |
38
- | Contexte partagé voix + texte | Les tours vocaux et `!ask` peuvent réutiliser la même session d’agent compatible. |
39
- | Interruption et sensibilité | Interrompez naturellement la lecture et basculez entre sensibilité normale ou conservatrice. |
40
- | Préréglages vocaux multilingues | `vc language ko/en/auto` change ensemble STT, langue de progression et voix TTS. |
41
- | Isolation par projet | Un bot, profil Hermes, session, mémoire et logs par salon/projet. |
17
+ | Voice-first agent control | Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw, or a custom CLI harness. |
18
+ | Local-first speech loop | Discord voice capture → `whisper.cpp` STT → agent → chunked TTS playback. |
19
+ | Shared voice + text context | Voice turns and `!ask` text commands can reuse the same supported agent session. |
20
+ | Barge-in and sensitivity modes | Interrupt playback naturally and switch between normal and conservative/noisy modes. |
21
+ | Multilingual voice presets | `vc language ko/en/auto` changes STT, progress language, and TTS voice together. |
22
+ | Multi-room project isolation | Run one bot per project room with isolated Hermes profiles, sessions, memory, and logs. |
42
23
 
43
- ## Démarrage rapide
24
+ ## Quick Start
44
25
 
45
26
  ```bash
46
- git clone git@github.com:ca1773130n/VerbalCoding.git
47
- cd VerbalCoding
48
- ./scripts/install.sh
27
+ npm install -g verbalcoding
28
+ vc setup --yes
49
29
  vc doctor
50
- ./run.sh
30
+ vc start
51
31
  ```
52
32
 
53
- ## Fonctionnement
54
-
55
- ```mermaid
56
- flowchart LR
57
- A[Discord voice] --> B["@discordjs/voice"]
58
- B --> C[PCM cleanup + gates]
59
- C --> D["whisper.cpp STT"]
60
- D --> E["CLI agent adapter"]
61
- E --> F["Concise answer"]
62
- F --> G["Chunked TTS"]
63
- G --> H["Discord playback"]
33
+ Run without a permanent global install:
34
+
35
+ ```bash
36
+ npx verbalcoding setup --yes
37
+ vc doctor
38
+ vc start
64
39
  ```
65
40
 
66
- ## Backends d’agents pris en charge
41
+ Contributor clone path:
42
+
43
+ ```bash
44
+ git clone https://github.com/ca1773130n/VerbalCoding.git
45
+ cd VerbalCoding
46
+ ./scripts/install.sh --yes
47
+ vc doctor
48
+ ./run.sh
49
+ ```
67
50
 
68
- | Backend | Default command | Session support |
69
- |---|---:|---|
70
- | Hermes Agent | `hermes chat -Q -q` | Resume, verbose progress, cancellation, final-answer recovery |
71
- | Claude Code | `claude -p` | CLI session file support through adapter defaults |
72
- | Codex CLI | `codex exec` | CLI session file support through adapter defaults |
73
- | Gemini CLI | `gemini -p` | CLI session file support through adapter defaults |
74
- | OpenCode | `opencode run` | CLI session file support through adapter defaults |
75
- | OpenClaw | `openclaw run` | CLI session file support through adapter defaults |
76
- | Custom | `AGENT_COMMAND` | Bring your own non-interactive command |
51
+ `vc setup --yes` and `./scripts/install.sh --yes` bootstrap npm dependencies, `ffmpeg`, `whisper-cli`, the default whisper.cpp model, a local Edge TTS helper, and the short `vc` command where possible.
77
52
 
78
- ## En savoir plus
53
+ ## Guides
79
54
 
80
- | Guide | What you get |
55
+ | Guide | Link |
81
56
  |---|---|
82
- | [Fresh Install](../FRESH_INSTALL.md) | Installation propre, téléchargement du modèle, premier lancement |
83
- | [Usage Guide](../USAGE.md) | Commandes CLI, commandes Discord, progression, métriques de latence |
84
- | [Configuration](../CONFIGURATION.md) | .env, backends agent, MCP, TTS et notes d’exploitation |
85
- | [Multi-Instance](../MULTI_INSTANCE.md) | Un salon vocal Discord permanent par projet |
86
- | [Release Notes](../RELEASE.md) | Fonctionnalités actuelles et checklist pré-release |
57
+ | Installation propre | [FRESH_INSTALL.fr.md](FRESH_INSTALL.fr.md) |
58
+ | Guide d’utilisation | [USAGE.fr.md](USAGE.fr.md) |
59
+ | Configuration | [CONFIGURATION.fr.md](CONFIGURATION.fr.md) |
60
+ | Multi-instance | [MULTI_INSTANCE.fr.md](MULTI_INSTANCE.fr.md) |
61
+ | Notes de version | [RELEASE.fr.md](RELEASE.fr.md) |
87
62
 
88
- ## Mini carte des commandes
63
+ ## Command map
89
64
 
90
65
  ```bash
91
66
  vc status
@@ -94,28 +69,17 @@ vc bot invite CLIENT_ID
94
69
  vc instance setup NAME
95
70
  vc instance start NAME
96
71
  vc doctor
72
+ vc start
97
73
  ```
98
74
 
99
- ## Prérequis
75
+ Discord commands:
100
76
 
101
- | Layer | Default |
102
- |---|---|
103
- | Runtime | Node.js 20+, npm |
104
- | Audio | `ffmpeg` |
105
- | STT | `whisper.cpp` / `whisper-cli` |
106
- | Discord | Bot token, Message Content intent, voice permissions |
107
- | Agent | At least one authenticated CLI harness, Hermes Agent by default |
108
- | Platform focus | macOS / Apple Silicon currently gets the most testing |
109
-
110
- ## Contribuer
111
-
112
- ```bash
113
- node --check app-node/main.mjs
114
- npm test
115
- bash -n run.sh scripts/install.sh
116
- vc doctor
77
+ ```text
78
+ !join !ask <prompt> !verbose on/off
79
+ !latency !sensitivity normal !sensitivity conservative
80
+ !session new <name> <workdir> [context] --voice <voice-channel>
117
81
  ```
118
82
 
119
- ## Statut
83
+ ## Requirements
120
84
 
121
- VerbalCoding is public-release oriented but still early. Demo video/GIF, broader Linux notes, and a formal license file are still TODOs.
85
+ Node.js 20+, npm, `ffmpeg`, `whisper.cpp` / `whisper-cli`, Edge TTS CLI, a Discord bot token with Message Content intent and voice permissions, and at least one authenticated CLI agent backend.
@@ -1,91 +1,66 @@
1
1
  # VerbalCoding
2
2
 
3
- <p align="center">
4
- <strong>Discord音声でCLIコーディングエージェントと通話するように作業できます。</strong>
5
- </p>
6
-
7
- <p align="center">
8
- <a href="../../README.md">English</a> ·
9
- <a href="README.ko.md">한국어</a> ·
10
- <a href="README.ja.md">日本語</a> ·
11
- <a href="README.zh.md">中文</a> ·
12
- <a href="README.es.md">Español</a> ·
13
- <a href="README.fr.md">Français</a> ·
14
- <a href="README.ru.md">Русский</a>
15
- </p>
16
-
17
- <p align="center">
18
- <img alt="Node.js" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=node.js&logoColor=white">
19
- <img alt="Discord" src="https://img.shields.io/badge/Discord-voice%20bridge-5865F2?logo=discord&logoColor=white">
20
- <img alt="STT" src="https://img.shields.io/badge/STT-whisper.cpp-7C3AED">
21
- <img alt="TTS" src="https://img.shields.io/badge/TTS-Edge%20%7C%20OpenVoice%20%7C%20Supertonic%20%7C%20SpeechSwift-0EA5E9">
22
- </p>
23
-
24
- <p align="center">
25
- <img src="../assets/figures/verbalcoding-flow.svg" alt="VerbalCoding voice-to-agent flow" width="860">
26
- </p>
3
+ **Discord 音声で CLI コーディングエージェントと電話のように作業できます。**
4
+
5
+ [English](../../README.md) · [한국어](README.ko.md) · [日本語](README.ja.md) · [中文](README.zh.md) · [Español](README.es.md) · [Français](README.fr.md) · [Русский](README.ru.md)
6
+
7
+ ![VerbalCoding voice-to-agent flow](../assets/figures/verbalcoding-flow.svg)
27
8
 
28
9
  ## Why
29
10
 
30
- VerbalCodingはDiscordの音声チャンネルを、コーディングエージェントのハンズフリー操作面に変えます。声で依頼し、CLIエージェントに作業させ、要点だけを音声で受け取れます。テキスト記録、進捗イベント、コードやログを読み上げすぎないガードも備えています。
11
+ VerbalCoding Discord の音声チャンネルを、コーディングエージェント向けのハンズフリー操作面に変えます。声で依頼し、CLI エージェントに作業させ、短い音声回答・文字起こし・進捗イベントを受け取れます。
31
12
 
32
- ## ハイライト
13
+ ## Highlights
33
14
 
34
- | できること | うれしい理由 |
15
+ | Feature | What it means |
35
16
  |---|---|
36
- | 音声ファーストのAgent操作 | Hermes AgentClaude CodeCodexGemini CLIOpenCodeOpenClaw、カスタムCLIを声で操作できます。 |
37
- | ローカル優先の音声ループ | Discord音声キャプチャ → `whisper.cpp` STT → Agent分割TTS再生。 |
38
- | 音声とテキストの共有コンテキスト | 対応Agentでは音声ターンと`!ask`テキストコマンドが同じセッションを再利用できます。 |
39
- | 割り込みと感度モード | 再生中に自然に割り込み、通常/保守的な感度を切り替えられます。 |
40
- | 多言語音声プリセット | `vc language ko/en/auto`でSTT、進捗言語、TTS音声をまとめて変更できます。 |
41
- | プロジェクト別マルチルーム分離 | プロジェクトごとにBot、Hermesプロファイル、セッション、メモリ、ログを分離します。 |
17
+ | Voice-first agent control | Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw, or a custom CLI harness. |
18
+ | Local-first speech loop | Discord voice capture → `whisper.cpp` STT → agentchunked TTS playback. |
19
+ | Shared voice + text context | Voice turns and `!ask` text commands can reuse the same supported agent session. |
20
+ | Barge-in and sensitivity modes | Interrupt playback naturally and switch between normal and conservative/noisy modes. |
21
+ | Multilingual voice presets | `vc language ko/en/auto` changes STT, progress language, and TTS voice together. |
22
+ | Multi-room project isolation | Run one bot per project room with isolated Hermes profiles, sessions, memory, and logs. |
42
23
 
43
- ## クイックスタート
24
+ ## Quick Start
44
25
 
45
26
  ```bash
46
- git clone git@github.com:ca1773130n/VerbalCoding.git
47
- cd VerbalCoding
48
- ./scripts/install.sh
27
+ npm install -g verbalcoding
28
+ vc setup --yes
49
29
  vc doctor
50
- ./run.sh
30
+ vc start
51
31
  ```
52
32
 
53
- ## 仕組み
54
-
55
- ```mermaid
56
- flowchart LR
57
- A[Discord voice] --> B["@discordjs/voice"]
58
- B --> C[PCM cleanup + gates]
59
- C --> D["whisper.cpp STT"]
60
- D --> E["CLI agent adapter"]
61
- E --> F["Concise answer"]
62
- F --> G["Chunked TTS"]
63
- G --> H["Discord playback"]
33
+ Run without a permanent global install:
34
+
35
+ ```bash
36
+ npx verbalcoding setup --yes
37
+ vc doctor
38
+ vc start
64
39
  ```
65
40
 
66
- ## 対応エージェントバックエンド
41
+ Contributor clone path:
42
+
43
+ ```bash
44
+ git clone https://github.com/ca1773130n/VerbalCoding.git
45
+ cd VerbalCoding
46
+ ./scripts/install.sh --yes
47
+ vc doctor
48
+ ./run.sh
49
+ ```
67
50
 
68
- | Backend | Default command | Session support |
69
- |---|---:|---|
70
- | Hermes Agent | `hermes chat -Q -q` | Resume, verbose progress, cancellation, final-answer recovery |
71
- | Claude Code | `claude -p` | CLI session file support through adapter defaults |
72
- | Codex CLI | `codex exec` | CLI session file support through adapter defaults |
73
- | Gemini CLI | `gemini -p` | CLI session file support through adapter defaults |
74
- | OpenCode | `opencode run` | CLI session file support through adapter defaults |
75
- | OpenClaw | `openclaw run` | CLI session file support through adapter defaults |
76
- | Custom | `AGENT_COMMAND` | Bring your own non-interactive command |
51
+ `vc setup --yes` and `./scripts/install.sh --yes` bootstrap npm dependencies, `ffmpeg`, `whisper-cli`, the default whisper.cpp model, a local Edge TTS helper, and the short `vc` command where possible.
77
52
 
78
- ## 詳しく見る
53
+ ## Guides
79
54
 
80
- | Guide | What you get |
55
+ | Guide | Link |
81
56
  |---|---|
82
- | [Fresh Install](../FRESH_INSTALL.md) | クリーンなクローンからのセットアップ、モデル取得、初回起動 |
83
- | [Usage Guide](../USAGE.md) | CLIコマンド、Discordコマンド、進捗モード、レイテンシ指標 |
84
- | [Configuration](../CONFIGURATION.md) | .env、エージェントバックエンド、MCP、TTSバックエンド、運用メモ |
85
- | [Multi-Instance](../MULTI_INSTANCE.md) | プロジェクトごとに常駐Discord音声ルームを用意 |
86
- | [Release Notes](../RELEASE.md) | 現在の機能とリリース前チェックリスト |
57
+ | 新規インストール | [FRESH_INSTALL.ja.md](FRESH_INSTALL.ja.md) |
58
+ | 使い方ガイド | [USAGE.ja.md](USAGE.ja.md) |
59
+ | 設定 | [CONFIGURATION.ja.md](CONFIGURATION.ja.md) |
60
+ | マルチインスタンス | [MULTI_INSTANCE.ja.md](MULTI_INSTANCE.ja.md) |
61
+ | リリースノート | [RELEASE.ja.md](RELEASE.ja.md) |
87
62
 
88
- ## 小さなコマンド表
63
+ ## Command map
89
64
 
90
65
  ```bash
91
66
  vc status
@@ -94,28 +69,17 @@ vc bot invite CLIENT_ID
94
69
  vc instance setup NAME
95
70
  vc instance start NAME
96
71
  vc doctor
72
+ vc start
97
73
  ```
98
74
 
99
- ## 要件
75
+ Discord commands:
100
76
 
101
- | Layer | Default |
102
- |---|---|
103
- | Runtime | Node.js 20+, npm |
104
- | Audio | `ffmpeg` |
105
- | STT | `whisper.cpp` / `whisper-cli` |
106
- | Discord | Bot token, Message Content intent, voice permissions |
107
- | Agent | At least one authenticated CLI harness, Hermes Agent by default |
108
- | Platform focus | macOS / Apple Silicon currently gets the most testing |
109
-
110
- ## コントリビュート
111
-
112
- ```bash
113
- node --check app-node/main.mjs
114
- npm test
115
- bash -n run.sh scripts/install.sh
116
- vc doctor
77
+ ```text
78
+ !join !ask <prompt> !verbose on/off
79
+ !latency !sensitivity normal !sensitivity conservative
80
+ !session new <name> <workdir> [context] --voice <voice-channel>
117
81
  ```
118
82
 
119
- ## ステータス
83
+ ## Requirements
120
84
 
121
- VerbalCoding is public-release oriented but still early. Demo video/GIF, broader Linux notes, and a formal license file are still TODOs.
85
+ Node.js 20+, npm, `ffmpeg`, `whisper.cpp` / `whisper-cli`, Edge TTS CLI, a Discord bot token with Message Content intent and voice permissions, and at least one authenticated CLI agent backend.
@@ -1,49 +1,27 @@
1
1
  # VerbalCoding
2
2
 
3
- <p align="center">
4
- <strong>Discord 음성으로 CLI 코딩 에이전트와 통화하듯 작업하세요.</strong>
5
- </p>
6
-
7
- <p align="center">
8
- <a href="../../README.md">English</a> ·
9
- <a href="README.ko.md">한국어</a> ·
10
- <a href="README.ja.md">日本語</a> ·
11
- <a href="README.zh.md">中文</a> ·
12
- <a href="README.es.md">Español</a> ·
13
- <a href="README.fr.md">Français</a> ·
14
- <a href="README.ru.md">Русский</a>
15
- </p>
16
-
17
- <p align="center">
18
- <img alt="Node.js" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=node.js&logoColor=white">
19
- <img alt="Discord" src="https://img.shields.io/badge/Discord-voice%20bridge-5865F2?logo=discord&logoColor=white">
20
- <img alt="STT" src="https://img.shields.io/badge/STT-whisper.cpp-7C3AED">
21
- <img alt="TTS" src="https://img.shields.io/badge/TTS-Edge%20%7C%20OpenVoice%20%7C%20Supertonic%20%7C%20SpeechSwift-0EA5E9">
22
- <img alt="Agents" src="https://img.shields.io/badge/Agents-Hermes%20%7C%20Claude%20%7C%20Codex%20%7C%20Gemini%20%7C%20OpenCode-111827">
23
- </p>
24
-
25
- <p align="center">
26
- <img src="../assets/figures/verbalcoding-flow.svg" alt="VerbalCoding voice-to-agent flow" width="860">
27
- </p>
28
-
29
- ## 왜 필요한가
30
-
31
- VerbalCoding은 Discord 음성 채널을 코딩 에이전트용 핸즈프리 조작면으로 바꿉니다. 말로 요청하고, CLI 에이전트가 작업하게 두고, 핵심 답변을 음성으로 다시 들을 수 있습니다. 텍스트 기록, 진행 이벤트, 코드/로그 낭독 방지 장치도 함께 제공합니다.
32
-
33
- ## 핵심 기능
34
-
35
- | 제공 기능 | 좋은 이유 |
36
- |---|---|
37
- | 음성 우선 에이전트 제어 | Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw 또는 커스텀 CLI를 말로 제어합니다. |
38
- | 로컬 우선 음성 루프 | Discord 음성 캡처 → `whisper.cpp` STT → 에이전트 → 분할 TTS 재생. |
39
- | 음성 + 텍스트 컨텍스트 공유 | 지원되는 에이전트에서는 음성 턴과 `!ask` 텍스트 명령이 같은 세션을 재사용합니다. |
40
- | 끼어들기와 감도 모드 | 재생 중 자연스럽게 끼어들고, 일반/보수 감도 모드를 전환합니다. |
41
- | 다국어 음성 프리셋 | `vc language ko/en/auto`로 STT, 진행 언어, TTS 음성을 함께 바꿉니다. |
42
- | 프로젝트별 멀티룸 격리 | 프로젝트 방마다 별도 봇과 Hermes 프로필, 세션, 메모리, 로그를 둡니다. |
3
+ **Discord 음성으로 CLI 코딩 에이전트와 통화하듯 작업하세요.**
4
+
5
+ [English](../../README.md) · [한국어](README.ko.md) · [日本語](README.ja.md) · [中文](README.zh.md) · [Español](README.es.md) · [Français](README.fr.md) · [Русский](README.ru.md)
6
+
7
+ ![VerbalCoding voice-to-agent flow](../assets/figures/verbalcoding-flow.svg)
8
+
9
+ ## Why
10
+
11
+ VerbalCoding은 Discord 음성 채널을 코딩 에이전트용 핸즈프리 제어면으로 바꿉니다. 말로 요청하고, CLI 에이전트가 작업하게 두고, 간결한 음성 답변과 텍스트 기록을 함께 받습니다.
12
+
13
+ ## Highlights
43
14
 
44
- ## 빠른 시작
15
+ | Feature | What it means |
16
+ |---|---|
17
+ | Voice-first agent control | Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw, or a custom CLI harness. |
18
+ | Local-first speech loop | Discord voice capture → `whisper.cpp` STT → agent → chunked TTS playback. |
19
+ | Shared voice + text context | Voice turns and `!ask` text commands can reuse the same supported agent session. |
20
+ | Barge-in and sensitivity modes | Interrupt playback naturally and switch between normal and conservative/noisy modes. |
21
+ | Multilingual voice presets | `vc language ko/en/auto` changes STT, progress language, and TTS voice together. |
22
+ | Multi-room project isolation | Run one bot per project room with isolated Hermes profiles, sessions, memory, and logs. |
45
23
 
46
- 가장 쉬운 npm 설치:
24
+ ## Quick Start
47
25
 
48
26
  ```bash
49
27
  npm install -g verbalcoding
@@ -52,7 +30,7 @@ vc doctor
52
30
  vc start
53
31
  ```
54
32
 
55
- 전역 설치 없이 바로 실행:
33
+ Run without a permanent global install:
56
34
 
57
35
  ```bash
58
36
  npx verbalcoding setup --yes
@@ -60,7 +38,7 @@ vc doctor
60
38
  vc start
61
39
  ```
62
40
 
63
- 기여자용 GitHub 클론:
41
+ Contributor clone path:
64
42
 
65
43
  ```bash
66
44
  git clone https://github.com/ca1773130n/VerbalCoding.git
@@ -70,57 +48,31 @@ vc doctor
70
48
  ./run.sh
71
49
  ```
72
50
 
73
- `vc setup --yes`와 `./scripts/install.sh --yes`는 가능한 경우 Node/npm 의존성, `ffmpeg`, `whisper-cli`, 기본 whisper.cpp 모델, 로컬 `.venv-tts` Edge TTS helper 준비합니다. macOS/Homebrew와 일반적인 Linux 패키지 매니저(`apt`, `dnf`, `pacman`)를 지원합니다.
74
-
75
- ## 동작 방식
76
-
77
- ```mermaid
78
- flowchart LR
79
- A[Discord voice] --> B["@discordjs/voice"]
80
- B --> C[PCM cleanup + gates]
81
- C --> D["whisper.cpp STT"]
82
- D --> E["CLI agent adapter"]
83
- E --> F["Concise answer"]
84
- F --> G["Chunked TTS"]
85
- G --> H["Discord playback"]
86
- ```
87
-
88
- ## 지원 에이전트 백엔드
89
-
90
- | 백엔드 | 기본 명령 | 세션 지원 |
91
- |---|---:|---|
92
- | Hermes Agent | `hermes chat -Q -q` | resume, 자세한 진행, cancellation, 최종 답변 복구 |
93
- | Claude Code | `claude -p` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
94
- | Codex CLI | `codex exec` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
95
- | Gemini CLI | `gemini -p` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
96
- | OpenCode | `opencode run` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
97
- | OpenClaw | `openclaw run` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
98
- | Custom | `AGENT_COMMAND` | 비대화형 명령을 직접 연결 |
51
+ `vc setup --yes` and `./scripts/install.sh --yes` bootstrap npm dependencies, `ffmpeg`, `whisper-cli`, the default whisper.cpp model, a local Edge TTS helper, and the short `vc` command where possible.
99
52
 
100
- ## 더 알아보기
53
+ ## Guides
101
54
 
102
- | 문서 | 내용 |
55
+ | Guide | Link |
103
56
  |---|---|
104
- | [새 설치](FRESH_INSTALL.ko.md) | npm 설치, 클린 클론, 모델 다운로드, 첫 실행 |
105
- | [사용 가이드](USAGE.ko.md) | CLI 명령, Discord 명령, 진행 모드, 지연 시간 지표 |
106
- | [설정](CONFIGURATION.ko.md) | `.env`, 에이전트 백엔드, MCP, TTS 백엔드, 운영 메모 |
107
- | [멀티 인스턴스](MULTI_INSTANCE.ko.md) | 프로젝트마다 영구 Discord 음성방 하나씩 운영 |
108
- | [릴리스 노트](RELEASE.ko.md) | 현재 기능과 릴리스 전 체크리스트 |
109
- | [English docs](../../README.md) | 영어 canonical README와 문서 |
57
+ | 새 설치 | [FRESH_INSTALL.ko.md](FRESH_INSTALL.ko.md) |
58
+ | 사용 가이드 | [USAGE.ko.md](USAGE.ko.md) |
59
+ | 설정 | [CONFIGURATION.ko.md](CONFIGURATION.ko.md) |
60
+ | 멀티 인스턴스 | [MULTI_INSTANCE.ko.md](MULTI_INSTANCE.ko.md) |
61
+ | 릴리스 노트 | [RELEASE.ko.md](RELEASE.ko.md) |
110
62
 
111
- ## 작은 명령 지도
63
+ ## Command map
112
64
 
113
65
  ```bash
114
- vc status # 현재 언어, TTS, 브릿지 설정 보기
115
- vc language ko|en|auto # STT/진행/TTS 언어 프리셋 전환
116
- vc bot invite CLIENT_ID # Discord 봇 초대 URL 생성
117
- vc instance setup NAME # 격리된 프로젝트 음성 봇 생성
118
- vc instance start NAME # 해당 봇을 백그라운드로 실행
119
- vc doctor # 비밀값을 숨긴 상태 점검
120
- vc start # 기본 브릿지 시작
66
+ vc status
67
+ vc language ko|en|auto
68
+ vc bot invite CLIENT_ID
69
+ vc instance setup NAME
70
+ vc instance start NAME
71
+ vc doctor
72
+ vc start
121
73
  ```
122
74
 
123
- Discord에서:
75
+ Discord commands:
124
76
 
125
77
  ```text
126
78
  !join !ask <prompt> !verbose on/off
@@ -128,30 +80,6 @@ Discord에서:
128
80
  !session new <name> <workdir> [context] --voice <voice-channel>
129
81
  ```
130
82
 
131
- ## 요구 사항
132
-
133
- | 계층 | 기본값 |
134
- |---|---|
135
- | Runtime | Node.js 20+, npm; 설치 스크립트가 Homebrew/apt/dnf/pacman으로 설치 시도 |
136
- | Audio | `ffmpeg`; 설치 스크립트가 설치 시도 |
137
- | STT | `whisper.cpp` / `whisper-cli`; macOS는 Homebrew, Linux는 로컬 빌드 fallback |
138
- | TTS | Edge TTS CLI; 필요하면 `.venv-tts` 생성 |
139
- | Discord | Bot token, Message Content intent, voice permissions |
140
- | Agent | 인증된 CLI 하네스 하나 이상; 기본은 Hermes Agent |
141
- | Platform focus | macOS / Apple Silicon을 가장 많이 테스트; Linux bootstrap은 best-effort |
142
-
143
- ## 기여
144
-
145
- 변경 전 가벼운 검증:
146
-
147
- ```bash
148
- node --check app-node/main.mjs
149
- npm test
150
- bash -n run.sh scripts/install.sh
151
- npm pack --dry-run
152
- vc doctor
153
- ```
154
-
155
- ## 상태
83
+ ## Requirements
156
84
 
157
- VerbalCoding은 공개 릴리스를 지향하지만 아직 초기 단계입니다. 데모 영상/GIF, 넓은 Linux 검증, CI와 보안 리뷰를 계속 보강하면 좋습니다.
85
+ Node.js 20+, npm, `ffmpeg`, `whisper.cpp` / `whisper-cli`, Edge TTS CLI, a Discord bot token with Message Content intent and voice permissions, and at least one authenticated CLI agent backend.