verbalcoding 0.2.7 → 0.2.8

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 (44) hide show
  1. package/README.md +12 -27
  2. package/app-node/cli_install.test.mjs +15 -0
  3. package/docs/FRESH_INSTALL.md +8 -2
  4. package/docs/assets/figures/verbalcoding-flow.svg +45 -30
  5. package/docs/i18n/CONFIGURATION.es.md +138 -49
  6. package/docs/i18n/CONFIGURATION.fr.md +138 -49
  7. package/docs/i18n/CONFIGURATION.ja.md +137 -48
  8. package/docs/i18n/CONFIGURATION.ko.md +137 -48
  9. package/docs/i18n/CONFIGURATION.ru.md +138 -49
  10. package/docs/i18n/CONFIGURATION.zh.md +137 -48
  11. package/docs/i18n/FRESH_INSTALL.es.md +115 -32
  12. package/docs/i18n/FRESH_INSTALL.fr.md +115 -32
  13. package/docs/i18n/FRESH_INSTALL.ja.md +119 -36
  14. package/docs/i18n/FRESH_INSTALL.ko.md +120 -37
  15. package/docs/i18n/FRESH_INSTALL.ru.md +115 -32
  16. package/docs/i18n/FRESH_INSTALL.zh.md +119 -36
  17. package/docs/i18n/MULTI_INSTANCE.es.md +85 -26
  18. package/docs/i18n/MULTI_INSTANCE.fr.md +85 -26
  19. package/docs/i18n/MULTI_INSTANCE.ja.md +87 -29
  20. package/docs/i18n/MULTI_INSTANCE.ko.md +87 -29
  21. package/docs/i18n/MULTI_INSTANCE.ru.md +84 -26
  22. package/docs/i18n/MULTI_INSTANCE.zh.md +87 -29
  23. package/docs/i18n/README.es.md +109 -45
  24. package/docs/i18n/README.fr.md +109 -45
  25. package/docs/i18n/README.ja.md +109 -45
  26. package/docs/i18n/README.ko.md +108 -45
  27. package/docs/i18n/README.ru.md +109 -45
  28. package/docs/i18n/README.zh.md +108 -45
  29. package/docs/i18n/RELEASE.es.md +53 -37
  30. package/docs/i18n/RELEASE.fr.md +53 -37
  31. package/docs/i18n/RELEASE.ja.md +52 -36
  32. package/docs/i18n/RELEASE.ko.md +52 -36
  33. package/docs/i18n/RELEASE.ru.md +53 -37
  34. package/docs/i18n/RELEASE.zh.md +53 -37
  35. package/docs/i18n/USAGE.es.md +91 -64
  36. package/docs/i18n/USAGE.fr.md +91 -64
  37. package/docs/i18n/USAGE.ja.md +90 -63
  38. package/docs/i18n/USAGE.ko.md +90 -63
  39. package/docs/i18n/USAGE.ru.md +91 -64
  40. package/docs/i18n/USAGE.zh.md +90 -63
  41. package/package.json +1 -1
  42. package/scripts/bootstrap_prereqs.sh +15 -3
  43. package/scripts/cli.mjs +1 -1
  44. package/scripts/doctor.mjs +114 -8
@@ -1,27 +1,49 @@
1
1
  # VerbalCoding
