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
@@ -0,0 +1,124 @@
1
+ # Instalación limpia
2
+
3
+ This guide mirrors the English fresh-install flow for Español. It is intended for a clean public install and avoids local-only assumptions.
4
+
5
+ ## 1. Install the CLI
6
+
7
+ ```bash
8
+ npm install -g verbalcoding
9
+ vc setup --yes
10
+ ```
11
+
12
+ Or run the published package directly:
13
+
14
+ ```bash
15
+ npx verbalcoding setup --yes
16
+ ```
17
+
18
+ Contributor clone path:
19
+
20
+ ```bash
21
+ git clone https://github.com/ca1773130n/VerbalCoding.git
22
+ cd VerbalCoding
23
+ ./scripts/install.sh --yes
24
+ ```
25
+
26
+ ## 2. Bootstrap dependencies
27
+
28
+ The setup flow installs npm dependencies when needed, links the short `vc` command for clone installs, installs `ffmpeg` / Node / `whisper-cli` where the OS package manager supports it, downloads `models/ggml-small-q5_1.bin`, creates `.venv-tts`, and writes `.env`.
29
+
30
+ Useful variants:
31
+
32
+ ```bash
33
+ vc setup --yes --no-wizard
34
+ ./scripts/install.sh --yes --no-wizard
35
+ ./scripts/install.sh --skip-system
36
+ ./scripts/install.sh --skip-model
37
+ ./scripts/install.sh --skip-edge-tts
38
+ VERBALCODING_SKIP_CLI_LINK=1 ./scripts/install.sh --yes
39
+ ```
40
+
41
+ Supported bootstrap paths: macOS/Homebrew, Debian/Ubuntu `apt`, Fedora/RHEL `dnf`, and Arch `pacman`. If unsupported, manually install Node.js 20+, npm, ffmpeg, Python 3, `whisper-cli`, and an authenticated CLI agent backend.
42
+
43
+ ## 3. Discord application setup
44
+
45
+ Read the upstream bot guides first:
46
+
47
+ - Hermes Agent Discord guide: <https://hermes-agent.nousresearch.com/docs/user-guide/messaging/discord>
48
+ - Discord official bot overview: <https://docs.discord.com/developers/bots/overview>
49
+ - Discord official getting started guide: <https://docs.discord.com/developers/quick-start/getting-started>
50
+
51
+ Create a Discord application and bot, enable the Message Content privileged intent, put the token in the installer or `.env` as `DISCORD_BOT_TOKEN`, then generate the invite URL:
52
+
53
+ ```bash
54
+ vc bot invite <discord-client-id>
55
+ vc bot invite <discord-client-id> --guild <guild-id>
56
+ ```
57
+
58
+ ## 4. Verify
59
+
60
+ ```bash
61
+ vc doctor
62
+ ```
63
+
64
+ `vc doctor` redacts secrets and reports missing commands/models/tokens without printing sensitive values. Expected success includes Node.js, npm, ffmpeg, whisper-cli, the model, Discord bot token configured, edge-tts, and the selected agent CLI.
65
+
66
+ ## 5. Run
67
+
68
+ ```bash
69
+ vc start
70
+ # or, from a GitHub clone:
71
+ ./run.sh
72
+ ```
73
+
74
+ Expected log lines:
75
+
76
+ ```text
77
+ Logged in as <bot-name>
78
+ Listening in voice channel <server> / <channel>
79
+ ```
80
+
81
+ In Discord:
82
+
83
+ ```text
84
+ !ping
85
+ !join
86
+ !ask say hello briefly
87
+ !verbose on
88
+ ```
89
+
90
+ Then speak in the configured voice channel. You should see STT text, progress text when verbose mode is on, a final text answer, and hear TTS playback.
91
+
92
+ ## 6. Project-per-room setup
93
+
94
+ For one permanent bot per project voice room, create one Discord application per project, then:
95
+
96
+ ```bash
97
+ vc instance setup my-project
98
+ vc bot invite <that-project-client-id>
99
+ vc instance start my-project
100
+ vc instance status my-project
101
+ ```
102
+
103
+ ## 7. Optional OpenVoice setup
104
+
105
+ Keep `TTS_BACKEND=edge` for a fresh install. To enable OpenVoice later:
106
+
107
+ ```bash
108
+ ./scripts/setup_openvoice.sh
109
+ # Download OpenVoice V2 checkpoints into vendor/OpenVoice/checkpoints_v2/
110
+ # Add a permitted local sample at voice-samples/user-reference.wav,
111
+ # or run the bot, say "목소리 샘플 녹음 시작해", then speak 10-30 seconds.
112
+ python3 integrations/openvoice/synth.py --openvoice-dir vendor/OpenVoice --ref-audio voice-samples/user-reference.wav --text '안녕하세요. 버벌코딩 목소리 복제 테스트입니다.' --output /tmp/verbalcoding-openvoice-smoke.wav
113
+ ```
114
+
115
+ Then set `TTS_BACKEND=openvoice`, run `vc doctor`, and test `!voice-test <text>` in Discord.
116
+
117
+ ## 8. Maintainer smoke tests
118
+
119
+ ```bash
120
+ ./scripts/install.sh --yes --no-wizard
121
+ npm pack --dry-run
122
+ vc doctor || true
123
+ ./scripts/docker_ubuntu_smoke.sh
124
+ ```
@@ -0,0 +1,124 @@
1
+ # Installation propre
2
+
3
+ This guide mirrors the English fresh-install flow for Français. It is intended for a clean public install and avoids local-only assumptions.
4
+
5
+ ## 1. Install the CLI
6
+
7
+ ```bash
8
+ npm install -g verbalcoding
9
+ vc setup --yes
10
+ ```
11
+
12
+ Or run the published package directly:
13
+
14
+ ```bash
15
+ npx verbalcoding setup --yes
16
+ ```
17
+
18
+ Contributor clone path:
19
+
20
+ ```bash
21
+ git clone https://github.com/ca1773130n/VerbalCoding.git
22
+ cd VerbalCoding
23
+ ./scripts/install.sh --yes
24
+ ```
25
+
26
+ ## 2. Bootstrap dependencies
27
+
28
+ The setup flow installs npm dependencies when needed, links the short `vc` command for clone installs, installs `ffmpeg` / Node / `whisper-cli` where the OS package manager supports it, downloads `models/ggml-small-q5_1.bin`, creates `.venv-tts`, and writes `.env`.
29
+
30
+ Useful variants:
31
+
32
+ ```bash
33
+ vc setup --yes --no-wizard
34
+ ./scripts/install.sh --yes --no-wizard
35
+ ./scripts/install.sh --skip-system
36
+ ./scripts/install.sh --skip-model
37
+ ./scripts/install.sh --skip-edge-tts
38
+ VERBALCODING_SKIP_CLI_LINK=1 ./scripts/install.sh --yes
39
+ ```
40
+
41
+ Supported bootstrap paths: macOS/Homebrew, Debian/Ubuntu `apt`, Fedora/RHEL `dnf`, and Arch `pacman`. If unsupported, manually install Node.js 20+, npm, ffmpeg, Python 3, `whisper-cli`, and an authenticated CLI agent backend.
42
+
43
+ ## 3. Discord application setup
44
+
45
+ Read the upstream bot guides first:
46
+
47
+ - Hermes Agent Discord guide: <https://hermes-agent.nousresearch.com/docs/user-guide/messaging/discord>
48
+ - Discord official bot overview: <https://docs.discord.com/developers/bots/overview>
49
+ - Discord official getting started guide: <https://docs.discord.com/developers/quick-start/getting-started>
50
+
51
+ Create a Discord application and bot, enable the Message Content privileged intent, put the token in the installer or `.env` as `DISCORD_BOT_TOKEN`, then generate the invite URL:
52
+
53
+ ```bash
54
+ vc bot invite <discord-client-id>
55
+ vc bot invite <discord-client-id> --guild <guild-id>
56
+ ```
57
+
58
+ ## 4. Verify
59
+
60
+ ```bash
61
+ vc doctor
62
+ ```
63
+
64
+ `vc doctor` redacts secrets and reports missing commands/models/tokens without printing sensitive values. Expected success includes Node.js, npm, ffmpeg, whisper-cli, the model, Discord bot token configured, edge-tts, and the selected agent CLI.
65
+
66
+ ## 5. Run
67
+
68
+ ```bash
69
+ vc start
70
+ # or, from a GitHub clone:
71
+ ./run.sh
72
+ ```
73
+
74
+ Expected log lines:
75
+
76
+ ```text
77
+ Logged in as <bot-name>
78
+ Listening in voice channel <server> / <channel>
79
+ ```
80
+
81
+ In Discord:
82
+
83
+ ```text
84
+ !ping
85
+ !join
86
+ !ask say hello briefly
87
+ !verbose on
88
+ ```
89
+
90
+ Then speak in the configured voice channel. You should see STT text, progress text when verbose mode is on, a final text answer, and hear TTS playback.
91
+
92
+ ## 6. Project-per-room setup
93
+
94
+ For one permanent bot per project voice room, create one Discord application per project, then:
95
+
96
+ ```bash
97
+ vc instance setup my-project
98
+ vc bot invite <that-project-client-id>
99
+ vc instance start my-project
100
+ vc instance status my-project
101
+ ```
102
+
103
+ ## 7. Optional OpenVoice setup
104
+
105
+ Keep `TTS_BACKEND=edge` for a fresh install. To enable OpenVoice later:
106
+
107
+ ```bash
108
+ ./scripts/setup_openvoice.sh
109
+ # Download OpenVoice V2 checkpoints into vendor/OpenVoice/checkpoints_v2/
110
+ # Add a permitted local sample at voice-samples/user-reference.wav,
111
+ # or run the bot, say "목소리 샘플 녹음 시작해", then speak 10-30 seconds.
112
+ python3 integrations/openvoice/synth.py --openvoice-dir vendor/OpenVoice --ref-audio voice-samples/user-reference.wav --text '안녕하세요. 버벌코딩 목소리 복제 테스트입니다.' --output /tmp/verbalcoding-openvoice-smoke.wav
113
+ ```
114
+
115
+ Then set `TTS_BACKEND=openvoice`, run `vc doctor`, and test `!voice-test <text>` in Discord.
116
+
117
+ ## 8. Maintainer smoke tests
118
+
119
+ ```bash
120
+ ./scripts/install.sh --yes --no-wizard
121
+ npm pack --dry-run
122
+ vc doctor || true
123
+ ./scripts/docker_ubuntu_smoke.sh
124
+ ```
@@ -0,0 +1,124 @@
1
+ # 新規インストール
2
+
3
+ This guide mirrors the English fresh-install flow for 日本語. It is intended for a clean public install and avoids local-only assumptions.
4
+
5
+ ## 1. Install the CLI
6
+
7
+ ```bash
8
+ npm install -g verbalcoding
9
+ vc setup --yes
10
+ ```
11
+
12
+ Or run the published package directly:
13
+
14
+ ```bash
15
+ npx verbalcoding setup --yes
16
+ ```
17
+
18
+ Contributor clone path:
19
+
20
+ ```bash
21
+ git clone https://github.com/ca1773130n/VerbalCoding.git
22
+ cd VerbalCoding
23
+ ./scripts/install.sh --yes
24
+ ```
25
+
26
+ ## 2. Bootstrap dependencies
27
+
28
+ The setup flow installs npm dependencies when needed, links the short `vc` command for clone installs, installs `ffmpeg` / Node / `whisper-cli` where the OS package manager supports it, downloads `models/ggml-small-q5_1.bin`, creates `.venv-tts`, and writes `.env`.
29
+
30
+ Useful variants:
31
+
32
+ ```bash
33
+ vc setup --yes --no-wizard
34
+ ./scripts/install.sh --yes --no-wizard
35
+ ./scripts/install.sh --skip-system
36
+ ./scripts/install.sh --skip-model
37
+ ./scripts/install.sh --skip-edge-tts
38
+ VERBALCODING_SKIP_CLI_LINK=1 ./scripts/install.sh --yes
39
+ ```
40
+
41
+ Supported bootstrap paths: macOS/Homebrew, Debian/Ubuntu `apt`, Fedora/RHEL `dnf`, and Arch `pacman`. If unsupported, manually install Node.js 20+, npm, ffmpeg, Python 3, `whisper-cli`, and an authenticated CLI agent backend.
42
+
43
+ ## 3. Discord application setup
44
+
45
+ Read the upstream bot guides first:
46
+
47
+ - Hermes Agent Discord guide: <https://hermes-agent.nousresearch.com/docs/user-guide/messaging/discord>
48
+ - Discord official bot overview: <https://docs.discord.com/developers/bots/overview>
49
+ - Discord official getting started guide: <https://docs.discord.com/developers/quick-start/getting-started>
50
+
51
+ Create a Discord application and bot, enable the Message Content privileged intent, put the token in the installer or `.env` as `DISCORD_BOT_TOKEN`, then generate the invite URL:
52
+
53
+ ```bash
54
+ vc bot invite <discord-client-id>
55
+ vc bot invite <discord-client-id> --guild <guild-id>
56
+ ```
57
+
58
+ ## 4. Verify
59
+
60
+ ```bash
61
+ vc doctor
62
+ ```
63
+
64
+ `vc doctor` redacts secrets and reports missing commands/models/tokens without printing sensitive values. Expected success includes Node.js, npm, ffmpeg, whisper-cli, the model, Discord bot token configured, edge-tts, and the selected agent CLI.
65
+
66
+ ## 5. Run
67
+
68
+ ```bash
69
+ vc start
70
+ # or, from a GitHub clone:
71
+ ./run.sh
72
+ ```
73
+
74
+ Expected log lines:
75
+
76
+ ```text
77
+ Logged in as <bot-name>
78
+ Listening in voice channel <server> / <channel>
79
+ ```
80
+
81
+ In Discord:
82
+
83
+ ```text
84
+ !ping
85
+ !join
86
+ !ask say hello briefly
87
+ !verbose on
88
+ ```
89
+
90
+ Then speak in the configured voice channel. You should see STT text, progress text when verbose mode is on, a final text answer, and hear TTS playback.
91
+
92
+ ## 6. Project-per-room setup
93
+
94
+ For one permanent bot per project voice room, create one Discord application per project, then:
95
+
96
+ ```bash
97
+ vc instance setup my-project
98
+ vc bot invite <that-project-client-id>
99
+ vc instance start my-project
100
+ vc instance status my-project
101
+ ```
102
+
103
+ ## 7. Optional OpenVoice setup
104
+
105
+ Keep `TTS_BACKEND=edge` for a fresh install. To enable OpenVoice later:
106
+
107
+ ```bash
108
+ ./scripts/setup_openvoice.sh
109
+ # Download OpenVoice V2 checkpoints into vendor/OpenVoice/checkpoints_v2/
110
+ # Add a permitted local sample at voice-samples/user-reference.wav,
111
+ # or run the bot, say "목소리 샘플 녹음 시작해", then speak 10-30 seconds.
112
+ python3 integrations/openvoice/synth.py --openvoice-dir vendor/OpenVoice --ref-audio voice-samples/user-reference.wav --text '안녕하세요. 버벌코딩 목소리 복제 테스트입니다.' --output /tmp/verbalcoding-openvoice-smoke.wav
113
+ ```
114
+
115
+ Then set `TTS_BACKEND=openvoice`, run `vc doctor`, and test `!voice-test <text>` in Discord.
116
+
117
+ ## 8. Maintainer smoke tests
118
+
119
+ ```bash
120
+ ./scripts/install.sh --yes --no-wizard
121
+ npm pack --dry-run
122
+ vc doctor || true
123
+ ./scripts/docker_ubuntu_smoke.sh
124
+ ```
@@ -1,28 +1,21 @@
1
- # VerbalCoding 새 설치 가이드
1
+ # 새 설치
2
2
 
