vocalize-cli 0.11.0__tar.gz → 0.12.0__tar.gz

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 (214) hide show
  1. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/CHANGELOG.md +102 -0
  2. vocalize_cli-0.11.0/README.md → vocalize_cli-0.12.0/PKG-INFO +106 -47
  3. vocalize_cli-0.11.0/PKG-INFO → vocalize_cli-0.12.0/README.md +70 -83
  4. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/dictation.md +28 -14
  5. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/installation.md +1 -1
  6. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/choreography.md +110 -0
  7. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/decisions.md +509 -0
  8. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/design.md +355 -0
  9. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/plan.md +331 -0
  10. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/review-0.12.0.md +142 -0
  11. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/review-plan-2026-09-06.md +41 -0
  12. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-1-local-first-defaults/project-plan.md +76 -0
  13. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-1-local-first-defaults/report.md +16 -0
  14. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-1-local-first-defaults/task-report.md +30 -0
  15. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-1-local-first-defaults/validate-exit.sh +134 -0
  16. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-10-release-0-13-0/project-plan.md +50 -0
  17. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-10-release-0-13-0/validate-exit.sh +124 -0
  18. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-11-cue-hold-paste/project-plan.md +52 -0
  19. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-11-cue-hold-paste/validate-exit.sh +125 -0
  20. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-11b-playback-pause/project-plan.md +54 -0
  21. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-11b-playback-pause/validate-exit.sh +128 -0
  22. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-12-release-0-13-1/project-plan.md +47 -0
  23. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-12-release-0-13-1/validate-exit.sh +122 -0
  24. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-13-spikes/project-plan.md +45 -0
  25. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-13-spikes/validate-exit.sh +114 -0
  26. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-14-local-llm/project-plan.md +50 -0
  27. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-14-local-llm/validate-exit.sh +124 -0
  28. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-15-notes/project-plan.md +48 -0
  29. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-15-notes/validate-exit.sh +111 -0
  30. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-15b-recording-pause/project-plan.md +57 -0
  31. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-15b-recording-pause/validate-exit.sh +131 -0
  32. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-16-release-0-14-0/project-plan.md +50 -0
  33. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-16-release-0-14-0/validate-exit.sh +124 -0
  34. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-17-optional-spikes/project-plan.md +44 -0
  35. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-17-optional-spikes/validate-exit.sh +118 -0
  36. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-2-stt-decoding/project-plan.md +49 -0
  37. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-2-stt-decoding/report.md +16 -0
  38. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-2-stt-decoding/task-report.md +35 -0
  39. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-2-stt-decoding/validate-exit.sh +113 -0
  40. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-3-llm-and-enums/project-plan.md +55 -0
  41. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-3-llm-and-enums/report.md +20 -0
  42. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-3-llm-and-enums/task-report.md +36 -0
  43. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-3-llm-and-enums/validate-exit.sh +152 -0
  44. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-4-keychain/project-plan.md +80 -0
  45. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-4-keychain/report.md +16 -0
  46. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-4-keychain/task-report.md +34 -0
  47. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-4-keychain/validate-exit.sh +134 -0
  48. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-5-keys-tab/project-plan.md +47 -0
  49. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-5-keys-tab/report.md +24 -0
  50. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-5-keys-tab/task-report.md +31 -0
  51. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-5-keys-tab/validate-exit.sh +118 -0
  52. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-6-release-0-12-0/project-plan.md +50 -0
  53. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-6-release-0-12-0/validate-exit.sh +124 -0
  54. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-7-hotkey-spike-and-builder/project-plan.md +45 -0
  55. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-7-hotkey-spike-and-builder/validate-exit.sh +113 -0
  56. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-8a-app-swift/project-plan.md +44 -0
  57. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-8a-app-swift/validate-exit.sh +115 -0
  58. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-8b-app-python/project-plan.md +49 -0
  59. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-8b-app-python/validate-exit.sh +119 -0
  60. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-9-doctor-integrate-setup/project-plan.md +48 -0
  61. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/run-9-doctor-integrate-setup/validate-exit.sh +121 -0
  62. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/spike-notes.md +38 -0
  63. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/split-assessment.md +57 -0
  64. vocalize_cli-0.12.0/docs/plans/2026-09-app-roadmap/verification.md +216 -0
  65. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-10-release-0-11-0/report.md +8 -1
  66. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/provider-credentials.md +72 -0
  67. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/roadmap.md +2 -1
  68. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/speak_options.py +4 -1
  69. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/pyproject.toml +2 -2
  70. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/conftest.py +5 -0
  71. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/portal_page_harness.js +102 -1
  72. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_auth.py +206 -1
  73. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_chain.py +39 -0
  74. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_cli.py +84 -5
  75. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_config.py +165 -7
  76. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_dictate.py +75 -114
  77. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_http.py +19 -0
  78. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_listen_check.py +3 -2
  79. vocalize_cli-0.12.0/tests/test_llm.py +491 -0
  80. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_local_install.py +4 -1
  81. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_portal.py +287 -3
  82. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_portal_assets.py +17 -5
  83. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_readiness.py +5 -0
  84. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_speak_options.py +12 -0
  85. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_whisper_manifest.py +22 -5
  86. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_whisper_worker.py +73 -2
  87. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_wizard.py +24 -2
  88. vocalize_cli-0.12.0/uv.lock +1571 -0
  89. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/__init__.py +2 -2
  90. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/portal.js +122 -13
  91. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/auth.py +184 -8
  92. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/chain.py +21 -1
  93. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/cli.py +45 -22
  94. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/config.py +171 -10
  95. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/dictate.py +29 -77
  96. vocalize_cli-0.12.0/vocalize/llm.py +315 -0
  97. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/whisper_manifest.py +11 -2
  98. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/whisper_worker.py +39 -2
  99. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/portal.py +120 -8
  100. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/_http.py +9 -0
  101. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/kokoro.py +2 -1
  102. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/readiness.py +1 -1
  103. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/wizard.py +7 -1
  104. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/.env.example +0 -0
  105. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/.github/workflows/ci.yml +0 -0
  106. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/.gitignore +0 -0
  107. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/LICENSE +0 -0
  108. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/next-features-analysis.md +0 -0
  109. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/choreography.md +0 -0
  110. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/decisions.md +0 -0
  111. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/design.md +0 -0
  112. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/plan.md +0 -0
  113. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/review-0.10.0.md +0 -0
  114. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/review-0.11.0.md +0 -0
  115. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-1-status/project-plan.md +0 -0
  116. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-1-status/report.md +0 -0
  117. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-1-status/validate-exit.sh +0 -0
  118. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-10-release-0-11-0/project-plan.md +0 -0
  119. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-10-release-0-11-0/validate-exit.sh +0 -0
  120. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-2-stt-runtime/project-plan.md +0 -0
  121. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-2-stt-runtime/report.md +0 -0
  122. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-2-stt-runtime/validate-exit.sh +0 -0
  123. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-3-recorder/project-plan.md +0 -0
  124. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-3-recorder/report.md +0 -0
  125. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-3-recorder/validate-exit.sh +0 -0
  126. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-4-dictation/project-plan.md +0 -0
  127. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-4-dictation/report.md +0 -0
  128. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-4-dictation/validate-exit.sh +0 -0
  129. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-5-resume/project-plan.md +0 -0
  130. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-5-resume/report.md +0 -0
  131. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-5-resume/validate-exit.sh +0 -0
  132. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-6-release-0-10-0/project-plan.md +0 -0
  133. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-6-release-0-10-0/report.md +0 -0
  134. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-6-release-0-10-0/validate-exit.sh +0 -0
  135. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-7-portal-read/project-plan.md +0 -0
  136. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-7-portal-read/report.md +0 -0
  137. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-7-portal-read/review-findings.md +0 -0
  138. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-7-portal-read/validate-exit.sh +0 -0
  139. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-8-portal-write/project-plan.md +0 -0
  140. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-8-portal-write/report.md +0 -0
  141. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-8-portal-write/validate-exit.sh +0 -0
  142. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-9-portal-page/project-plan.md +0 -0
  143. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-9-portal-page/report.md +0 -0
  144. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-9-portal-page/review-findings.md +0 -0
  145. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/run-9-portal-page/validate-exit.sh +0 -0
  146. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/spike-2026-09-01.md +0 -0
  147. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/split-assessment.md +0 -0
  148. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/plans/2026-09-next-features/verification.md +0 -0
  149. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/research/2026-09-01-config-portal-design.md +0 -0
  150. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/research/2026-09-01-dictation-design.md +0 -0
  151. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/research/2026-09-01-voicebox-findings.md +0 -0
  152. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/docs/research/2026-09-04-app-roadmap-analysis.md +0 -0
  153. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/claude_stop_hook.py +0 -0
  154. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/install_hook.py +0 -0
  155. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/install_quick_action.py +0 -0
  156. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Dictate with Vocalize.workflow/Contents/Info.plist +0 -0
  157. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Dictate with Vocalize.workflow/Contents/Resources/document.wflow +0 -0
  158. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Speak Latest Plan.workflow/Contents/Info.plist +0 -0
  159. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Speak Latest Plan.workflow/Contents/Resources/document.wflow +0 -0
  160. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Speak with Vocalize.workflow/Contents/Info.plist +0 -0
  161. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Speak with Vocalize.workflow/Contents/Resources/document.wflow +0 -0
  162. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Stop Vocalize.workflow/Contents/Info.plist +0 -0
  163. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/quick_actions/Stop Vocalize.workflow/Contents/Resources/document.wflow +0 -0
  164. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/hooks/speak_url_gate.py +0 -0
  165. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_audio.py +0 -0
  166. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_cache.py +0 -0
  167. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_claude_stop_hook.py +0 -0
  168. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_clipboard.py +0 -0
  169. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_cue_assets.py +0 -0
  170. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_elevenlabs_provider.py +0 -0
  171. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_exceptions.py +0 -0
  172. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_google_provider.py +0 -0
  173. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_install_hook.py +0 -0
  174. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_install_quick_action.py +0 -0
  175. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_kokoro_manifest.py +0 -0
  176. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_kokoro_provider.py +0 -0
  177. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_kokoro_worker.py +0 -0
  178. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_ledger.py +0 -0
  179. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_openai_provider.py +0 -0
  180. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_polly_provider.py +0 -0
  181. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_preprocess.py +0 -0
  182. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_providers_registry.py +0 -0
  183. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_recorder_build.py +0 -0
  184. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_say_provider.py +0 -0
  185. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_speak_url_gate.py +0 -0
  186. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_tts.py +0 -0
  187. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/tests/test_uv_path.py +0 -0
  188. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/__main__.py +0 -0
  189. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/cues/README.md +0 -0
  190. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/cues/ready.wav +0 -0
  191. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/cues/start.wav +0 -0
  192. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/cues/stopped.wav +0 -0
  193. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/assets/portal.html +0 -0
  194. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/audio.py +0 -0
  195. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/cache.py +0 -0
  196. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/clipboard.py +0 -0
  197. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/exceptions.py +0 -0
  198. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/interrupted.py +0 -0
  199. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/ledger.py +0 -0
  200. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/__init__.py +0 -0
  201. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/install.py +0 -0
  202. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/kokoro_manifest.py +0 -0
  203. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/local/kokoro_worker.py +0 -0
  204. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/preprocess.py +0 -0
  205. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/__init__.py +0 -0
  206. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/elevenlabs.py +0 -0
  207. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/google.py +0 -0
  208. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/openai.py +0 -0
  209. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/polly.py +0 -0
  210. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/providers/say.py +0 -0
  211. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/recorder/Info.plist.in +0 -0
  212. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/recorder/Recorder.entitlements +0 -0
  213. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/recorder/VocalizeRecorder.swift +0 -0
  214. {vocalize_cli-0.11.0 → vocalize_cli-0.12.0}/vocalize/tts.py +0 -0