2
2
 
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
14
-
15
- | Feature | What it means |
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 の音声からエージェントへのフロー" width="860">
27
+ </p>
28
+
29
+ ## なぜ使うのか
30
+
31
+ VerbalCoding は、Discord の音声チャンネルをコーディングエージェント向けのハンズフリー操作面に変えます。リクエストを話し、CLI エージェントに作業を任せ、簡潔な回答を音声で受け取れます。テキスト文字起こし、進捗イベント、ノイズの多いコード/ログ出力に対するガードレールも備えています。
32
+
33
+ ## ハイライト
34
+
35
+ | 得られるもの | 何がうれしいか |
16
36
  |---|---|
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` STTagentchunked 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. |
37
+ | 音声ファーストのエージェント操作 | Hermes AgentClaude CodeCodexGemini CLIOpenCodeOpenClaw、または任意のカスタム CLI ハーネスに話しかけられます。 |
38
+ | オンデバイスの音声ループ | Discord 音声キャプチャローカル `whisper-cli` 文字起こしエージェント分割 TTS 再生。 |
39
+ | 音声 + テキストの共有コンテキスト | 音声ターンと `!ask` テキストコマンドで、対応する同じエージェントセッションを再利用できます。 |
40
+ | 割り込み発話と感度モード | 再生を自然に中断し、通常環境と保守的/騒音環境向けのモードを切り替えられます。 |
41
+ | 多言語音声プリセット | `vc language ko/en/auto` STT、進捗言語、TTS 音声をまとめて切り替えます。 |
42
+ | 複数ルームのプロジェクト分離 | プロジェクトルームごとに 1 つのボットを実行し、Hermes プロファイル、セッション、メモリ、ログを分離します。 |
23
43
 
24
- ## Quick Start
44
+ ## クイックスタート
45
+
46
+ npm を使う最短手順:
25
47
 
26
48
  ```bash
27
49
  npm install -g verbalcoding
@@ -30,7 +52,7 @@ vc doctor
30
52
  vc start
31
53
  ```
32
54
 
33
- Run without a permanent global install:
55
+ 永続的なグローバルインストールなしで直接実行する場合:
34
56
 
35
57
  ```bash
36
58
  npx verbalcoding setup --yes
@@ -38,7 +60,7 @@ vc doctor
38
60
  vc start
39
61
  ```
40
62
 
41
- Contributor clone path:
63
+ コントリビューター向けの GitHub クローン手順:
42
64
 
43
65
  ```bash
44
66
  git clone https://github.com/ca1773130n/VerbalCoding.git
@@ -48,38 +70,80 @@ vc doctor
48
70
  ./run.sh