3
- 문서는 공개 npm 패키지 또는 깨끗한 GitHub 클론에서 처음 설치하는 흐름을 설명합니다. 로컬 전용 가정을 피하고, 설치 스크립트가 가능한 한 많은 준비 작업을 자동화하도록 구성돼 있습니다.
3
+ This guide mirrors the English fresh-install flow for 한국어. It is intended for a clean public install and avoids local-only assumptions.
4
4
 
5
- ## 1. CLI 설치
6
-
7
- 권장 npm 설치:
5
+ ## 1. Install the CLI
8
6
 
9
7
  ```bash
10
8
  npm install -g verbalcoding
9
+ vc setup --yes
11
10
  ```
12
11
 
13
- 전역 설치 없이 바로 실행하려면:
12
+ Or run the published package directly:
14
13
 
15
14
  ```bash
16
15
  npx verbalcoding setup --yes
17
16
  ```
18
17
 
19
- 전역 설치를 했다면 이어서:
20
-
21
- ```bash
22
- vc setup --yes
23
- ```
24
-
25
- 기여자용 GitHub 클론 경로:
18
+ Contributor clone path:
26
19
 
27
20
  ```bash
28
21
  git clone https://github.com/ca1773130n/VerbalCoding.git
@@ -30,114 +23,62 @@ cd VerbalCoding
30
23
  ./scripts/install.sh --yes
31
24
  ```
