orca-talkback 0.1.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.
- orca_talkback-0.1.0/.github/workflows/ci.yml +24 -0
- orca_talkback-0.1.0/.github/workflows/publish.yml +22 -0
- orca_talkback-0.1.0/.gitignore +8 -0
- orca_talkback-0.1.0/.python-version +1 -0
- orca_talkback-0.1.0/LICENSE +202 -0
- orca_talkback-0.1.0/NOTICE +7 -0
- orca_talkback-0.1.0/PKG-INFO +301 -0
- orca_talkback-0.1.0/README.md +273 -0
- orca_talkback-0.1.0/docs/design.md +127 -0
- orca_talkback-0.1.0/docs/figures/blog_figures.py +246 -0
- orca_talkback-0.1.0/docs/figures/echo-cancellation.json +189 -0
- orca_talkback-0.1.0/pyproject.toml +55 -0
- orca_talkback-0.1.0/src/orca_talkback/__init__.py +1 -0
- orca_talkback-0.1.0/src/orca_talkback/__main__.py +185 -0
- orca_talkback-0.1.0/src/orca_talkback/audio.py +171 -0
- orca_talkback-0.1.0/src/orca_talkback/frontmost.py +25 -0
- orca_talkback-0.1.0/src/orca_talkback/hooks/__init__.py +0 -0
- orca_talkback-0.1.0/src/orca_talkback/hooks/talkback-voice-mode.sh +15 -0
- orca_talkback-0.1.0/src/orca_talkback/replies.py +79 -0
- orca_talkback-0.1.0/src/orca_talkback/rules.py +69 -0
- orca_talkback-0.1.0/src/orca_talkback/server.py +194 -0
- orca_talkback-0.1.0/src/orca_talkback/setup_command.py +101 -0
- orca_talkback-0.1.0/src/orca_talkback/speaker.py +264 -0
- orca_talkback-0.1.0/src/orca_talkback/spoken.py +85 -0
- orca_talkback-0.1.0/tests/test_audio.py +121 -0
- orca_talkback-0.1.0/tests/test_claude_code_hook.py +66 -0
- orca_talkback-0.1.0/tests/test_frontmost.py +37 -0
- orca_talkback-0.1.0/tests/test_replies.py +166 -0
- orca_talkback-0.1.0/tests/test_rules.py +139 -0
- orca_talkback-0.1.0/tests/test_server.py +304 -0
- orca_talkback-0.1.0/tests/test_setup_command.py +61 -0
- orca_talkback-0.1.0/tests/test_speaker.py +254 -0
- orca_talkback-0.1.0/tests/test_spoken.py +77 -0
- orca_talkback-0.1.0/uv.lock +1005 -0
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
test:
|
|
10
|
+
runs-on: macos-latest
|
|
11
|
+
strategy:
|
|
12
|
+
matrix:
|
|
13
|
+
python-version: ["3.11", "3.14"]
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
- uses: astral-sh/setup-uv@v6
|
|
17
|
+
with:
|
|
18
|
+
python-version: ${{ matrix.python-version }}
|
|
19
|
+
- name: Install dependencies
|
|
20
|
+
run: uv sync
|
|
21
|
+
- name: Lint
|
|
22
|
+
run: uvx ruff check src tests
|
|
23
|
+
- name: Run tests
|
|
24
|
+
run: uv run pytest -q
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
tags: ["v*"]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
publish:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
environment: pypi
|
|
11
|
+
permissions:
|
|
12
|
+
id-token: write # PyPI trusted publishing: no API token is stored anywhere
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: astral-sh/setup-uv@v6
|
|
16
|
+
- name: Check the tag matches the package version
|
|
17
|
+
run: |
|
|
18
|
+
version=$(grep -m1 '^version = ' pyproject.toml | cut -d'"' -f2)
|
|
19
|
+
test "v$version" = "$GITHUB_REF_NAME" || { echo "tag $GITHUB_REF_NAME does not match version $version"; exit 1; }
|
|
20
|
+
- name: Build
|
|
21
|
+
run: uv build
|
|
22
|
+
- uses: pypa/gh-action-pypi-publish@release/v1
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.14
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
orca-talkback
|
|
2
|
+
Copyright 2026 Callum Macpherson
|
|
3
|
+
|
|
4
|
+
This product includes software derived from voice-loop by Trelis Research
|
|
5
|
+
(https://github.com/TrelisResearch/voice-loop), licensed under the Apache
|
|
6
|
+
License, Version 2.0. The echo-cancellation and barge-in logic in
|
|
7
|
+
src/orca_talkback/audio.py is ported from voice-loop's voice_loop_mac.py.
|
|
@@ -0,0 +1,301 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: orca-talkback
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Hear your Orca coding agents talk back: spoken reply summaries with voice barge-in, fully local audio.
|
|
5
|
+
Project-URL: Homepage, https://github.com/CallumJMac/orca-talkback
|
|
6
|
+
Project-URL: Issues, https://github.com/CallumJMac/orca-talkback/issues
|
|
7
|
+
Author: Callum Macpherson
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
License-File: NOTICE
|
|
11
|
+
Keywords: barge-in,claude-code,echo-cancellation,kokoro,orca,text-to-speech,voice
|
|
12
|
+
Classifier: Operating System :: MacOS
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
18
|
+
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
|
|
19
|
+
Requires-Python: <3.15,>=3.11
|
|
20
|
+
Requires-Dist: kokoro-onnx>=0.4
|
|
21
|
+
Requires-Dist: livekit>=1.1.5
|
|
22
|
+
Requires-Dist: numpy>=2.1
|
|
23
|
+
Requires-Dist: onnxruntime>=1.17
|
|
24
|
+
Requires-Dist: silero-vad>=5.1
|
|
25
|
+
Requires-Dist: sounddevice>=0.5
|
|
26
|
+
Requires-Dist: torch>=2.0
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
<div align="center">
|
|
30
|
+
<h1>🗣️ orca-talkback</h1>
|
|
31
|
+
<p><strong>Hear your Orca coding agents talk back.</strong><br>
|
|
32
|
+
A one-to-three sentence spoken summary of every finished reply, voiced locally on your Mac.<br>
|
|
33
|
+
Talk over it to stop it.</p>
|
|
34
|
+
</div>
|
|
35
|
+
|
|
36
|
+
<p align="center">
|
|
37
|
+
<a href="https://github.com/CallumJMac/orca-talkback/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/CallumJMac/orca-talkback/ci.yml?branch=main&style=for-the-badge&label=tests" alt="Tests"></a>
|
|
38
|
+
<img src="https://img.shields.io/badge/macOS-Apple_Silicon-black?style=for-the-badge&logo=apple&logoColor=white" alt="macOS on Apple Silicon">
|
|
39
|
+
<img src="https://img.shields.io/badge/python-3.11--3.14-blue?style=for-the-badge&logo=python&logoColor=white" alt="Python 3.11 to 3.14">
|
|
40
|
+
<a href="https://github.com/stablyai/orca"><img src="https://img.shields.io/badge/Orca-plugin-orange?style=for-the-badge" alt="Orca plugin"></a>
|
|
41
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache_2.0-green?style=for-the-badge" alt="Apache 2.0"></a>
|
|
42
|
+
</p>
|
|
43
|
+
|
|
44
|
+
<p align="center">
|
|
45
|
+
<sub><strong>Status:</strong> 0.1, early. Tested on macOS (Apple Silicon) with Orca 1.4.265 and Claude Code agents. 113 daemon tests and 14 plugin tests.</sub>
|
|
46
|
+
</p>
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
[Orca](https://github.com/stablyai/orca) is a desktop app that runs coding agents such as Claude Code side by side. You can already talk *to* them with any dictation tool (Wispr Flow, macOS Dictation, ...). `orca-talkback` makes them talk *back*, like voice mode in the Claude apps: when an agent in the workspace you are looking at finishes, you hear what it did and what it is asking you, in plain speech, with no code or file paths read aloud.
|
|
51
|
+
|
|
52
|
+
### What you hear after a real turn
|
|
53
|
+
|
|
54
|
+
From the daemon's log after an actual Claude Code turn (lines trimmed):
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
[status] structured-agent-session-...:cd834849 done -> speak
|
|
58
|
+
[say] I fixed the cutoff issue where replies were getting chopped at 200 characters.
|
|
59
|
+
[say] The daemon now pulls the full text from orca agent read instead, and all 73 tests are passing.
|
|
60
|
+
[say] When you get a chance, try talking over a long reply to check barge-in works.
|
|
61
|
+
[status] structured-agent-session-...:cd834849 working -> stop (agent started working)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The last line is the next prompt being sent: playback stops the moment the agent starts working again.
|
|
65
|
+
|
|
66
|
+
## Contents
|
|
67
|
+
|
|
68
|
+
- [Quick start](#quick-start)
|
|
69
|
+
- [How it works](#how-it-works)
|
|
70
|
+
- [Turning it on and off](#turning-it-on-and-off)
|
|
71
|
+
- [Speaking or reading](#speaking-or-reading)
|
|
72
|
+
- [Configuration](#configuration)
|
|
73
|
+
- [Privacy](#privacy)
|
|
74
|
+
- [Troubleshooting](#troubleshooting)
|
|
75
|
+
- [Limitations](#limitations)
|
|
76
|
+
- [Why Kokoro?](#why-kokoro)
|
|
77
|
+
- [Development](#development)
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Quick start
|
|
82
|
+
|
|
83
|
+
**You need:** macOS on Apple Silicon, [uv](https://docs.astral.sh/uv/) and [Orca](https://github.com/stablyai/orca) 1.4.248 or newer. No API keys and no Homebrew: everything runs on your Mac.
|
|
84
|
+
|
|
85
|
+
### 1. Install and set up
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
uv tool install git+https://github.com/CallumJMac/orca-talkback
|
|
89
|
+
orca-talkback setup
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
`setup` installs the Claude Code voice-mode hook (see [Speaking or reading](#speaking-or-reading)), downloads the Kokoro voice (about 340 MB), checks your microphone and checks the Orca plugin. The first install also downloads PyTorch for voice detection, so it takes a few minutes.
|
|
93
|
+
|
|
94
|
+
### 2. Add the Talkback plugin to Orca
|
|
95
|
+
|
|
96
|
+
In Orca, open **Settings, Plugins**, add the community marketplace (`https://github.com/stablyai/orca-community-plugins.git`, ref `main`) and install **Talkback**. Or from a terminal (the `orca` CLI ships inside the app; if it is not on your PATH, use `/Applications/Orca.app/Contents/Resources/bin/orca`):
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
orca plugin install CallumJMac/orca-talkback-plugin
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Orca lists the access the plugin asks for (read workspace focus and agent status) and prints a `Fingerprint: ap1-...` line; re-run the command with `--approve` and that fingerprint.
|
|
103
|
+
|
|
104
|
+
### 3. Run it
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
orca-talkback
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
When it is ready you will see `orca-talkback listening on http://127.0.0.1:47823`. Ask a Claude Code agent something in an Orca chat and listen.
|
|
111
|
+
|
|
112
|
+
> [!NOTE]
|
|
113
|
+
> The first time it opens the microphone, macOS asks for permission for your terminal app. Barge-in needs it; playback works without it. If your default input is a virtual device (Zoom, Teams, BlackHole), orca-talkback picks your real microphone instead.
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## How it works
|
|
118
|
+
|
|
119
|
+
```mermaid
|
|
120
|
+
sequenceDiagram
|
|
121
|
+
autonumber
|
|
122
|
+
participant You
|
|
123
|
+
participant Orca as Orca agent pane
|
|
124
|
+
participant Plugin as Talkback plugin
|
|
125
|
+
participant Daemon as orca-talkback
|
|
126
|
+
participant Speakers
|
|
127
|
+
|
|
128
|
+
You->>Orca: dictate a prompt
|
|
129
|
+
Orca-->>Plugin: agent working
|
|
130
|
+
Plugin->>Daemon: focus, then status
|
|
131
|
+
Daemon->>Speakers: stop anything still playing
|
|
132
|
+
Orca-->>Plugin: agent done
|
|
133
|
+
Plugin->>Daemon: focus, then status
|
|
134
|
+
Daemon->>Orca: read the full reply
|
|
135
|
+
Daemon->>Daemon: take its hidden spoken line
|
|
136
|
+
Daemon->>Speakers: Kokoro speaks it, first sentence first
|
|
137
|
+
You->>Daemon: start talking (echo-cancelled mic)
|
|
138
|
+
Daemon->>Speakers: fade out
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
1. The **Talkback plugin** is a tiny Orca worker. It forwards workspace focus and agent status to the daemon on `127.0.0.1:47823`, in order, and re-sends focus before every status so a restarted daemon catches up.
|
|
142
|
+
2. The **daemon** decides what to do with each event (table below). When a reply should be spoken, it reads the agent's full message through the Orca CLI and takes the agent's own hidden spoken line (see [Speaking or reading](#speaking-or-reading)), or, if there is none, a cleaned-up version of the reply with code, tables and links removed.
|
|
143
|
+
3. **Kokoro** synthesises the first sentence on its own, so you hear it while the rest is still being synthesised. A newer reply replaces the current one; replies never queue up.
|
|
144
|
+
4. While it speaks, **barge-in** listens: every sample it plays is fed to WebRTC AEC3 as the echo reference, so only *your* voice gets through to Silero VAD. It needs about 160 ms of your voice to trigger, then fades out over 30 ms.
|
|
145
|
+
|
|
146
|
+
If the daemon is not running, Orca behaves exactly as before.
|
|
147
|
+
|
|
148
|
+
### When it speaks
|
|
149
|
+
|
|
150
|
+
It only speaks while you are looking at the agent: **Orca must be the app in front**, and the agent must be **in the workspace on screen, or the chat you just sent a prompt to**. The second case exists because Orca's focus signal follows the sidebar, not chats, so sending a chat a prompt is the reliable sign you are viewing it. Orca repeats `working` events throughout a turn, so only a change of state counts.
|
|
151
|
+
|
|
152
|
+
| Event | Action |
|
|
153
|
+
|---|---|
|
|
154
|
+
| An agent you are viewing finishes, with Orca in front | Speak its reply |
|
|
155
|
+
| An agent finishes anywhere else, or while another app is in front | Nothing, and it is never replayed later |
|
|
156
|
+
| You send a prompt, or the agent on screen starts working again | Stop |
|
|
157
|
+
| You pick another workspace, or switch away from Orca | Stop (and the chat you prompted no longer counts as on screen) |
|
|
158
|
+
| You start talking | Stop |
|
|
159
|
+
|
|
160
|
+
The design document, with the full rules and trade-offs, is in [`docs/design.md`](docs/design.md).
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## Turning it on and off
|
|
165
|
+
|
|
166
|
+
| To | Do |
|
|
167
|
+
|---|---|
|
|
168
|
+
| Mute or unmute the workspace or chat on screen | Click **🔊 Talkback** in Orca's status bar, or run **Talkback: Toggle for this workspace** from the command palette |
|
|
169
|
+
| Mute everything | Run **Talkback: Toggle everywhere** (the status bar reads **🔇 Talkback off**) |
|
|
170
|
+
| Stop the current reply | Talk over it |
|
|
171
|
+
|
|
172
|
+
Muting something that is speaking stops it at once, and your choices are remembered across restarts. Both commands can be bound to a shortcut in Orca's keyboard settings.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
## Speaking or reading
|
|
177
|
+
|
|
178
|
+
The Talkback switch can also change how Claude Code *writes* in Orca chats. With the voice-mode hook installed:
|
|
179
|
+
|
|
180
|
+
| Talkback for the session | Claude Code writes | You hear | Time to first word |
|
|
181
|
+
|---|---|---|---|
|
|
182
|
+
| 🔊 On | Its normal reply, plus a hidden `[//]: # (spoken: ...)` line at the end | That line, as the agent wrote it | under a second |
|
|
183
|
+
| 🔇 Muted | Its normal reply, for reading | Nothing | |
|
|
184
|
+
|
|
185
|
+
The spoken line is a markdown comment (a link reference definition), which Orca's chat view hides. Claude Code's terminal would print it, so the hook only asks for it in Orca chats; agents running in a terminal are spoken as cleaned-up text instead. The agent that did the work says what it means, and nothing else sits between the reply and the voice. Without the hook, or when an agent forgets the line, a cleaned-up version of the reply is spoken instead: code, tables and links are dropped and long replies are cut at a sentence boundary.
|
|
186
|
+
|
|
187
|
+
`orca-talkback setup` installs the hook for you. To do it by hand instead, copy `src/orca_talkback/hooks/talkback-voice-mode.sh` somewhere stable and add it to `~/.claude/settings.json` (it needs `jq` and `curl`, both built into recent macOS):
|
|
188
|
+
|
|
189
|
+
```json
|
|
190
|
+
{
|
|
191
|
+
"hooks": {
|
|
192
|
+
"UserPromptSubmit": [
|
|
193
|
+
{ "hooks": [{ "type": "command", "command": "/path/to/talkback-voice-mode.sh", "timeout": 2 }] }
|
|
194
|
+
]
|
|
195
|
+
}
|
|
196
|
+
}
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
On each prompt it asks the daemon whether Talkback is on for that session, and if so adds the spoken-line instruction as hidden context. If the daemon is not running, it adds nothing.
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## Configuration
|
|
204
|
+
|
|
205
|
+
```bash
|
|
206
|
+
uv run orca-talkback --help
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
| Flag | Default | What it does |
|
|
210
|
+
|---|---|---|
|
|
211
|
+
| `--voice` | `bf_emma` | Kokoro voice. Try `af_heart`, `af_bella` or `bm_george` |
|
|
212
|
+
| `--speed` | `1.1` | Speaking rate |
|
|
213
|
+
| `--no-barge-in` | barge-in on | Turn off talking over it |
|
|
214
|
+
| `--barge-in-ms` | `160` | Continuous speech needed to interrupt. Raise it if it stops too easily |
|
|
215
|
+
| `--vad-threshold` | `0.8` | Speech probability threshold. Lower it if it never stops |
|
|
216
|
+
| `--input-device` | your real microphone | Microphone for barge-in, matched by name, for example `"MacBook Pro Microphone"`. By default it uses the system input, skipping virtual devices |
|
|
217
|
+
| `--speak-when-hidden` | off | Also speak while another app is in front (the workspace rule still applies) |
|
|
218
|
+
| `--verbose` | off | Log every event the plugin forwards, with the focused workspace, for troubleshooting |
|
|
219
|
+
| `--port` | `47823` | Leave as is: the plugin hard-codes this port (`DAEMON_URL` in the plugin's [`src/worker.ts`](https://github.com/CallumJMac/orca-talkback-plugin/blob/main/src/worker.ts)) |
|
|
220
|
+
|
|
221
|
+
Set `ORCA_CLI_COMMAND` if your `orca` binary lives somewhere unusual.
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## Privacy
|
|
226
|
+
|
|
227
|
+
| Data | Where it goes |
|
|
228
|
+
|---|---|
|
|
229
|
+
| Microphone audio | Stays on your Mac. Opened only while it is speaking, used only for barge-in, never recorded. |
|
|
230
|
+
| Speech | Synthesised on your Mac. |
|
|
231
|
+
| The agent's reply text | Read from Orca on your Mac and never sent anywhere. orca-talkback makes no network calls. |
|
|
232
|
+
| The daemon | Listens on `127.0.0.1` only and rejects non-JSON requests, which blocks simple cross-site requests from web pages. |
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## Troubleshooting
|
|
237
|
+
|
|
238
|
+
| Symptom | Likely cause | Fix |
|
|
239
|
+
|---|---|---|
|
|
240
|
+
| Nothing is ever spoken | Daemon not running, or plugin not installed | `curl -s 127.0.0.1:47823/health`; `orca plugin list` should show `talkback` running |
|
|
241
|
+
| One agent never speaks | Its workspace was not on screen, or Orca was not in front, when it finished | By design. Run with `--verbose` to see every event and which workspace Orca reports as focused |
|
|
242
|
+
| It stops when I click another app | Replies only play while Orca is in front | By design; pass `--speak-when-hidden` to keep listening from other apps |
|
|
243
|
+
| It reads the reply word for word | The agent did not write a spoken line | Check the voice-mode hook is installed (see [Speaking or reading](#speaking-or-reading)) and that Talkback is on for the session |
|
|
244
|
+
| Talking over it never stops it | The system input is a virtual device (Zoom, BlackHole), permission was denied, or the threshold is too strict | Check the `[audio] barge-in microphone:` line at startup and pass `--input-device "MacBook Pro Microphone"`; allow your terminal under System Settings, Privacy & Security, Microphone; try `--vad-threshold 0.6` |
|
|
245
|
+
| It stops on its own | Speaker echo is getting through | Lower the volume or use headphones; try `--barge-in-ms 250` |
|
|
246
|
+
| `orca plugin logs` says `daemon unreachable` | Orca sent an event while the daemon was down | Start the daemon. The plugin re-sends focus with the next event, so nothing needs restarting |
|
|
247
|
+
|
|
248
|
+
---
|
|
249
|
+
|
|
250
|
+
## Limitations
|
|
251
|
+
|
|
252
|
+
- **macOS only.** Tested on Apple Silicon. Linux may work but is untested.
|
|
253
|
+
- **Claude Code is the tested agent.** Other Orca agents report the same events and should work, but have not been tried.
|
|
254
|
+
- **Orca does not report which chat or tab is on screen.** orca-talkback infers it from the sidebar focus and from the chat you last prompted. If you prompt one chat and then just look at another without prompting it, the first one's reply still plays. In a worktree running several agents, any of them can speak; the newer reply wins.
|
|
255
|
+
- **Dictation overlap.** Your dictation tool records from its own microphone, without echo cancellation. If you start dictating at the exact moment you barge in, it may catch the last fraction of a second of speech.
|
|
256
|
+
|
|
257
|
+
---
|
|
258
|
+
|
|
259
|
+
## Why Kokoro?
|
|
260
|
+
|
|
261
|
+
I compared open text-to-speech models on public leaderboards (November 2026) before picking the default:
|
|
262
|
+
|
|
263
|
+
| Model | Naturalness (UTMOS) | Word error rate | Size | License |
|
|
264
|
+
|---|---|---|---|---|
|
|
265
|
+
| **[Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M)** (default) | **4.50** | 0.76% | 82M | Apache-2.0 |
|
|
266
|
+
| [Inflect-Mini-v3](https://huggingface.co/owensong/Inflect-Mini-v3) | 4.48 | 0.76% | 34M | Apache-2.0 |
|
|
267
|
+
| [Reverb-TTS](https://huggingface.co/software-mansion/Reverb-TTS) | 4.45 | **0.65%** | 297M | CC-BY-NC-4.0 |
|
|
268
|
+
| [Chatterbox](https://huggingface.co/ResembleAI/chatterbox) | 4.40 | 1.00% | 800M | MIT |
|
|
269
|
+
| [pocket-tts](https://huggingface.co/kyutai/pocket-tts) | 4.33 | 0.85% | 100M | CC-BY-4.0 |
|
|
270
|
+
|
|
271
|
+
Kokoro scored the highest naturalness of the 56 models on Hugging Face's [Open TTS Leaderboard](https://huggingface.co/spaces/hf-audio/open_tts_leaderboard) (English, Seed-TTS), with an error rate within 0.11 points of the best, and it is small and Apache-2.0. It also had the lowest error rate of 33 models on [VoiceHub's Seed-TTS-Eval](https://huggingface.co/datasets/kadirnar/voicehub-arena-seed-tts-eval), and it is the top open model with a meaningful vote count on the human-voted [TTS Arena V2](https://huggingface.co/spaces/TTS-AGI/TTS-Arena-V2).
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
## Development
|
|
276
|
+
|
|
277
|
+
```bash
|
|
278
|
+
git clone https://github.com/CallumJMac/orca-talkback.git && cd orca-talkback
|
|
279
|
+
uv sync
|
|
280
|
+
uv run pytest -q # daemon tests, no audio hardware needed
|
|
281
|
+
uv run orca-talkback # run from the checkout
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
The plugin's code and tests are in [orca-talkback-plugin](https://github.com/CallumJMac/orca-talkback-plugin).
|
|
285
|
+
|
|
286
|
+
Issues and pull requests are welcome. On the roadmap:
|
|
287
|
+
|
|
288
|
+
- **More speech engines.** Synthesis is one `synthesize(text)` function; [pocket-tts](https://huggingface.co/kyutai/pocket-tts) (about 125 ms to first audio on CPU) is the first candidate.
|
|
289
|
+
- **Launch at login** with a launchd agent.
|
|
290
|
+
|
|
291
|
+
---
|
|
292
|
+
|
|
293
|
+
## Credits
|
|
294
|
+
|
|
295
|
+
- [Trelis Research voice-loop](https://github.com/TrelisResearch/voice-loop): the echo cancellation and barge-in approach this project ports (Apache-2.0, see [`NOTICE`](NOTICE)).
|
|
296
|
+
- [Kokoro](https://huggingface.co/hexgrad/Kokoro-82M) and [kokoro-onnx](https://github.com/thewh1teagle/kokoro-onnx): speech synthesis.
|
|
297
|
+
- [Silero VAD](https://github.com/snakers4/silero-vad): voice activity detection.
|
|
298
|
+
- [LiveKit Python SDK](https://github.com/livekit/python-sdks): WebRTC AEC3 bindings.
|
|
299
|
+
- [Orca](https://github.com/stablyai/orca): the agent workspace this plugs into.
|
|
300
|
+
|
|
301
|
+
Licensed under the [Apache License 2.0](LICENSE). Not affiliated with Anthropic or Stably.
|