49
71
  ```
50
72
 
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.
73
+ `vc setup --yes` は、npm パッケージに同梱されたインストーラーからローカル前提条件をブートストラップします。`./scripts/install.sh --yes` GitHub クローン内で同じ処理を行います。どちらも可能な範囲で Node/npm 依存関係、`ffmpeg`、`whisper-cli`、デフォルトの whisper.cpp モデル、ローカル `.venv-tts` Edge TTS ヘルパー、セットアップウィザード設定を処理します。macOS/Homebrew と一般的な Linux パッケージマネージャー(`apt`、`dnf`、`pacman`)をサポートします。依存関係だけをセットアップするには `--no-wizard` を付けて再実行し、OS パッケージを自分でインストールしたい場合は `--skip-system` を使います。
74
+
75
+ クリーンインストールの手順が必要ですか? [新規インストール](FRESH_INSTALL.ja.md) から始めてください。
76
+
77
+ ## 対応エージェントバックエンド
52
78
 
53
- ## Guides
79
+ | バックエンド | デフォルトコマンド | セッション対応 |
80
+ |---|---:|---|
81
+ | Hermes Agent | `hermes chat -Q -q` | 再開、詳細な進捗、キャンセル、最終回答の復元 |
82
+ | Claude Code | `claude -p` | アダプターのデフォルトによる CLI セッションファイル対応 |
83
+ | Codex CLI | `codex exec` | アダプターのデフォルトによる CLI セッションファイル対応 |
84
+ | Gemini CLI | `gemini -p` | アダプターのデフォルトによる CLI セッションファイル対応 |
85
+ | OpenCode | `opencode run` | アダプターのデフォルトによる CLI セッションファイル対応 |
86
+ | OpenClaw | `openclaw run` | アダプターのデフォルトによる CLI セッションファイル対応 |
87
+ | Custom | `AGENT_COMMAND` | 独自の非対話コマンドを持ち込めます |
54
88
 
55
- | Guide | Link |
89
+ ## さらに詳しく
90
+
91
+ | ガイド | 内容 |
56
92
  |---|---|
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) |
93
+ | [新規インストール](FRESH_INSTALL.ja.md) | クリーンなクローンセットアップ、モデルのダウンロード、初回実行 |
94
+ | [使い方ガイド](USAGE.ja.md) | CLI コマンド、Discord コマンド、進捗モード、レイテンシ指標 |
95
+ | [設定](CONFIGURATION.ja.md) | `.env`、エージェントバックエンド、MCP、TTS バックエンド、運用メモ |
96
+ | [マルチインスタンス](MULTI_INSTANCE.ja.md) | プロジェクトごとに 1 つの永続 Discord 音声ルーム |
97
+ | [リリースノート](RELEASE.ja.md) | 現在の機能とプレリリースチェックリスト |
62
98
 
63
- ## Command map
99
+ ## 小さなコマンドマップ
64
100
 
65
101
  ```bash
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
102
+ vc status # 現在の言語、TTS、ブリッジ設定
103
+ vc language ko|en|auto # STT/進捗/TTS の言語プリセットを切り替え
104
+ vc bot invite CLIENT_ID # Discord ボット招待 URL を生成
105
+ vc instance setup NAME # 分離されたプロジェクト音声ボットを作成
106
+ vc instance start NAME # そのボットをバックグラウンドで実行
107
+ vc doctor # 秘密情報を伏せたヘルスチェック
108
+ vc start # デフォルトブリッジを起動
73
109
  ```
74
110
 
75
- Discord commands:
111
+ Discord 内:
112
+
113
+ | コマンド | 動作 |
114
+ |---|---|
115
+ | `!join` | 現在の音声チャンネルに参加します。 |
116
+ | `!ask <prompt>` | 同じエージェントバックエンドにテキストを送信します。 |
117
+ | `!verbose on\|off` | 短い進捗更新を表示/読み上げします。 |
118
+ | `!latency` | 直近の音声/STT/エージェント/TTS レイテンシを要約します。 |
119
+ | `!sensitivity normal` | 通常の屋内向け割り込み感度を使います。 |
120
+ | `!sensitivity conservative` | 騒音/屋外向けのより厳しい感度を使います。 |
121
+ | `!session new <name> <workdir> [context] --voice <voice-channel>` | プロジェクトセッションを音声ルームに紐付けます。 |
122
+
123
+ ## 要件
124
+
125
+ | レイヤー | デフォルト |
126
+ |---|---|
127
+ | ランタイム | Node.js 20+、npm。インストールスクリプトは Homebrew/apt/dnf/pacman 経由で導入できます |
128
+ | 音声 | `ffmpeg`。インストールスクリプトで導入できます |
129
+ | 音声認識 | whisper.cpp のローカル `whisper-cli`。インストールスクリプトは macOS では Homebrew、Linux ではローカルビルドのフォールバックを使います |
130
+ | TTS | Edge TTS CLI。必要に応じてインストールスクリプトが `.venv-tts` を作成します |
131
+ | Discord | ボットトークン、Message Content intent、音声権限 |
132
+ | エージェント | 認証済み CLI ハーネスが少なくとも 1 つ。デフォルトは Hermes Agent |
133
+ | 主な対象プラットフォーム | macOS / Apple Silicon で最も検証済み。Linux ブートストラップはベストエフォートで文書化されています |
134
+
135
+ ## コントリビュート
136
+
137
+ 変更を送る前に軽量チェックを実行してください:
76
138
 
77
- ```text
78
- !join !ask <prompt> !verbose on/off
79
- !latency !sensitivity normal !sensitivity conservative
80
- !session new <name> <workdir> [context] --voice <voice-channel>
139
+ ```bash
140
+ node --check app-node/main.mjs
141
+ npm test
142
+ bash -n run.sh scripts/install.sh
143
+ npm pack --dry-run
144
+ vc doctor
81
145
  ```
82
146
 
83
- ## Requirements
147
+ ## ステータス
84
148
 
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.
149
+ VerbalCoding は公開リリースを目指していますが、まだ初期段階です。デモ動画/GIF、より広範な Linux 検証、CI、より深いセキュリティレビューはまだ TODO です。
@@ -1,27 +1,48 @@
1
1
  # VerbalCoding