32
25
 
33
- ## 2. 의존성 부트스트랩과 설정 마법사
34
-
35
- npm 명령은 클론 설치와 같은 부트스트래퍼를 실행합니다. 클론에서는 다음을 실행합니다.
36
-
37
- ```bash
38
- ./scripts/install.sh --yes
39
- ```
40
-
41
- 이 명령이 하는 일:
42
-
43
- - `node_modules/`가 없으면 npm 의존성을 설치합니다.
44
- - 클론 설치에서는 짧은 `vc` 셸 명령을 `npm link`로 연결합니다.
45
- - OS 패키지 매니저가 지원되면 `ffmpeg`, Node/npm, `whisper-cli`를 설치합니다.
46
- - 기본 모델 `models/ggml-small-q5_1.bin`을 다운로드합니다.
47
- - `edge-tts`가 PATH에 없으면 `.venv-tts`를 만들고 Edge TTS helper를 설치합니다.
48
- - 대화형 `.env` 설정 마법사를 실행합니다.
26
+ ## 2. Bootstrap dependencies
49
27
 
50
- 지원되는 시스템 부트스트랩 경로:
28
+ The setup flow installs npm dependencies when needed, links the short `vc` command for clone installs, installs `ffmpeg` / Node / `whisper-cli` where the OS package manager supports it, downloads `models/ggml-small-q5_1.bin`, creates `.venv-tts`, and writes `.env`.
51
29
 