@@ -3,6 +3,108 @@
3
3
  All notable changes to this project are documented here. Format follows
4
4
  [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
5
5
 
6
+ ## Unreleased
7
+
8
+ Nothing yet.
9
+
10
+ ## 0.12.0 - 2026-09-07
11
+
12
+ ### Changed
13
+
14
+ - **The default chain is now `kokoro`, then `say`.** A config with no
15
+ `chain` used to try ElevenLabs first; it now tries the on-device voice
16
+ first and falls back to macOS `say`. When `say` speaks because the Kokoro
17
+ model was never installed, the fallback line says so once and names the
18
+ fix: `vocalize local install`. Users who never set a chain hear `say`
19
+ after upgrading until they run that install; anyone with an explicit
20
+ `chain` sees no change. `vocalize usage`, `vocalize status` and the portal
21
+ now list the local providers first.
22
+ - **Dictation decodes with beam search.** whisper.cpp ran with its greedy
23
+ decoder, which merged words on fast speech ("toget" for "to get",
24
+ [#4](https://github.com/matthager12-collab/vocalize/issues/4)). The worker
25
+ now uses beam search with five beams, whisper.cpp's own default for that
26
+ strategy. `[stt] beam_size` (1–8) is the escape hatch: `1` restores the
27
+ greedy decoder if a take is slow to land on your machine. Honest result:
28
+ on the owner's own voice both decoders still produced "themerge" for
29
+ "the merge", so beam search improves decoding but does not close #4;
30
+ that issue stays open. The cost was measured on a 43 s synthetic clip
31
+ and recorded in `docs/plans/2026-09-app-roadmap/spike-notes.md`.
32
+
33
+ - **The default dictation model is now `large-v3-turbo-q5_0`.** On the
34
+ owner's own voice it was the first model to keep "the merge" as two
35
+ words ([#4](https://github.com/matthager12-collab/vocalize/issues/4));
36
+ beam search alone did not. It is no slower than `small.en` on an M4 and
37
+ uses about 90 MB more. **Upgrade note:** if your `[stt]` table sets no
38
+ `model`, dictation looks for the new default — run
39
+ `vocalize local install --stt` once (547 MB), or set
40
+ `model = "small.en"` to keep the lighter model.
41
+ - **`[stt] cleanup` names where the cleanup pass runs.** It was `true` or
42
+ `false`; it is now `off`, `claude-cli`, `anthropic` or `local` (`local`
43
+ is accepted today and honoured from 0.14.0). Older `true` / `false`
44
+ values keep working. The pass lives in a new `vocalize/llm.py`, one seam
45
+ for every language-model call, and the default prompt now also drops
46
+ restatements, false starts and filler
47
+ ([#3](https://github.com/matthager12-collab/vocalize/issues/3)); say
48
+ "verbatim" as the first word of a take, pass `--verbatim`, or set
49
+ `[stt] verbatim = true` to keep every word.
50
+ - **Every cloud send is visible.** One stderr line, `vocalize: sent to
51
+ <backend>`, prints immediately before text leaves the machine and never
52
+ otherwise; the clipboard notification for a cleaned take says "cleaned
53
+ up by Claude — sent off this Mac".
54
+ - **`claude -p` sessions are tighter.** The cleanup pass and the plan-
55
+ speaking hook now pass `--strict-mcp-config`, run from the system
56
+ temporary directory, and the cleanup pass excludes your own hooks,
57
+ skills and `CLAUDE.md` (`--setting-sources ""`) and strips any stored
58
+ Anthropic key from the child's environment.
59
+ - **Provider settings are type-checked** (issue
60
+ [#5](https://github.com/matthager12-collab/vocalize/issues/5)): a
61
+ `voice`, `model`, `engine`, `language`, `region` or `profile` that is not
62
+ a short printable string is refused with a message naming the file and
63
+ the key, in the CLI and the portal alike.
64
+ - **Sentences no longer run together with the turbo models.** Their
65
+ segments arrive without a leading space and the worker joined them with
66
+ nothing ("working.I want"); segments are now joined with one space.
67
+
68
+ ### Fixed
69
+
70
+ - **A stored key is readable from every Python on the Mac.** macOS pins a
71
+ keychain item to the binary that created it, so a key stored from the
72
+ terminal could be invisible, or behind an "Allow" dialog, when Claude
73
+ Code's shell or an upgraded vocalize asked for it. Keys are now written
74
+ and read through Apple's own `security` tool (secret on stdin, never on a
75
+ command line), which is the same accessing application whatever spawned
76
+ it; the item also records the date the key was last validated, shown by
77
+ `vocalize auth status`. An older item is replaced in place on the next
78
+ `vocalize auth login`.
79
+
80
+ ### Added
81
+
82
+ - **An Anthropic key slot, and a Keys tab that can test and remove.**
83
+ `vocalize auth login --provider anthropic` stores the key the `anthropic`
84
+ cleanup backend uses, under its own keychain item; `auth status`,
85
+ `auth logout` and `vocalize usage` know the slot too. It is a key, not a
86
+ voice: the chain does not accept it. On the portal's Keys tab every slot
87
+ (the three voice providers and Anthropic) gets **Test without storing**,
88
+ which checks a key and keeps nothing, and **Remove stored key**, which
89
+ reads the keychain back before it says the key is gone; each card shows
90
+ when its key was last checked. The key field is `autocomplete=
91
+ "new-password"`, the value Safari and Chrome honour on a password field.
92
+ The Local tab gained a select for the cleanup backend.
93
+
94
+ - **An Anthropic API backend for the cleanup pass** (`[stt] cleanup =
95
+ "anthropic"`): one Messages API call with a key from `ANTHROPIC_API_KEY`
96
+ or the keychain slot `anthropic-api-key`, under a monthly character
97
+ budget (`[providers.anthropic] monthly_chars`, 2,000,000 when unset)
98
+ counted in the usage ledger. The key is stored from the CLI or the
99
+ portal's Keys tab, as described above.
100
+ - **A `[notes]` config table** (`folder`, `template`, `summarizer`,
101
+ `keep_audio`, `model`) is parsed, validated and preserved by every writer
102
+ of the config file. `vocalize notes` itself arrives in 0.14.0.
103
+ - **`large-v3-turbo-q8_0`** joins the dictation models: the same turbo model
104
+ as `q5_0` with 8-bit weights (834 MB on disk), for machines with 16 GB or
105
+ more. `vocalize local install --stt --model large-v3-turbo-q8_0`. Pinned
106
+ from a completed download like the other three.
107
+
6
108
  ## 0.11.0 - 2026-09-05
7
109
 
8
110
  ### Added
@@ -1,11 +1,48 @@
1
+ Metadata-Version: 2.5
2
+ Name: vocalize-cli
3
+ Version: 0.12.0
4
+ Summary: A local-first CLI that turns text, markdown, or piped stdin into speech: the on-device Kokoro voice by default, cloud voices optional, with markdown-table-aware preprocessing and Claude Code hooks.
5
+ Project-URL: Homepage, https://github.com/matthager12-collab/vocalize
6
+ Project-URL: Repository, https://github.com/matthager12-collab/vocalize
7
+ Author: Mat
8
+ License-Expression: MIT
9
+ License-File: LICENSE
10
+ Keywords: claude-code,cli,elevenlabs,kokoro,local,markdown,text-to-speech
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Programming Language :: Python :: 3.13
18
+ Classifier: Programming Language :: Python :: 3.14
19
+ Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
20
+ Requires-Python: >=3.10
21
+ Requires-Dist: click>=8.1
22
+ Requires-Dist: elevenlabs>=2.0
23
+ Requires-Dist: keyring>=25
24
+ Requires-Dist: tomli>=2.0; python_version < '3.11'
25
+ Provides-Extra: dev
26
+ Requires-Dist: build; extra == 'dev'
27
+ Requires-Dist: pytest-cov>=4.0; extra == 'dev'
28
+ Requires-Dist: pytest>=7.0; extra == 'dev'
29
+ Requires-Dist: ruff; extra == 'dev'
30
+ Requires-Dist: twine; extra == 'dev'
31
+ Provides-Extra: dotenv
32
+ Requires-Dist: python-dotenv>=1.0; extra == 'dotenv'
33
+ Provides-Extra: polly
34
+ Requires-Dist: boto3>=1.34; extra == 'polly'
35
+ Description-Content-Type: text/markdown
36
+
1
37
  # vocalize
2
38
 
3
39
  [![CI](https://github.com/matthager12-collab/vocalize/actions/workflows/ci.yml/badge.svg)](https://github.com/matthager12-collab/vocalize/actions/workflows/ci.yml)
4
40
 
5
41
  A command-line tool that turns text, markdown files, or piped stdin into
6
- natural-sounding speech using the [ElevenLabs](https://elevenlabs.io) API —
7
- plus a hook that wires it directly into [Claude Code](https://claude.com/claude-code),
8
- so Claude's responses get read aloud automatically in your terminal or IDE.
42
+ natural-sounding speech on your own machine by default, with cloud voices as
43
+ an option — plus a hook that wires it directly into
44
+ [Claude Code](https://claude.com/claude-code), so Claude's responses get read
45
+ aloud in your terminal or IDE.
9
46
 
10
47
  ## Quickstart
11
48
 
@@ -14,17 +51,19 @@ pipx install vocalize-cli
14
51
  ```
15
52
 
16
53
  ```bash
17
- vocalize config
54
+ vocalize local install
18
55
  ```
19
56
 
20
- Walks you through your API key, a voice, and a speed, and saves it all.
57
+ Downloads the on-device Kokoro voice once (about 350 MB; needs
58
+ [`uv`](https://docs.astral.sh/uv/)). Skip it and `vocalize` speaks through
59
+ macOS `say` until you come back to it — the fallback line tells you so.
21
60
 
22
61
  ```bash
23
62
  vocalize speak "hello"
24
63
  ```
25
64
 
26
- To set up just the key, skip the wizard and run `vocalize auth login` — it
27
- stores the key in your OS keychain.
65
+ Prefer a cloud voice? See [Providers and fallback](#providers-and-fallback):
66
+ `vocalize config` walks you through a key, a voice and a speed.
28
67
 
29
68
  ## Why this exists
30
69
 
@@ -62,33 +101,8 @@ cd vocalize
62
101
  pip install -e .
63
102
  ```
64
103
 
65
- Get a free ElevenLabs API key at
66
- [elevenlabs.io/app/settings/api-keys](https://elevenlabs.io/app/settings/api-keys)
67
- (free tier: 10,000 characters/month, API access included, no commercial
68
- license). Then, recommended, store it in your OS keychain:
69
-
70
- ```bash
71
- vocalize auth login
72
- ```
73
-
74
- This prompts for the key (input hidden), validates it against the
75
- ElevenLabs API, and stores it via your OS's own keychain (macOS Keychain,
76
- Windows Credential Locker, Linux Secret Service) — no plaintext file to
77
- manage. Piping it in from a secret manager works too:
78
-
79
- ```bash
80
- op read op://vault/elevenlabs/key | vocalize auth login --stdin
81
- ```
82
-
83
- An environment variable or `.env` file work as well, and take priority over
84
- the keychain if both are set:
85
-
86
- ```bash
87
- export ELEVENLABS_API_KEY=your-key-here
88
- ```
89
-
90
- or copy `.env.example` to `.env` and fill it in (requires the optional
91
- `python-dotenv` extra: `pip install -e ".[dotenv]"`).
104
+ Cloud voices need an API key; storing one is covered under
105
+ [Providers and fallback](#providers-and-fallback).
92
106
 
93
107
  ## Usage
94
108
 
@@ -206,7 +220,8 @@ back to `~/.config/vocalize/config.toml`. Flat keys, no sections:
206
220
  ```toml
207
221
  chain = ["elevenlabs", "google", "say"]
208
222
 
209
- # Flat keys = ElevenLabs, unchanged since before there was a chain.
223
+ # Flat keys are the original cloud voice's settings, unchanged since
224
+ # before there was a chain; see Providers and fallback.
210
225
  voice = "21m00Tcm4TlvDq8ikWAM"
211
226
  model = "eleven_flash_v2_5"
212
227
  speed = 0.95
@@ -278,8 +293,10 @@ Five tabs:
278
293
  - **Chain** — reorder providers, or add and remove one.
279
294
  - **Providers** — each provider's voice, model, speed, and monthly budget,
280
295
  with a live preview of the voice you're looking at.
281
- - **Keys** — store or check an API key; the field is masked and never
282
- offers to autocomplete.
296
+ - **Keys** — store, test or remove an API key for each provider and for
297
+ Anthropic (the dictation cleanup backend, not a voice); the field is
298
+ masked and never offers to autocomplete, a stored key is never shown
299
+ again, and each card says when the key was last checked.
283
300
  - **Usage** — this month's spend and quota per provider.
284
301
  - **Local** — install or update the on-device Kokoro and whisper models,
285
302
  with progress.
@@ -358,6 +375,41 @@ For the click-by-click setup of each provider — where to go, what to click,
358
375
  the one command that stores the credential, the one command that proves it
359
376
  works — see [docs/provider-credentials.md](docs/provider-credentials.md).
360
377
 
378
+ ### Storing a cloud API key
379
+
380
+ For ElevenLabs, get a free API key at
381
+ [elevenlabs.io/app/settings/api-keys](https://elevenlabs.io/app/settings/api-keys)
382
+ (free tier: 10,000 characters/month, API access included, no commercial
383
+ license). Then, recommended, store it in your OS keychain:
384
+
385
+ ```bash
386
+ vocalize auth login
387
+ ```
388
+
389
+ This prompts for the key (input hidden), validates it against the
390
+ ElevenLabs API, and stores it via your OS's own keychain (macOS Keychain,
391
+ Windows Credential Locker, Linux Secret Service) — no plaintext file to
392
+ manage. On macOS the item is written and read through Apple's own
393
+ `security` tool, so the same key is readable from every Python and app
394
+ that runs vocalize — your terminal, Claude Code's shell, the portal —
395
+ with no keychain dialog, and `vocalize auth status` shows the date it was
396
+ last validated. Piping it in from a secret manager works too:
397
+
398
+ ```bash
399
+ op read op://vault/elevenlabs/key | vocalize auth login --stdin
400
+ ```
401
+
402
+ An environment variable or `.env` file work as well, and take priority over
403
+ the keychain if both are set:
404
+
405
+ ```bash
406
+ export ELEVENLABS_API_KEY=your-key-here
407
+ ```
408
+
409
+ or copy `.env.example` to `.env` and fill it in (requires the optional
410
+ `python-dotenv` extra: `pip install -e ".[dotenv]"`).
411
+
412
+
361
413
  ## Budgets and the usage ledger
362
414
 
363
415
  Cloud providers don't stop at their free tier — they bill past it. vocalize
@@ -421,7 +473,8 @@ Use it for one read with `--provider kokoro`, or add it to your chain in
421
473
  Long text streams: it's broken into ~400-character pieces, and playback
422
474
  starts after the first one is ready — roughly 20–25 seconds of speech —
423
475
  instead of waiting for the whole thing to render. Measured on this Mac
424
- (M3): about 5x faster than real time, peaking around 870 MB of RAM while
476
+ (M3): about 5x faster than real time, peaking around 760 MB of RAM (measured
477
+ on an M4 on 2026-09-07; the M3 spike saw 870 MB) while
425
478
  rendering. `vocalize stop`, run from any terminal, halts a Kokoro read
426
479
  mid-sentence the same as any other provider.
427
480
 
@@ -443,7 +496,7 @@ vocalize local install --stt
443
496
  A separate opt-in from Kokoro's `vocalize local install` — nothing here is
444
497
  downloaded or built until you run this. It:
445
498
 
446
- 1. Downloads one whisper.cpp model (`small.en` by default, ~465 MB) from a
499
+ 1. Downloads one whisper.cpp model (`large-v3-turbo-q5_0` by default, ~547 MB) from a
447
500
  pinned Hugging Face revision, verified against a pinned sha256 before
448
501
  it's kept.
449
502
  2. Compiles and ad-hoc signs a small Swift recorder bundle, **Vocalize
@@ -517,10 +570,12 @@ overrides `[stt] max_seconds` for one invocation.
517
570
 
518
571
  ```toml
519
572
  [stt]
520
- model = "small.en" # base.en | small.en | large-v3-turbo-q5_0
521
- language = "en" # a whisper.cpp language code
573
+ model = "large-v3-turbo-q5_0" # base.en | small.en | large-v3-turbo-q5_0 | large-v3-turbo-q8_0
574
+ language = "en" # a whisper.cpp language code ("auto" to detect)
522
575
  input_device = "" # "" = system default; else an exact name from --list-devices
523
- cleanup = false # send the transcript (never audio) to Claude first
576
+ cleanup = "off" # off | local | claude-cli | anthropic — what tidies the transcript (never audio)
577
+ verbatim = false # true keeps every word even when cleanup is on
578
+ beam_size = 5 # 1-8 whisper.cpp beams; 1 is the greedy decoder
524
579
  max_seconds = 120 # 1-600; the recorder self-stops here, dictate backstops it
525
580
  sounds = true # the Tink/Pop/Glass feedback sounds
526
581
  cues = "sounds" # "sounds" | "words" | "both" — speak "Start."/"Stopped."/"Ready." instead
@@ -528,10 +583,12 @@ cues = "sounds" # "sounds" | "words" | "both" — speak "Start."/"Stopped
528
583
 
529
584
  | Key | Allowed values | Default |
530
585
  |---|---|---|
531
- | `model` | `base.en`, `small.en`, `large-v3-turbo-q5_0` | `small.en` |
586
+ | `model` | `base.en`, `small.en`, `large-v3-turbo-q5_0`, `large-v3-turbo-q8_0` | `large-v3-turbo-q5_0` |
532
587
  | `language` | a whisper.cpp language code (`en`, `es`, `fr`, …); an `.en` model must stay `en` | `en` |
533
588
  | `input_device` | `""` (system default) or an exact name from `vocalize listen --list-devices`; ≤ 128 characters, printable, can't start with `-` | `""` |
534
- | `cleanup` | `true` / `false` | `false` |
589
+ | `cleanup` | `off`, `local` (0.13), `claude-cli`, `anthropic`; an old `true`/`false` reads as `claude-cli`/`off` | `off` |
590
+ | `verbatim` | `true` / `false` — keep every word even when cleanup is on | `false` |
591
+ | `beam_size` | integer, 1–8 | `5` |
535
592
  | `paste` | reserved — not implemented in 0.10.0 | `false` |
536
593
  | `max_seconds` | integer, 1–600 | `120` |
537
594
  | `sounds` | `true` / `false` | `true` |
@@ -908,9 +965,11 @@ model.
908
965
  re-approve it in System Settings › Privacy & Security › Microphone. An
909
966
  install that doesn't change the source never re-signs, so this isn't
910
967
  every upgrade — only ones that touch the recorder.
911
- - **`small.en` mishears jargon.** The default model does fine on ordinary
912
- speech but can mangle project-specific words (`pyproject`, a function
913
- name) — pick `large-v3-turbo-q5_0` for better accuracy, or turn on
968
+ - **The smaller models mishear jargon.** `large-v3-turbo-q5_0` is the
969
+ default because it was the first model to keep "the merge" as two words
970
+ on the owner's own voice; `small.en` (465 MB) is the lighter choice for a
971
+ slow Mac but can mangle project-specific words (`pyproject`, a function
972
+ name) — stay on the default for accuracy, or turn on
914
973
  `[stt] cleanup` so Claude fixes obvious transcription noise before it
915
974
  reaches your clipboard (it still can't guess a word it never heard
916
975
  correctly).
@@ -1,47 +1,12 @@
1
- Metadata-Version: 2.5
2
- Name: vocalize-cli
3
- Version: 0.11.0
4
- Summary: A CLI that turns text, markdown, or piped stdin into speech via the ElevenLabs API, with markdown-table-aware preprocessing.
5
- Project-URL: Homepage, https://github.com/matthager12-collab/vocalize
6
- Project-URL: Repository, https://github.com/matthager12-collab/vocalize
7
- Author: Mat
8
- License-Expression: MIT
9
- License-File: LICENSE
10
- Keywords: claude-code,cli,elevenlabs,markdown,text-to-speech
11
- Classifier: Environment :: Console
12
- Classifier: Intended Audience :: Developers
13
- Classifier: Operating System :: OS Independent
14
- Classifier: Programming Language :: Python :: 3.10
15
- Classifier: Programming Language :: Python :: 3.11
16
- Classifier: Programming Language :: Python :: 3.12
17
- Classifier: Programming Language :: Python :: 3.13
18
- Classifier: Programming Language :: Python :: 3.14
19
- Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
20
- Requires-Python: >=3.10
21
- Requires-Dist: click>=8.1
22
- Requires-Dist: elevenlabs>=2.0
23
- Requires-Dist: keyring>=25
24
- Requires-Dist: tomli>=2.0; python_version < '3.11'
25
- Provides-Extra: dev
26
- Requires-Dist: build; extra == 'dev'
27
- Requires-Dist: pytest-cov>=4.0; extra == 'dev'
28
- Requires-Dist: pytest>=7.0; extra == 'dev'
29
- Requires-Dist: ruff; extra == 'dev'
30
- Requires-Dist: twine; extra == 'dev'
31
- Provides-Extra: dotenv
32
- Requires-Dist: python-dotenv>=1.0; extra == 'dotenv'
33
- Provides-Extra: polly
34
- Requires-Dist: boto3>=1.34; extra == 'polly'
35
- Description-Content-Type: text/markdown
36
-
37
1
  # vocalize
38
2
 
39
3
  [![CI](https://github.com/matthager12-collab/vocalize/actions/workflows/ci.yml/badge.svg)](https://github.com/matthager12-collab/vocalize/actions/workflows/ci.yml)
40
4
 
41
5
  A command-line tool that turns text, markdown files, or piped stdin into
42
- natural-sounding speech using the [ElevenLabs](https://elevenlabs.io) API —
43
- plus a hook that wires it directly into [Claude Code](https://claude.com/claude-code),
44
- so Claude's responses get read aloud automatically in your terminal or IDE.
6
+ natural-sounding speech on your own machine by default, with cloud voices as
7
+ an option — plus a hook that wires it directly into
8
+ [Claude Code](https://claude.com/claude-code), so Claude's responses get read
9
+ aloud in your terminal or IDE.
45
10
 
46
11
  ## Quickstart
47
12
 
@@ -50,17 +15,19 @@ pipx install vocalize-cli
50
15
  ```
51
16
 
52
17
  ```bash
53
- vocalize config
18
+ vocalize local install
54
19
  ```
55
20
 
56
- Walks you through your API key, a voice, and a speed, and saves it all.
21
+ Downloads the on-device Kokoro voice once (about 350 MB; needs
22
+ [`uv`](https://docs.astral.sh/uv/)). Skip it and `vocalize` speaks through
23
+ macOS `say` until you come back to it — the fallback line tells you so.
57
24
 
58
25
  ```bash
59
26
  vocalize speak "hello"
60
27
  ```
61
28
 
62
- To set up just the key, skip the wizard and run `vocalize auth login` — it
63
- stores the key in your OS keychain.
29
+ Prefer a cloud voice? See [Providers and fallback](#providers-and-fallback):
30
+ `vocalize config` walks you through a key, a voice and a speed.
64
31
 
65
32
  ## Why this exists
66
33
 
@@ -98,33 +65,8 @@ cd vocalize
98
65
  pip install -e .
99
66
  ```
100
67
 
101
- Get a free ElevenLabs API key at
102
- [elevenlabs.io/app/settings/api-keys](https://elevenlabs.io/app/settings/api-keys)
103
- (free tier: 10,000 characters/month, API access included, no commercial
104
- license). Then, recommended, store it in your OS keychain:
105
-
106
- ```bash
107
- vocalize auth login
108
- ```
109
-
110
- This prompts for the key (input hidden), validates it against the
111
- ElevenLabs API, and stores it via your OS's own keychain (macOS Keychain,
112
- Windows Credential Locker, Linux Secret Service) — no plaintext file to
113
- manage. Piping it in from a secret manager works too:
114
-
115
- ```bash
116
- op read op://vault/elevenlabs/key | vocalize auth login --stdin
117
- ```
118
-
119
- An environment variable or `.env` file work as well, and take priority over
120
- the keychain if both are set:
121
-
122
- ```bash
123
- export ELEVENLABS_API_KEY=your-key-here
124
- ```
125
-
126
- or copy `.env.example` to `.env` and fill it in (requires the optional
127
- `python-dotenv` extra: `pip install -e ".[dotenv]"`).
68
+ Cloud voices need an API key; storing one is covered under
69
+ [Providers and fallback](#providers-and-fallback).
128
70
 
129
71
  ## Usage
130
72
 
@@ -242,7 +184,8 @@ back to `~/.config/vocalize/config.toml`. Flat keys, no sections:
242
184
  ```toml
243
185
  chain = ["elevenlabs", "google", "say"]
244
186
 
245
- # Flat keys = ElevenLabs, unchanged since before there was a chain.
187
+ # Flat keys are the original cloud voice's settings, unchanged since
188
+ # before there was a chain; see Providers and fallback.
246
189
  voice = "21m00Tcm4TlvDq8ikWAM"
247
190
  model = "eleven_flash_v2_5"
248
191
  speed = 0.95
@@ -314,8 +257,10 @@ Five tabs:
314
257
  - **Chain** — reorder providers, or add and remove one.
315
258
  - **Providers** — each provider's voice, model, speed, and monthly budget,
316
259
  with a live preview of the voice you're looking at.
317
- - **Keys** — store or check an API key; the field is masked and never
318
- offers to autocomplete.
260
+ - **Keys** — store, test or remove an API key for each provider and for
261
+ Anthropic (the dictation cleanup backend, not a voice); the field is
262
+ masked and never offers to autocomplete, a stored key is never shown
263
+ again, and each card says when the key was last checked.
319
264
  - **Usage** — this month's spend and quota per provider.
320
265
  - **Local** — install or update the on-device Kokoro and whisper models,
321
266
  with progress.
@@ -394,6 +339,41 @@ For the click-by-click setup of each provider — where to go, what to click,
394
339
  the one command that stores the credential, the one command that proves it
395
340
  works — see [docs/provider-credentials.md](docs/provider-credentials.md).
396
341
 
342
+ ### Storing a cloud API key
343
+
344
+ For ElevenLabs, get a free API key at
345
+ [elevenlabs.io/app/settings/api-keys](https://elevenlabs.io/app/settings/api-keys)
346
+ (free tier: 10,000 characters/month, API access included, no commercial
347
+ license). Then, recommended, store it in your OS keychain:
348
+
349
+ ```bash
350
+ vocalize auth login
351
+ ```
352
+
353
+ This prompts for the key (input hidden), validates it against the
354
+ ElevenLabs API, and stores it via your OS's own keychain (macOS Keychain,
355
+ Windows Credential Locker, Linux Secret Service) — no plaintext file to
356
+ manage. On macOS the item is written and read through Apple's own
357
+ `security` tool, so the same key is readable from every Python and app
358
+ that runs vocalize — your terminal, Claude Code's shell, the portal —
359
+ with no keychain dialog, and `vocalize auth status` shows the date it was
360
+ last validated. Piping it in from a secret manager works too:
361
+
362
+ ```bash
363
+ op read op://vault/elevenlabs/key | vocalize auth login --stdin
364
+ ```
365
+
366
+ An environment variable or `.env` file work as well, and take priority over
367
+ the keychain if both are set:
368
+
369
+ ```bash
370
+ export ELEVENLABS_API_KEY=your-key-here
371
+ ```
372
+
373
+ or copy `.env.example` to `.env` and fill it in (requires the optional
374
+ `python-dotenv` extra: `pip install -e ".[dotenv]"`).
375
+
376
+
397
377
  ## Budgets and the usage ledger
398
378
 
399
379
  Cloud providers don't stop at their free tier — they bill past it. vocalize
@@ -457,7 +437,8 @@ Use it for one read with `--provider kokoro`, or add it to your chain in
457
437
  Long text streams: it's broken into ~400-character pieces, and playback
458
438
  starts after the first one is ready — roughly 20–25 seconds of speech —
459
439
  instead of waiting for the whole thing to render. Measured on this Mac
460
- (M3): about 5x faster than real time, peaking around 870 MB of RAM while
440
+ (M3): about 5x faster than real time, peaking around 760 MB of RAM (measured
441
+ on an M4 on 2026-09-07; the M3 spike saw 870 MB) while
461
442
  rendering. `vocalize stop`, run from any terminal, halts a Kokoro read
462
443
  mid-sentence the same as any other provider.
463
444
 
@@ -479,7 +460,7 @@ vocalize local install --stt
479
460
  A separate opt-in from Kokoro's `vocalize local install` — nothing here is
480
461
  downloaded or built until you run this. It:
481
462
 
482
- 1. Downloads one whisper.cpp model (`small.en` by default, ~465 MB) from a
463
+ 1. Downloads one whisper.cpp model (`large-v3-turbo-q5_0` by default, ~547 MB) from a
483
464
  pinned Hugging Face revision, verified against a pinned sha256 before
484
465
  it's kept.
485
466
  2. Compiles and ad-hoc signs a small Swift recorder bundle, **Vocalize
@@ -553,10 +534,12 @@ overrides `[stt] max_seconds` for one invocation.
553
534
 
554
535
  ```toml
555
536
  [stt]
556
- model = "small.en" # base.en | small.en | large-v3-turbo-q5_0
557
- language = "en" # a whisper.cpp language code
537
+ model = "large-v3-turbo-q5_0" # base.en | small.en | large-v3-turbo-q5_0 | large-v3-turbo-q8_0
538
+ language = "en" # a whisper.cpp language code ("auto" to detect)
558
539
  input_device = "" # "" = system default; else an exact name from --list-devices
559
- cleanup = false # send the transcript (never audio) to Claude first
540
+ cleanup = "off" # off | local | claude-cli | anthropic — what tidies the transcript (never audio)
541
+ verbatim = false # true keeps every word even when cleanup is on
542
+ beam_size = 5 # 1-8 whisper.cpp beams; 1 is the greedy decoder
560
543
  max_seconds = 120 # 1-600; the recorder self-stops here, dictate backstops it
561
544
  sounds = true # the Tink/Pop/Glass feedback sounds
562
545
  cues = "sounds" # "sounds" | "words" | "both" — speak "Start."/"Stopped."/"Ready." instead
@@ -564,10 +547,12 @@ cues = "sounds" # "sounds" | "words" | "both" — speak "Start."/"Stopped
564
547
 
565
548
  | Key | Allowed values | Default |
566
549
  |---|---|---|
567
- | `model` | `base.en`, `small.en`, `large-v3-turbo-q5_0` | `small.en` |
550
+ | `model` | `base.en`, `small.en`, `large-v3-turbo-q5_0`, `large-v3-turbo-q8_0` | `large-v3-turbo-q5_0` |
568
551
  | `language` | a whisper.cpp language code (`en`, `es`, `fr`, …); an `.en` model must stay `en` | `en` |
569
552
  | `input_device` | `""` (system default) or an exact name from `vocalize listen --list-devices`; ≤ 128 characters, printable, can't start with `-` | `""` |
570
- | `cleanup` | `true` / `false` | `false` |
553
+ | `cleanup` | `off`, `local` (0.13), `claude-cli`, `anthropic`; an old `true`/`false` reads as `claude-cli`/`off` | `off` |
554
+ | `verbatim` | `true` / `false` — keep every word even when cleanup is on | `false` |
555
+ | `beam_size` | integer, 1–8 | `5` |
571
556
  | `paste` | reserved — not implemented in 0.10.0 | `false` |
572
557
  | `max_seconds` | integer, 1–600 | `120` |
573
558
  | `sounds` | `true` / `false` | `true` |
@@ -944,9 +929,11 @@ model.
944
929
  re-approve it in System Settings › Privacy & Security › Microphone. An
945
930
  install that doesn't change the source never re-signs, so this isn't
946
931
  every upgrade — only ones that touch the recorder.
947
- - **`small.en` mishears jargon.** The default model does fine on ordinary
948
- speech but can mangle project-specific words (`pyproject`, a function
949
- name) — pick `large-v3-turbo-q5_0` for better accuracy, or turn on
932
+ - **The smaller models mishear jargon.** `large-v3-turbo-q5_0` is the
933
+ default because it was the first model to keep "the merge" as two words
934
+ on the owner's own voice; `small.en` (465 MB) is the lighter choice for a
935
+ slow Mac but can mangle project-specific words (`pyproject`, a function
936
+ name) — stay on the default for accuracy, or turn on
950
937
  `[stt] cleanup` so Claude fixes obvious transcription noise before it
951
938
  reaches your clipboard (it still can't guess a word it never heard
952
939
  correctly).