2
2
 
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
14
-
15
- | Feature | What it means |
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.ja.md">日本語</a> ·
10
+ <a href="README.zh.md">中文</a> ·
11
+ <a href="README.es.md">Español</a> ·
12
+ <a href="README.fr.md">Français</a> ·
13
+ <a href="README.ru.md">Русский</a>
14
+ </p>
15
+
16
+ <p align="center">
17
+ <img alt="Node.js" src="https://img.shields.io/badge/Node.js-20%2B-339933?logo=node.js&logoColor=white">
18
+ <img alt="Discord" src="https://img.shields.io/badge/Discord-voice%20bridge-5865F2?logo=discord&logoColor=white">
19
+ <img alt="STT" src="https://img.shields.io/badge/STT-whisper.cpp-7C3AED">
20
+ <img alt="TTS" src="https://img.shields.io/badge/TTS-Edge%20%7C%20OpenVoice%20%7C%20Supertonic%20%7C%20SpeechSwift-0EA5E9">
21
+ <img alt="Agents" src="https://img.shields.io/badge/Agents-Hermes%20%7C%20Claude%20%7C%20Codex%20%7C%20Gemini%20%7C%20OpenCode-111827">
22
+ </p>
23
+
24
+ <p align="center">
25
+ <img src="../assets/figures/verbalcoding-flow.svg" alt="VerbalCoding 음성-에이전트 흐름" width="860">
26
+ </p>
27
+
28
+ ## 왜 필요한가
29
+
30
+ VerbalCoding은 Discord 음성 채널을 코딩 에이전트를 위한 핸즈프리 제어면으로 바꿉니다. 요청을 말하고, CLI 에이전트가 작업하게 둔 뒤, 간결한 답변을 음성으로 들을 수 있습니다 — 텍스트 기록, 진행 이벤트, 시끄러운 코드/로그 출력에 대한 안전장치도 함께 제공합니다.
31
+
32
+ ## 주요 기능
33
+
34
+ | 제공되는 것 | 좋은 이유 |
16
35
  |---|---|
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` STTagentchunked 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. |
36
+ | 음성 우선 에이전트 제어 | Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw 또는 임의의 커스텀 CLI 하네스와 말로 대화합니다. |
37
+ | 온디바이스 음성 루프 | Discord 음성 캡처로컬 `whisper-cli` 전사에이전트분할 TTS 재생. |
38
+ | 공유 음성 + 텍스트 컨텍스트 | 음성 턴과 `!ask` 텍스트 명령이 지원되는 동일 에이전트 세션을 재사용할 있습니다. |
39
+ | 끼어들기 감도 모드 | 재생 자연스럽게 끼어들고 일반/보수적(시끄러운 환경) 모드를 전환합니다. |
40
+ | 다국어 음성 프리셋 | `vc language ko/en/auto`로 STT, 진행 언어, TTS 음성을 함께 전환합니다. |
41
+ | 여러 방의 프로젝트 격리 | 프로젝트 방마다 하나의 봇을 실행하고 Hermes 프로필, 세션, 메모리, 로그를 분리합니다. |
23
42
 
24
- ## Quick Start
43
+ ## 빠른 시작
44
+
45
+ npm으로 가장 빠르게 시작하는 방법:
25
46
 
26
47
  ```bash
27
48
  npm install -g verbalcoding
@@ -30,7 +51,7 @@ vc doctor
30
51
  vc start
31
52
  ```
32
53
 
33
- Run without a permanent global install:
54
+ 영구 전역 설치 없이 바로 실행하려면:
34
55
 
35
56
  ```bash
36
57
  npx verbalcoding setup --yes
@@ -38,7 +59,7 @@ vc doctor
38
59
  vc start
39
60
  ```
40
61
 
41
- Contributor clone path:
62
+ 기여자를 위한 GitHub 클론 경로:
42
63
 
43
64
  ```bash