52
- | OS | 시스템 의존성 경로 |
53
- |---|---|
54
- | macOS | Homebrew: 필요 시 `brew install node ffmpeg whisper-cpp` |
55
- | Debian/Ubuntu | `apt-get`으로 Node/npm, ffmpeg, Python, build tools 설치; 필요 시 로컬 whisper.cpp 빌드 |
56
- | Fedora/RHEL | `dnf`로 Node/npm, ffmpeg, Python, build tools 설치; 필요 시 로컬 whisper.cpp 빌드 |
57
- | Arch | `pacman`으로 Node/npm, ffmpeg, Python, build tools 설치; 필요 시 로컬 whisper.cpp 빌드 |
58
-
59
- 유용한 설치 변형:
30
+ Useful variants:
60
31
 
61
32
  ```bash
62
- vc setup --yes --no-wizard # npm 설치에서 의존성만 준비
63
- ./scripts/install.sh --yes --no-wizard # 클론에서 의존성만 준비
64
- ./scripts/install.sh --skip-system # OS 패키지는 직접 설치
65
- ./scripts/install.sh --skip-model # 기본 STT 모델 다운로드 생략
66
- ./scripts/install.sh --skip-edge-tts # .venv-tts 생성 생략
33
+ vc setup --yes --no-wizard
34
+ ./scripts/install.sh --yes --no-wizard
35
+ ./scripts/install.sh --skip-system
36
+ ./scripts/install.sh --skip-model
37
+ ./scripts/install.sh --skip-edge-tts
67
38
  VERBALCODING_SKIP_CLI_LINK=1 ./scripts/install.sh --yes
68
39
  ```
