Metadata-Version: 2.4
Name: yapbox
Version: 0.1.2
Summary: Persistent always-on voice agent: a long-lived Claude brain with an ephemeral ElevenLabs voice channel.
Author: Shawn Petros
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other
              transformations represent, as a whole, an original work of authorship.
              For the purposes of this License, Derivative Works shall not include
              works that remain separable from, or merely link (or bind by name)
              to the interfaces of, the Work and works based on the Work.
        
              "Contribution" shall mean, as submitted to the Licensor for inclusion
              in the Work by the copyright owner or by an individual or Legal Entity
              authorized to submit on behalf of the copyright owner. For the
              purposes of this definition, "submit" means any form of electronic,
              verbal, or written communication sent to the Licensor or its
              representatives, including but not limited to communication on
              electronic mailing lists, source lists, discussion forums, and issue
              tracking systems that are managed by, or on behalf of, the Licensor
              for the purpose of discussing and improving the Work, but excluding
              communication that is conspicuously marked or designated in writing
              by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by the combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file, You must include a
                  readable copy of the attribution notices contained within such
                  NOTICE file, in the Derivative Works that You distribute, in
                  at least one of the following places: within a NOTICE text file
                  distributed as part of the Derivative Works; within the Source
                  form or documentation, if provided along with the Derivative
                  Works; or, within a display generated by the Derivative Works,
                  if and wherever such third-party notices normally appear. The
                  contents of the NOTICE file are for informational purposes only
                  and do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an additional addendum to the NOTICE text from the Work,
                  provided that such additional attribution notices cannot be
                  construed as modifying the License.
        
              You may add Your own license statement for Your modifications and
              may provide additional grant of rights to use, copy, modify, merge,
              publish, distribute, sublicense, and/or sell copies of the
              Derivative Works, and to permit persons to whom the Derivative Works
              are furnished to do so, subject to the following conditions described
              in Sections 2 and 3.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or all other
              commercial damages or losses), even if such Contributor has been
              advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may offer only
              conditions that are completely consistent with this License, and
              only on the condition that You accept all risk and responsibility for
              any liability that is not attributable to a Contributor.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format concerned. And of course your
              contingencies must be applied to your own jurisdiction.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: assistant,claude,conversational-ai,elevenlabs,voice,voice-agent,wake-word
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <3.13,>=3.12
Requires-Dist: anthropic
Requires-Dist: claude-agent-sdk
Requires-Dist: elevenlabs
Requires-Dist: fastapi
Requires-Dist: httpx
Requires-Dist: livekit
Requires-Dist: numpy
Requires-Dist: sherpa-onnx
Requires-Dist: sherpa-onnx-core
Requires-Dist: sounddevice
Requires-Dist: uvicorn
Description-Content-Type: text/markdown

# yapbox

A persistent-presence voice agent. The mind runs continuously on your machine; the voice is just a channel that opens when you speak and closes when you are done.

Most voice-agent frameworks orchestrate a single live conversation. yapbox is a different thing: a long-lived brain (durable cognitive state, a write-ahead journal, a job ledger, cross-session memory) that happens to talk. Say the wake word and an ElevenLabs session opens; say you are done and it closes. Jobs keep running while the channel is shut, state keeps accruing, and the next wake opens with a pre-computed greeting that already knows what happened in the gap. Persistent mind, ephemeral socket.

"Hey Silas" is the shipped default persona a fresh clone meets. Two more ship in `personas/`: Jarvis (a dry-butler register) and Penny. A persona is a voice plus a soul, a markdown character brief with worked examples, and the wake keyword selects which one opens. See `personas/README.md` for the soul contract and `docs/persona-interview.md` to build your own.

## Why it is different

yapbox is built for one job: an always-on voice presence that can safely drive your machine, without burning money or going silent unnoticed. The things below are the product; the voice is the mouth and ears.

- **Persistent mind.** A brain daemon holds cognitive state across sessions (journal plus atomic snapshot plus boot reconciliation), not a per-call stitch that dies with the session.
- **Durable jobs.** A separate orchestrator runs work on a SQLite ledger in a crash-isolated subprocess pool. A job survives a brain restart and gets narrated when it lands.
- **Cost-safe by construction.** Nested fail-closed budget breakers and a spend ledger. The voice session is metered, so it opens on a wake word and closes on idle rather than staying open.
- **Bring your own backend.** The work harness (Claude Code, Hermes, Codex), the memory layer, and the toolchain (MCP servers, CLIs) are all pluggable. Memory ships as flat-file JSONL, the working zero-config default; a Honcho backend is in the tree behind the same interface but its live transport is not wired yet, so treat it as experimental. Machine control (shell, browser, computer-use) is double-opt-in and gated.
- **Always-on, supervised.** A launchd supervisor restarts crashes with exponential backoff; a separate deadman alerts out-of-band if the supervisor itself goes quiet.
- **Mock-safe.** Around 1000 tests run with no live keys. Nothing spends money or opens a port until you flip an explicit env var.