44
65
  git clone https://github.com/ca1773130n/VerbalCoding.git
@@ -48,38 +69,80 @@ vc doctor
48
69
  ./run.sh
49
70
  ```
50
71
 
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.
72
+ `vc setup --yes`는 npm 패키지 안에 포함된 설치 스크립트로 로컬 필수 구성요소를 부트스트랩합니다. `./scripts/install.sh --yes`는 GitHub 클론 안에서 같은 작업을 수행합니다. 둘 다 가능한 경우 Node/npm 의존성, `ffmpeg`, `whisper-cli`, 기본 whisper.cpp 모델, 로컬 `.venv-tts` Edge TTS 헬퍼, 설정 마법사를 처리합니다. macOS/Homebrew와 일반적인 Linux 패키지 관리자(`apt`, `dnf`, `pacman`)를 지원합니다. 의존성만 설정하려면 `--no-wizard`로 다시 실행하고, OS 패키지를 직접 설치하려면 `--skip-system`을 사용하세요.
73
+
74
+ 깨끗한 설치 안내가 필요하다면 [Fresh Install](FRESH_INSTALL.ko.md)부터 시작하세요.
75
+
76
+ ## 지원되는 에이전트 백엔드
52
77
 
53
- ## Guides
78
+ | 백엔드 | 기본 명령 | 세션 지원 |
79
+ |---|---:|---|
80
+ | Hermes Agent | `hermes chat -Q -q` | 이어받기, 자세한 진행, 취소, 최종 답변 복구 |
81
+ | Claude Code | `claude -p` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
82
+ | Codex CLI | `codex exec` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
83
+ | Gemini CLI | `gemini -p` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
84
+ | OpenCode | `opencode run` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
85
+ | OpenClaw | `openclaw run` | 어댑터 기본값을 통한 CLI 세션 파일 지원 |
86
+ | Custom | `AGENT_COMMAND` | 직접 만든 비대화형 명령 사용 |
54
87
 
55
- | Guide | Link |
88
+ ## 알아보기
89
+
90
+ | 가이드 | 제공 내용 |
56
91
  |---|---|
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) |
92
+ | [Fresh Install](FRESH_INSTALL.ko.md) | 깨끗한 클론 설정, 모델 다운로드, 첫 실행 |
93
+ | [Usage Guide](USAGE.ko.md) | CLI 명령, Discord 명령, 진행 모드, 지연 시간 지표 |
94
+ | [Configuration](CONFIGURATION.ko.md) | `.env`, 에이전트 백엔드, MCP, TTS 백엔드, 운영 참고 사항 |
95
+ | [Multi-Instance](MULTI_INSTANCE.ko.md) | 프로젝트마다 하나의 영구 Discord 음성 방 |
96
+ | [Release Notes](RELEASE.ko.md) | 현재 기능과 사전 릴리스 체크리스트 |
62
97
 
63
- ## Command map
98
+ ## 작은 명령 지도
64
99
 
65
100
  ```bash
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
101
+ vc status # 현재 언어, TTS, 브리지 설정
102
+ vc language ko|en|auto # STT/진행/TTS 언어 프리셋 전환
103
+ vc bot invite CLIENT_ID # Discord 봇 초대 URL 생성
104
+ vc instance setup NAME # 격리된 프로젝트 음성 봇 생성
105
+ vc instance start NAME # 해당 봇을 백그라운드에서 실행
106
+ vc doctor # 민감 정보가 제거된 상태 점검
107
+ vc start # 기본 브리지 시작
73
108
  ```
74
109
 
75
- Discord commands:
110
+ Discord에서:
111
+
112
+ | 명령 | 하는 일 |
113
+ |---|---|
114
+ | `!join` | 현재 음성 채널에 참가합니다. |
115
+ | `!ask <prompt>` | 동일 에이전트 백엔드로 텍스트를 보냅니다. |
116
+ | `!verbose on\|off` | 짧은 진행 업데이트를 표시/낭독합니다. |
117
+ | `!latency` | 최근 음성/STT/에이전트/TTS 지연 시간을 요약합니다. |
118
+ | `!sensitivity normal` | 일반 실내 끼어들기 감도를 사용합니다. |
119
+ | `!sensitivity conservative` | 더 엄격한 시끄러운/실외 감도를 사용합니다. |
120
+ | `!session new <name> <workdir> [context] --voice <voice-channel>` | 프로젝트 세션을 음성 방에 연결합니다. |
121
+
122
+ ## 요구 사항
123
+
124
+ | 계층 | 기본값 |
125
+ |---|---|
126
+ | 런타임 | Node.js 20+, npm; 설치 스크립트가 Homebrew/apt/dnf/pacman으로 설치 가능 |
127
+ | 오디오 | `ffmpeg`; 설치 스크립트가 설치 가능 |
128
+ | 음성 인식 | whisper.cpp의 로컬 `whisper-cli`; 설치 스크립트는 macOS에서 Homebrew를 사용하거나 Linux에서 로컬 빌드 폴백 사용 |
129
+ | TTS | Edge TTS CLI; 필요한 경우 설치 스크립트가 `.venv-tts` 생성 |
130
+ | Discord | 봇 토큰, Message Content intent, 음성 권한 |
131
+ | 에이전트 | 인증된 CLI 하네스 하나 이상, 기본값은 Hermes Agent |
132
+ | 중점 플랫폼 | macOS / Apple Silicon에서 가장 많이 테스트됨; Linux 부트스트랩은 최선 노력으로 문서화됨 |
133
+
134
+ ## 기여
135
+
136
+ 변경 사항을 보내기 전에 가벼운 점검을 실행하세요:
76
137
 
77
- ```text
78
- !join !ask <prompt> !verbose on/off
79
- !latency !sensitivity normal !sensitivity conservative
80
- !session new <name> <workdir> [context] --voice <voice-channel>
138
+ ```bash
139
+ node --check app-node/main.mjs
140
+ npm test
141
+ bash -n run.sh scripts/install.sh
142
+ npm pack --dry-run
143
+ vc doctor
81
144
  ```