69
40
 
70
- OS가 지원되지 않으면 아래를 직접 설치한 다시 실행하세요.
41
+ Supported bootstrap paths: macOS/Homebrew, Debian/Ubuntu `apt`, Fedora/RHEL `dnf`, and Arch `pacman`. If unsupported, manually install Node.js 20+, npm, ffmpeg, Python 3, `whisper-cli`, and an authenticated CLI agent backend.
71
42
 
72
- - Node.js 20+ npm
73
- - ffmpeg
74
- - venv/pip가 포함된 Python 3
75
- - whisper.cpp `whisper-cli`
76
- - 인증된 CLI 에이전트 백엔드 하나 이상; 기본은 Hermes Agent
43
+ ## 3. Discord application setup
77
44
 
78
- ## 3. Discord 애플리케이션 설정
45
+ Read the upstream bot guides first:
79
46
 
80
- Discord 봇을 처음 만든다면 먼저 공식/상위 문서를 확인하세요.
47
+ - Hermes Agent Discord guide: <https://hermes-agent.nousresearch.com/docs/user-guide/messaging/discord>
48
+ - Discord official bot overview: <https://docs.discord.com/developers/bots/overview>
49
+ - Discord official getting started guide: <https://docs.discord.com/developers/quick-start/getting-started>
81
50
 
