holdspeak 0.2.1__tar.gz

holdspeak-0.2.1/.gitignore

@@ -0,0 +1,76 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+
+# Whisper models (downloaded on first run)
+models/
+*.bin
+
+# Test fixtures (large audio files)
+tests/fixtures/*.wav
+tests/fixtures/*.mp3
+# Exception: the small (~93 KB) committed core-path smoke fixture (HS-32-04).
+# Both CI environments read this fixed WAV — see test_core_path_smoke.py.
+!tests/fixtures/core_path_smoke_16k.wav
+
+# pmo-roadmap pre-commit contract scratch
+.tmp/
+
+# Web frontend build artifacts (HS-10-01)
+web/node_modules/
+web/dist/
+web/.astro/
+holdspeak/static/_built/
+
+# AIPI-Lite local firmware/bridge runtime state
+aipi-lite/bridge.env
+aipi-lite/secrets.yaml
+aipi-lite/.esphome/
+aipi-lite/.venv/
+aipi-lite/__pycache__/
+aipi-lite/**/__pycache__/
+aipi-lite/.pytest_cache/
+aipi-lite/.ruff_cache/
+aipi-lite/.coverage
+aipi-lite/htmlcov/
+aipi-lite/*.log
+aipi-lite/debug_mic.wav
+
+# Local Claude Code state + vendored design tooling (ui-ux-pro-max skill).
+# Kept local on purpose — not part of the product repo.
+.claude/
+
+# Route screenshot harness output (web/scripts/shoot.mjs → `npm run shots`).
+web/.shots/

holdspeak-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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, "submitted"
+      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 code control systems,
+      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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   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. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 HoldSpeak contributors
+
+   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.

holdspeak-0.2.1/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: holdspeak
+Version: 0.2.1
+Summary: Voice typing for macOS and Linux - hold a hotkey, speak, release. Local & private.
+Project-URL: Homepage, https://github.com/karolswdev/HoldSpeak
+Project-URL: Repository, https://github.com/karolswdev/HoldSpeak
+Project-URL: Issues, https://github.com/karolswdev/HoldSpeak/issues
+Project-URL: Documentation, https://github.com/karolswdev/HoldSpeak/tree/main/docs
+Author-email: karolswdev <karolsane@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: dictation,linux,llm,local-first,macos,meeting,privacy,speech-to-text,transcription,voice-typing,whisper
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.100.0
+Requires-Dist: mlx-whisper>=0.4.0; sys_platform == 'darwin' and platform_machine == 'arm64'
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: pynput>=1.7.6
+Requires-Dist: pyperclip>=1.8.2
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: sounddevice>=0.4.6
+Requires-Dist: uvicorn[standard]>=0.20.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.26; extra == 'dev'
+Requires-Dist: playwright>=1.40.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.12; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.2; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: scipy>=1.10.0; extra == 'dev'
+Provides-Extra: dictation-llama
+Requires-Dist: llama-cpp-python>=0.2.90; extra == 'dictation-llama'
+Provides-Extra: dictation-mlx
+Requires-Dist: mlx-lm>=0.19; (sys_platform == 'darwin' and platform_machine == 'arm64') and extra == 'dictation-mlx'
+Requires-Dist: outlines>=0.1.0; (sys_platform == 'darwin' and platform_machine == 'arm64') and extra == 'dictation-mlx'
+Provides-Extra: dictation-openai
+Requires-Dist: openai>=1.0.0; extra == 'dictation-openai'
+Provides-Extra: linux
+Requires-Dist: faster-whisper>=1.0.0; extra == 'linux'
+Provides-Extra: meeting
+Requires-Dist: llama-cpp-python>=0.2.0; extra == 'meeting'
+Requires-Dist: openai>=1.0.0; extra == 'meeting'
+Requires-Dist: resemblyzer>=0.1.3; extra == 'meeting'
+Provides-Extra: presence
+Requires-Dist: pygobject>=3.44; (sys_platform == 'linux') and extra == 'presence'
+Requires-Dist: pyobjc-framework-cocoa>=10.0; (sys_platform == 'darwin') and extra == 'presence'
+Requires-Dist: pyobjc-framework-webkit>=10.0; (sys_platform == 'darwin') and extra == 'presence'
+Provides-Extra: test
+Requires-Dist: httpx>=0.26; extra == 'test'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest-cov>=4.0; extra == 'test'
+Requires-Dist: pytest-mock>=3.12; extra == 'test'
+Requires-Dist: pytest-timeout>=2.2; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# HoldSpeak
+
+<p align="center">
+  <img src="docs/assets/pixellab/holdspeak-mark.png" alt="HoldSpeak logo, a held key with rising soundwaves" width="120">
+</p>
+
+<p align="center"><strong>Hold a key. Speak. It types in any app. 100% local. And it learns how you work.</strong></p>
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Tests](https://github.com/karolswdev/HoldSpeak/actions/workflows/test.yml/badge.svg)](https://github.com/karolswdev/HoldSpeak/actions/workflows/test.yml)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Platform: macOS | Linux](https://img.shields.io/badge/platform-macOS%20%7C%20Linux-lightgrey.svg)](#platform-support)
+
+HoldSpeak is local-first voice input for macOS and Linux. Hold your hotkey, speak,
+release, and the text appears in whatever app you're in. No cloud, no account, no
+telemetry. Nothing leaves your machine except the model endpoint you choose to
+point at. Use it on its own as a voice-typing tool, or grow into meeting
+intelligence, project-aware dictation, and the AIPI-Lite companion device.
+
+> **Status: early / pre-release.** The features are mature, but it isn't on PyPI
+> yet, so you install from source (below). APIs, config, and defaults can still
+> change. Feedback and contributions welcome.
+
+## Why it's different
+
+- **100% local by default.** Whisper transcription and your own LLM. Nothing is
+  sent anywhere unless you deliberately point it at a cloud endpoint. See
+  [Security & privacy](docs/SECURITY.md).
+- **It gets better at your voice, and shows you the proof.** Every dictation is
+  saved: what you said, what it typed, where it routed, how long it took. Fix a
+  wrong one with a single tap and it learns; a "What HoldSpeak learned" digest
+  shows the honest "learned from N similar" count; replay an utterance through the
+  updated pipeline and watch the routing change. Local, off by default for
+  routing, no hidden retraining.
+  See [the learning loop](docs/INTELLIGENT_TYPING_GUIDE.md#12-dictation-journal-corrections--replay).
+- **Your voice gets the afterlife your meetings already have.** A dictation doesn't
+  vanish the second it's typed. It's saved, searchable, and reviewable, the same
+  way a recorded meeting is.
+- **14 real LLM-backed meeting plugins.** Architecture diagrams, ADRs, risk
+  registers, incident timelines, decisions, and stakeholder updates, all pulled out
+  of the transcript. See [meeting intelligence](docs/MEETING_MODE_GUIDE.md).
+- **Bring your own model.** GGUF in-process, MLX on Apple Silicon, or any
+  OpenAI-compatible endpoint. See [Models](docs/MODELS.md).
+- **Ambient desktop presence, if you want it.** A native, focus-safe HUD shows
+  whether it's listening, transcribing, or typing while you dictate into another
+  app. Off by default. See
+  [Desktop Presence](docs/INTELLIGENT_TYPING_GUIDE.md#11-desktop-presence-ambient-on-desktop-status).
+- **AIPI-Lite companion, if you have one.** A small device for meeting-capture
+  controls, and for speaking a reply to your coding agent from another room. See
+  [the workflow](docs/AIPI_LITE_DEV_WORKFLOW.md).
+
+## What it does, at a glance
+
+| Voice typing | Meeting intelligence | Project-aware typing |
+| --- | --- | --- |
+| ![Pixel art microphone with hold-to-talk waves](docs/assets/pixellab/hold-to-talk-microphone.png) | ![Pixel art meeting notebook with action items](docs/assets/pixellab/meeting-intelligence-notebook.png) | ![Pixel art code editor connected to local context](docs/assets/pixellab/project-aware-typing.png) |
+| Hold the hotkey, speak, release. The text goes into the active app. Punctuation commands (`"period"`, `"comma"`) and `"clipboard"` substitution work out of the box. | Capture mic and system audio together, get a live transcript with speaker labels, and let the AI pull out topics, actions, and artifacts you can review at `/history`. | Rough speech runs through intent classification, project-KB enrichment, and an LLM rewrite before it lands, tuned for Codex, Claude, the terminal, the browser, or your editor. |
+
+## See it learn
+
+<p align="center">
+  <img src="docs/assets/pixellab/operator-working-loop.gif" alt="Animated pixel art operator working at a terminal while companion and task cards update" width="280">
+</p>
+
+Speech turns into transcript context, reviewable actions, summaries, and replies
+for your coding agent, while the local runtime stays in charge. Because every
+dictation is recorded, you can look back at what it heard, fix a mistake in one tap
+(which teaches it), and replay the utterance through the updated pipeline. Instead
+of trusting that it improved, you watch it happen.
+[See the full walkthrough](docs/DICTATION_COPILOT.md).
+
+<p align="center">
+  <img src="docs/assets/screenshots/journal.png" alt="The HoldSpeak dictation Journal: a said-to-typed timeline of recent dictations, each card showing the spoken transcript, the typed result, its routing target, and a per-utterance latency strip; one row marked corrected." width="760">
+</p>
+<p align="center"><em>The dictation journal. Every utterance, with what you said, what it typed, where it routed, and how long it took.</em></p>
+
+And it shows you what it learned. The Memory tab opens with a "What HoldSpeak
+learned" digest: how many corrections you made, how many dictations you corrected,
+and for each correction a real "learned from N similar" count, computed by the
+same matcher that nudges routing. No inflated numbers, quiet when nothing matched.
+
+<p align="center">
+  <img src="docs/assets/screenshots/learning-digest-week.png" alt="The 'What HoldSpeak learned' digest: a this-week / all-time toggle, headline counts for corrections made, dictations corrected, and utterances nudged, a breakdown by block and target, and per-correction 'learned from N similar' rows." width="760">
+</p>
+<p align="center"><em>What HoldSpeak learned. Honest, windowed counts from the same matcher that nudges your routing.</em></p>
+
+## Quickstart
+
+The install script clones the repo, `doctor` checks your setup, and `holdspeak`
+launches the web runtime:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/karolswdev/HoldSpeak/main/scripts/install.sh | bash
+holdspeak doctor   # check mic permissions and backends
+holdspeak          # launch the web runtime
+```
+
+Or from a clone, with [`uv`](https://docs.astral.sh/uv/):
+
+```bash
+git clone https://github.com/karolswdev/HoldSpeak.git && cd HoldSpeak
+uv pip install -e .
+holdspeak doctor && holdspeak
+```
+
+Install only the extras you need:
+
+```bash
+uv pip install -e '.[meeting]'         # meeting mode and AI intelligence
+uv pip install -e '.[dictation-mlx]'   # intelligent dictation on Apple Silicon (MLX)
+uv pip install -e '.[dictation-llama]' # intelligent dictation, cross-platform (GGUF)
+uv pip install -e '.[dictation-openai]'# intelligent dictation via an OpenAI-compatible endpoint
+```
+
+The dictation and meeting LLM is yours to choose. See
+[`docs/MODELS.md`](docs/MODELS.md) for the contract and current suggestions.
+
+### Upgrading and your data
+
+Your whole HoldSpeak database is a single SQLite file. Before a version jump you
+can snapshot it with `holdspeak backup`, and put one back with `holdspeak
+restore`. Upgrades are safe by default: HoldSpeak backs up an older database
+before it touches it, and refuses to open a database written by a newer build
+rather than risk your data. `holdspeak doctor` reports the schema and config
+state it found. The full policy is in
+[`docs/RELEASING.md`](docs/RELEASING.md).
+
+## Platform support
+
+| Capability | macOS 14+ (Apple Silicon) | Linux X11 | Linux Wayland |
+|---|---|---|---|
+| Voice typing | ✅ | ✅ | ✅ |
+| Global hotkey | ✅ | ✅ | ⚠️ Best effort |
+| Cross-app typing | ✅ | ✅ | ⚠️ Best effort |
+| Meeting mode | ✅ | ✅ | ✅ |
+| System audio capture | ✅ BlackHole | ✅ Pulse/PipeWire | ✅ Pulse/PipeWire |
+
+Wayland often blocks global hooks and synthetic typing, so HoldSpeak falls back to clipboard paste for injection.
+
+## Meeting intelligence
+
+Record or save a meeting and HoldSpeak turns the transcript into structured,
+reviewable artifacts. It scores the transcript for intent (architecture, delivery,
+product, incident, comms), runs a chain of plugins, and has each one call your LLM
+to produce a typed artifact. The results render read-only at `/history`. HoldSpeak
+ships 14 built-in plugins, all real and backed by an LLM.
+
+Plugins can also propose actions. An actuator proposes an external side effect,
+like filing a ticket or posting an update, that only runs after you approve it for
+that specific action. Actuators are off by default. Write your own with the
+[Plugin Authoring guide](docs/PLUGIN_AUTHORING.md); for endpoints and routing, see
+the [Meeting Mode Guide](docs/MEETING_MODE_GUIDE.md).
+
+Then close the loop. After a meeting, the "Your next move" aftercare panel at
+`/history` shows what is still open (by owner), what was decided, and what changed
+since the last meeting. Jump to the transcript moment that justifies any result,
+file an accepted action as a human-approved issue through that same actuator flow,
+or draft a copyable follow-up. It is read-only and local: nothing is sent, and
+nothing runs, without your approval. See the
+[Meeting Mode Guide](docs/MEETING_MODE_GUIDE.md#meeting-aftercare-close-the-loop).
+
+## AIPI-Lite companion
+
+<p align="center">
+  <img src="docs/assets/pixellab/aipi-lite-companion.png" alt="Pixel art AIPI-Lite companion device" width="220">
+</p>
+
+AIPI-Lite is an optional ESPHome-based device you can carry between rooms. Put it
+on Wi-Fi (a phone hotspot works), and it gives you meeting-capture controls and
+status feedback. With Claude/Codex hooks on, it tells you when an agent is waiting
+so you can speak the reply back into the coding session. Buy the hardware from the
+[official page](https://aipi.com/products/aipi-lite) or the
+[Amazon listing](https://www.amazon.com/dp/B0FQNNVV36); firmware and bridge setup
+are in the [AIPI-Lite Developer Workflow](docs/AIPI_LITE_DEV_WORKFLOW.md).
+
+## Where to go next
+
+| I want to… | Read this |
+|---|---|
+| Browse all the docs | [Documentation index](docs/README.md) |
+| Get it running and verify my setup | [Getting Started](docs/GETTING_STARTED.md) |
+| Choose / configure a model | [Models (bring your own)](docs/MODELS.md) |
+| See speech become a project-grounded task | [The Dictation Copilot](docs/DICTATION_COPILOT.md) |
+| Set up project-aware dictation for Codex / Claude | [Intelligent Typing Setup](docs/INTELLIGENT_TYPING_GUIDE.md) |
+| Review, correct, and replay past dictations | [Dictation journal & replay](docs/INTELLIGENT_TYPING_GUIDE.md#12-dictation-journal-corrections--replay) |
+| Use meeting mode and configure AI intelligence | [Meeting Mode Guide](docs/MEETING_MODE_GUIDE.md) |
+| Wire up the AIPI-Lite companion | [AIPI-Lite Developer Workflow](docs/AIPI_LITE_DEV_WORKFLOW.md) |
+| Install Claude / Codex agent hooks | [Agent Hook Install](docs/AGENT_HOOK_INSTALL.md) |
+| Understand what's stored and what can leave my machine | [Security & Privacy](docs/SECURITY.md) |
+
+## Configuration
+
+Config lives at `~/.config/holdspeak/config.json`, but you rarely edit it by hand.
+The Settings page in the web runtime exposes the hotkey, model, meeting intel,
+dictation pipeline, and presence options. The full reference is in
+[Getting Started](docs/GETTING_STARTED.md) and the guides above.
+
+## Contributing
+
+Contributions are welcome. See [`CONTRIBUTING.md`](CONTRIBUTING.md) for setup
+(`uv`, the git hooks, the test command) and the commit-contract workflow. Recent
+changes are in [`CHANGELOG.md`](CHANGELOG.md).
+
+## License
+
+Licensed under the Apache License 2.0. See [`LICENSE`](LICENSE).