82
145
 
83
- ## Requirements
146
+ ## 상태
84
147
 
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.
148
+ VerbalCoding은 공개 릴리스를 지향하지만 아직 초기 단계입니다. 데모 비디오/GIF, 넓은 Linux 검증, CI, 깊은 보안 검토는 아직 TODO입니다.
@@ -1,27 +1,49 @@
1
1
  # VerbalCoding
2
2
 
3
- **Управляйте CLI-агентами для кода голосом в Discord — почти как по телефону.**
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 в hands-free интерфейс для coding agents. Вы произносите задачу, CLI-агент работает, а вы получаете краткий голосовой ответ, текстовую расшифровку и события прогресса.
12
-
13
- ## Highlights
14
-
15
- | Feature | What it means |
3
+ <p align="center">
4
+ <strong>Разговаривайте с CLI-агентами для кодинга через голос Discord — как по телефону для разработки ПО.</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 к агенту" width="860">
27
+ </p>
28
+
29
+ ## Зачем
30
+
31
+ VerbalCoding превращает голосовой канал Discord в панель управления кодинг-агентами без рук. Произнесите запрос, позвольте CLI-агенту выполнить работу и услышите краткий ответ — с текстовыми расшифровками, событиями прогресса и защитными ограничениями для шумного вывода кода/логов.
32
+
33
+ ## Главное
34
+
35
+ | Что вы получаете | Почему это удобно |
16
36
  |---|---|
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. |
37
+ | Управление агентами голосом в первую очередь | Разговаривайте с Hermes Agent, Claude Code, Codex, Gemini CLI, OpenCode, OpenClaw или любым пользовательским CLI-харнесом. |
38
+ | Речевой цикл на устройстве | Захват голоса Discordлокальная расшифровка `whisper-cli` → агентфрагментированное воспроизведение TTS. |
39
+ | Общий голосовой и текстовый контекст | Голосовые реплики и текстовые команды `!ask` могут повторно использовать одну и ту же поддерживаемую сессию агента. |
40
+ | Перебивание и режимы чувствительности | Естественно прерывайте воспроизведение и переключайтесь между обычной и консервативной/шумной средой. |
41
+ | Многоязычные голосовые пресеты | Переключайте STT, язык прогресса и голос TTS вместе через `vc language ko/en/auto`. |
42
+ | Изоляция проектов по комнатам | Запускайте по одному боту на проектную комнату с отдельными профилями Hermes, сессиями, памятью и логами. |
23
43
 