82
- - Hermes Agent Discord 메시징 가이드: <https://hermes-agent.nousresearch.com/docs/user-guide/messaging/discord>
83
- - Discord 공식 봇 개요: <https://docs.discord.com/developers/bots/overview>
84
- - Discord 공식 시작 가이드: <https://docs.discord.com/developers/quick-start/getting-started>
85
-
86
- 위 문서에는 Discord 애플리케이션 생성, bot user 추가, privileged intent 활성화, 서버 초대 방법이 설명되어 있습니다. VerbalCoding도 같은 Discord bot 설정을 사용하고, 그 위에 음성 수신, STT, CLI 에이전트 실행, TTS 재생을 얹습니다.
87
-
88
- 1. Discord Developer Portal에서 애플리케이션과 봇을 만듭니다.
89
- 2. Message Content privileged intent를 켭니다.
90
- 3. 봇 토큰을 설치 프롬프트 또는 `.env`의 `DISCORD_BOT_TOKEN`에 넣습니다.
91
- 4. 초대 URL을 생성합니다.
51
+ Create a Discord application and bot, enable the Message Content privileged intent, put the token in the installer or `.env` as `DISCORD_BOT_TOKEN`, then generate the invite URL:
92
52
 
93
53
  ```bash
94
54
  vc bot invite <discord-client-id>
95
- # 특정 서버로 고정하려면:
96
55
  vc bot invite <discord-client-id> --guild <guild-id>
97
56
  ```
98
57
 
99
- 초대 URL에는 VerbalCoding이 쓰는 bot/application command scope와 텍스트/음성 권한이 포함됩니다.
100
-
101
- ## 4. 검증
58
+ ## 4. Verify
102
59
 
103
60
  ```bash
104
61
  vc doctor
105
62
  ```
106
63
 
107
- `vc doctor`는 토큰을 숨깁니다. 필요한 토큰, 명령, 모델이 있는지만 보여주고 비밀값은 출력하지 않습니다. 모든 `✗` 항목을 고친 다시 실행하세요.
108
-
109
- 성공 예시는 다음과 같습니다.
110
-
111
- ```text
112
- ✓ Node.js
113
- ✓ npm
114
- ✓ ffmpeg
115
- ✓ whisper-cli
116
- ✓ whisper.cpp model
117
- ✓ Discord bot token configured — [REDACTED]
118
- ✓ edge-tts
119
- ✓ hermes CLI
120
- Doctor passed. Run vc start to start VerbalCoding.
121
- ```
122
-
123
- 설치기가 로컬 Edge TTS helper를 만들었다면 `.env`에는 `.venv-tts/bin/edge-tts`를 가리키는 `EDGE_TTS_COMMAND` 경로가 들어갑니다.
64
+ `vc doctor` redacts secrets and reports missing commands/models/tokens without printing sensitive values. Expected success includes Node.js, npm, ffmpeg, whisper-cli, the model, Discord bot token configured, edge-tts, and the selected agent CLI.
124
65
 
125
- ## 5. 기본 단일 봇 실행
66
+ ## 5. Run
126
67
 
127
68
  ```bash
128
69
  vc start
129
- # 또는 GitHub 클론에서:
70
+ # or, from a GitHub clone:
130
71
  ./run.sh
131
72
  ```
132
73
 
133
- 성공한 시작 로그에는 다음 줄이 보입니다.
74
+ Expected log lines:
134
75
 
135
76
  ```text
136
77
  Logged in as <bot-name>
137
78
  Listening in voice channel <server> / <channel>
138
79
  ```
139
80
 
140
- Discord에서:
81
+ In Discord:
141
82
 
142
83
  ```text
143
84
  !ping
@@ -146,11 +87,11 @@ Discord에서:
146
87
  !verbose on
147
88
  ```
148
89
 
149
- 다음 설정된 음성 채널에서 말해 보세요. STT 텍스트, verbose 모드의 진행 텍스트, 최종 텍스트 답변, TTS 재생을 확인할 있어야 합니다.
90
+ Then speak in the configured voice channel. You should see STT text, progress text when verbose mode is on, a final text answer, and hear TTS playback.
150
91
 