## Architecture

Three supervised OS processes, one uv-pinned Python 3.12 venv. A launchd supervisor owns them (crash-only, exponential-backoff restarts); a separate deadman cron alerts out-of-band if the supervisor itself goes quiet.

```
supervisor.py (launchd KeepAlive)        deadman (separate label, 30s)
   |
   +- P1 brain         one asyncio loop owns everything voice-shaped:
   |                   mic duplex + echo cancellation, sherpa-onnx wake word,
   |                   the EL session, CognitiveState (journal + atomic
   |                   snapshot), the custom-LLM SSE server, flash TTS for
   |                   unprompted lines, fail-closed cost breakers
   |
   +- P2 orchestrator  localhost job runner. SQLite job table, crash-isolated
   |                   subprocess pool (claude -p, codex, shell, hermes, ...),
   |                   202 + poll contract, push to the brain on job-done.
   |                   Survives a brain restart; jobs finish anyway and get
   |                   narrated on reconnect.
   |
   +- P3 surface       read-only operator glass cockpit, 127.0.0.1 only,
                       bearer-gated. Live status, telemetry feed, open jobs.
```

The audio half of P1 sits behind an `AudioBackend` protocol (start/stop/output/interrupt plus a frame callback). A native capture shell can replace the Python audio half over a unix socket (line-delimited JSON, contract in `src/yapbox/ear/SEAM.md`) without touching the brain. The default Python half (sounddevice plus APM echo cancellation) passed a 50-minute soak, so the shell stays optional; the seam stays tested.

## Modes

**Mode B** is the supported path, and it is what you run out of the box: ElevenLabs hosts the conversation LLM and reaches your brain through six client tools (dispatch, check, recall, narrate, remember, cancel). No public URL, no tunnel, works with any voice.

**Mode A** is the advanced, lowest-latency option: ElevenLabs drives the conversation against your brain's own custom-LLM endpoint through a cloudflared tunnel, giving full prompt control behind one public URL with a mandatory bearer. The mode-A endpoint code (`llm_server.py`) is in the tree, but the tunnel process that put it on a public URL was retired with the native-EL switch and is being rebuilt, so mode A is not a live opt-in today. `mode = "auto"` prefers A when a healthy tunnel is present and otherwise selects B at the session boundary; with no tunnel running it always selects B. (Instant-clone voices are mode B only.)

## Quickstart

```bash
uv sync
bin/yapbox up        # supervisor + brain + orchestrator + surface, waits on heartbeats
bin/yapbox status    # heartbeat ages for each process
bin/yapbox test      # the full mic-less suite (~1000 tests, fixtures, no network)
bin/yapbox demo      # prints the five-beat walkthrough script (a runnable demo is in progress)
bin/yapbox down      # clean teardown, no leftover PIDs or ports
```

The default posture is mock-safe: null audio backend until you configure a mic device UID, EL sessions refuse to open, flash TTS dry-runs, the operator surface binds loopback only, the deadman runs dry. Nothing spends money or exposes a port until you flip an explicit env var: `YAPBOX_AUDIO=sounddevice`, `YAPBOX_EL_LIVE=1`, `YAPBOX_TTS_LIVE=1` (flash TTS for unprompted lines; otherwise it dry-runs and charges nothing), `YAPBOX_OWL_LIVE=1`. Each flip is deliberate; none is default. (The legacy `ALBUS_*` env names are still read as a back-compat fallback.)

To go live you need one thing: an ElevenLabs API key and a voice. Drop them into a persona config under `~/.config/yapbox/<persona>/config.toml`, provision the agent (`scripts/provision_agent.py --persona <name>`), and `bin/yapbox up`.

## Docs

- `docs/QUICKSTART.md` - from clone to first wake word, step by step
- `docs/ARCHITECTURE.md` - the process model, cognitive loop, and durability doctrine
- `personas/README.md` - the soul-file contract every persona satisfies
- `docs/persona-interview.md` - a paste-ready interview that emits a contract-valid soul
- `CONTRIBUTING.md` - dev setup, test posture, and how to add a persona or a backend
- `src/yapbox/ear/SEAM.md` - the audio-seam wire contract for a native capture shell