24
- ## Quick Start
44
+ ## Быстрый старт
45
+
46
+ Самый быстрый путь через npm:
25
47
 
26
48
  ```bash
27
49
  npm install -g verbalcoding
@@ -30,7 +52,7 @@ vc doctor
30
52
  vc start
31
53
  ```
32
54
 
33
- Run without a permanent global install:
55
+ Или запуск напрямую без постоянной глобальной установки:
34
56
 
35
57
  ```bash
36
58
  npx verbalcoding setup --yes
@@ -38,7 +60,7 @@ vc doctor
38
60
  vc start
39
61
  ```
40
62
 
41
- Contributor clone path:
63
+ Путь через клон GitHub для контрибьюторов:
42
64
 
43
65
  ```bash
44
66
  git clone https://github.com/ca1773130n/VerbalCoding.git
@@ -48,38 +70,80 @@ vc doctor
48
70
  ./run.sh
49
71
  ```
50
72
 
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.
73
+ `vc setup --yes` подготавливает локальные зависимости из установленного npm-пакета. `./scripts/install.sh --yes` делает то же самое только внутри GitHub-клона. Оба пути по возможности настраивают зависимости Node/npm, `ffmpeg`, `whisper-cli`, стандартную модель whisper.cpp, локальный помощник Edge TTS в `.venv-tts` и мастер настройки. Они поддерживают macOS/Homebrew и распространённые менеджеры пакетов Linux (`apt`, `dnf`, `pacman`); повторно запустите с `--no-wizard` для установки только зависимостей или с `--skip-system`, если хотите устанавливать пакеты ОС самостоятельно.
74
+
75
+ Нужно пошаговое руководство по чистой установке? Начните с [Fresh Install](FRESH_INSTALL.ru.md).
76
+
77
+ ## Поддерживаемые бэкенды агентов
52
78
 
53
- ## Guides
79
+ | Бэкенд | Команда по умолчанию | Поддержка сессий |
80
+ |---|---:|---|
81
+ | Hermes Agent | `hermes chat -Q -q` | Возобновление, подробный прогресс, отмена, восстановление финального ответа |
82
+ | Claude Code | `claude -p` | Поддержка файла сессии CLI через настройки адаптера по умолчанию |
83
+ | Codex CLI | `codex exec` | Поддержка файла сессии CLI через настройки адаптера по умолчанию |
84
+ | Gemini CLI | `gemini -p` | Поддержка файла сессии CLI через настройки адаптера по умолчанию |
85
+ | OpenCode | `opencode run` | Поддержка файла сессии CLI через настройки адаптера по умолчанию |
86
+ | OpenClaw | `openclaw run` | Поддержка файла сессии CLI через настройки адаптера по умолчанию |
87
+ | Пользовательский | `AGENT_COMMAND` | Подключите собственную неинтерактивную команду |
54
88
 
55
- | Guide | Link |
89
+ ## Узнать больше
90
+
91
+ | Руководство | Что вы получите |
56
92
  |---|---|