151
- ## 6. 프로젝트별 음성방 설정
92
+ ## 6. Project-per-room setup
152
93
 
153
- 프로젝트 음성방마다 영구 하나를 두려면 프로젝트마다 Discord 애플리케이션을 만든 뒤:
94
+ For one permanent bot per project voice room, create one Discord application per project, then:
154
95
 
155
96
  ```bash
156
97
  vc instance setup my-project
@@ -159,43 +100,25 @@ vc instance start my-project
159
100
  vc instance status my-project
160
101
  ```
161
102
 
162
- 인스턴스는 무시되는 `instances/<name>.env`를 작성합니다. 이 파일에는 해당 봇의 토큰, 음성 채널, transcript 대상, 로그 경로, Hermes 세션 파일, 선택적 Hermes 프로필 정보가 들어갑니다.
103
+ ## 7. Optional OpenVoice setup
163
104
 
164
- ## 7. 선택: OpenVoice 설정
165
-
166
- OpenVoice 음성 복제는 선택 기능입니다. 공개 설치 직후에는 `TTS_BACKEND=edge`를 유지하세요. 나중에 OpenVoice를 켜려면:
105
+ Keep `TTS_BACKEND=edge` for a fresh install. To enable OpenVoice later:
167
106
 
168
107
  ```bash
169
108
  ./scripts/setup_openvoice.sh
170
- # OpenVoice V2 체크포인트를 vendor/OpenVoice/checkpoints_v2/ 아래에 넣습니다.
171
- # 허가된 로컬 샘플을 voice-samples/user-reference.wav에 두거나,
172
- # 실행 “목소리 샘플 녹음 시작해”라고 말하고 10~30 발화합니다.
109
+ # Download OpenVoice V2 checkpoints into vendor/OpenVoice/checkpoints_v2/
110
+ # Add a permitted local sample at voice-samples/user-reference.wav,
111
+ # or run the bot, say "목소리 샘플 녹음 시작해", then speak 10-30 seconds.
173
112
  python3 integrations/openvoice/synth.py --openvoice-dir vendor/OpenVoice --ref-audio voice-samples/user-reference.wav --text '안녕하세요. 버벌코딩 목소리 복제 테스트입니다.' --output /tmp/verbalcoding-openvoice-smoke.wav
174
113
  ```
175
114
 
176
- `TTS_BACKEND=openvoice`로 설정하고 `vc doctor`, Discord의 `!voice-test <text>`로 테스트합니다.
177
-
178
- ## 8. 유지보수자용 클린 설치 스모크 테스트
115
+ Then set `TTS_BACKEND=openvoice`, run `vc doctor`, and test `!voice-test <text>` in Discord.
179
116
 
180
- 빠른 호스트 스모크 테스트:
117
+ ## 8. Maintainer smoke tests
181
118
 
182
119
  ```bash
183
- TMPDIR=$(mktemp -d)
184
- git clone https://github.com/ca1773130n/VerbalCoding.git "$TMPDIR/VerbalCoding"
185
- cd "$TMPDIR/VerbalCoding"
186
120
  ./scripts/install.sh --yes --no-wizard
187
121
  npm pack --dry-run
188
- cp .env.example .env
189
- chmod 600 .env
190
122
  vc doctor || true
191
- ```
192
-
193
- 이 시점에서 예상되는 실패는 로컬 비밀값 누락 또는 인증되지 않은 에이전트 CLI입니다. 토큰 노출이나 설치 스크립트 누락이 나오면 안 됩니다.
194
-
195
- Docker 기반 Ubuntu 클린 설치 스모크 테스트:
196
-
197
- ```bash
198
123
  ./scripts/docker_ubuntu_smoke.sh
199
124
  ```
200
-
201
- 이 스크립트는 `ubuntu:24.04`에서 추적된 저장소 트리를 깨끗한 컨테이너로 복사하고, `./scripts/install.sh --yes --no-wizard`를 실행하고, 비밀값 없는 smoke `.env`를 만든 뒤 `vc`, Node 테스트, `vc doctor`를 확인합니다. Discord 음성 연결까지는 하지 않습니다. 실제 end-to-end 음성 테스트는 Ubuntu VM 또는 WSL2에서 별도로 진행하세요.