57
- | Чистая установка | [FRESH_INSTALL.ru.md](FRESH_INSTALL.ru.md) |
58
- | Руководство по использованию | [USAGE.ru.md](USAGE.ru.md) |
59
- | Конфигурация | [CONFIGURATION.ru.md](CONFIGURATION.ru.md) |
60
- | Мульти-инстансы | [MULTI_INSTANCE.ru.md](MULTI_INSTANCE.ru.md) |
61
- | Заметки о релизе | [RELEASE.ru.md](RELEASE.ru.md) |
93
+ | [Чистая установка](FRESH_INSTALL.ru.md) | Настройка чистого клона, загрузка модели, первый запуск |
94
+ | [Руководство по использованию](USAGE.ru.md) | CLI-команды, команды Discord, режим прогресса, метрики задержки |
95
+ | [Конфигурация](CONFIGURATION.ru.md) | `.env`, бэкенды агентов, MCP, бэкенды TTS, эксплуатационные заметки |
96
+ | [Многоэкземплярный режим](MULTI_INSTANCE.ru.md) | Одна постоянная голосовая комната Discord на проект |
97
+ | [Заметки о релизе](RELEASE.ru.md) | Текущие возможности и чеклист перед релизом |
62
98
 
63
- ## Command map
99
+ ## Краткая карта команд
64
100
 
65
101
  ```bash
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
102
+ vc status # current language, TTS, and bridge settings
103
+ vc language ko|en|auto # switch STT/progress/TTS language preset
104
+ vc bot invite CLIENT_ID # generate the Discord bot invite URL
105
+ vc instance setup NAME # create an isolated project voice bot
106
+ vc instance start NAME # run that bot in the background
107
+ vc doctor # redacted health check
108
+ vc start # start the default bridge
73
109
  ```
74
110
 
75
- Discord commands:
111
+ В Discord:
112
+
113
+ | Команда | Что делает |
114
+ |---|---|
115
+ | `!join` | Подключает бота к вашему текущему голосовому каналу. |
116
+ | `!ask <prompt>` | Отправляет текст в тот же бэкенд агента. |
117
+ | `!verbose on\|off` | Показывает/озвучивает короткие обновления прогресса. |
118
+ | `!latency` | Сводка недавней задержки голоса/STT/агента/TTS. |
119
+ | `!sensitivity normal` | Использует обычную чувствительность перебивания для помещений. |
120
+ | `!sensitivity conservative` | Использует более строгую чувствительность для шумной/уличной среды. |
121
+ | `!session new <name> <workdir> [context] --voice <voice-channel>` | Привязывает проектную сессию к голосовой комнате. |
122
+
123
+ ## Требования
124
+
125
+ | Уровень | По умолчанию |
126
+ |---|---|
127
+ | Среда выполнения | Node.js 20+, npm; установочный скрипт может установить через Homebrew/apt/dnf/pacman |
128
+ | Аудио | `ffmpeg`; установочный скрипт может установить его |
129
+ | Распознавание речи | Локальный `whisper-cli` из whisper.cpp; установочный скрипт использует Homebrew на macOS или локальную резервную сборку Linux |
130
+ | TTS | Edge TTS CLI; установочный скрипт создаёт `.venv-tts` при необходимости |
131
+ | Discord | Токен бота, intent Message Content, голосовые разрешения |
132
+ | Агент | Как минимум один аутентифицированный CLI-харнес, по умолчанию Hermes Agent |
133
+ | Основная платформа | macOS / Apple Silicon протестированы лучше всего; bootstrap для Linux предоставляется по мере возможностей и документирован |
134
+
135
+ ## Участие в разработке
136
+
137
+ Перед отправкой изменений выполните лёгкие проверки:
76
138
 
77
- ```text
78
- !join !ask <prompt> !verbose on/off
79
- !latency !sensitivity normal !sensitivity conservative
80
- !session new <name> <workdir> [context] --voice <voice-channel>
139
+ ```bash
140
+ node --check app-node/main.mjs
141
+ npm test
142
+ bash -n run.sh scripts/install.sh
143
+ npm pack --dry-run
144
+ vc doctor
81
145
  ```
82
146
 
83
- ## Requirements
147
+ ## Статус
84
148
 
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.
149
+ VerbalCoding ориентирован на публичный релиз, но всё ещё находится на ранней стадии. Демо-видео/GIF, более широкая проверка Linux, CI и более глубокий аудит безопасности пока остаются TODO.