mavor 0.1.0__tar.gz

mavor-0.1.0/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 Matthew Schulkind
+
+   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.

mavor-0.1.0/PKG-INFO

@@ -0,0 +1,378 @@
+Metadata-Version: 2.4
+Name: mavor
+Version: 0.1.0
+Summary: Low-latency voice dictation — hotkey to talk, text typed into the focused window
+Author: Matt Schulkind
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mschulkind-oss/mavor
+Project-URL: Repository, https://github.com/mschulkind-oss/mavor
+Project-URL: Issues, https://github.com/mschulkind-oss/mavor/issues
+Keywords: dictation,speech-to-text,voice,wayland,whisper,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# mavor — low-latency voice dictation
+
+Tap a hotkey, talk, tap again. The transcribed text is typed into whatever
+window has focus and copied to the clipboard. A small "● Recording" pill
+appears at the top of the screen — clear of Waybar — while you speak, with
+a live audio waveform meter, and flips to an amber indicator while whisper.cpp or
+Sherpa-ONNX runs.
+
+```
+$mod + ` ──▶  ● Recording   ▂▃▅▆          (HUD overlay with live audio meter)
+              talking talking talking
+$mod + ` ──▶  ⟳ Transcribing…             (in-process CGO / whisper.cpp)
+              ──▶ wtype + wl-copy         (text lands in focused app)
+              overlay closes
+```
+
+CLI subcommands:
+
+- `mavor daemon` — long-lived process. Owns the overlay, audio capture,
+  the speech-to-text (STT) engine, PipeWire audio ducking, and a Unix-socket
+  IPC server.
+- `mavor start` / `mavor stop` — push-to-talk keybind controls (hold to speak).
+- `mavor toggle` — toggle mode control (press once to start, press again to stop).
+- `mavor doctor` — self-diagnostic health check for Wayland, audio, and tools.
+- `mavor config init` — scaffold `~/.config/mavor/config.toml` with documented defaults.
+- `mavor service install` — install and enable systemd user service (`mavor.service`).
+
+> [!NOTE]
+> **Where it runs today:** Linux, on a Wayland compositor implementing
+> `wlr-layer-shell` (the overlay) and `virtual-keyboard-v1` (typing, via
+> `wtype`) — sway, Hyprland, river, Wayfire, niri, labwc. Not GNOME, which
+> implements neither.
+>
+> This is the first backend, not the design. Capture, transcription, overlay
+> and text output are four independent interfaces (§[Project layout](#project-layout)),
+> and only the overlay and the output emitter are Wayland-specific. Other
+> compositors and platforms are a matter of writing those two, not of
+> rearchitecting.
+
+## Why this exists
+
+Dictation on Linux tends to arrive as an appliance: one vendor's model, one
+opinionated UI, a tray icon, and a service that wants to own your microphone.
+Meanwhile the interesting work is happening in the models — whisper.cpp,
+Parakeet, Zipformer, Moonshine, SenseVoice, Paraformer, a new one every few
+months, each with its own build, its own model layout, and its own idea of what
+an API is.
+
+`mavor` is the boring layer under that. Three goals, in order:
+
+**One interface in front of every model.** A single `Transcriber` contract with
+an out-of-process `whisper-cli`, a warm HTTP or Unix-socket server, and
+in-process sherpa-onnx behind it, so switching engines is a line in a config
+file rather than a different program. `mavor models list` shows the whole
+catalog — size, languages, whether it streams — and `mavor models pull` puts it
+where the engine will find it. Trying a new model should cost a minute, not an
+afternoon.
+
+**Minimal and unintrusive.** No tray icon, no window, no background service
+listening for a wake word, no telemetry. A daemon that idles until you press a
+key, a floating pill that appears while you speak and disappears when you stop,
+and text in the window you were already typing in. It holds the microphone only
+between `start` and `stop`, and the one piece of UI it draws is deliberately
+the smallest thing that still tells you it is listening.
+
+**A good citizen of a Wayland tiling session.** Built for compositors rather
+than in spite of them: a `wlr-layer-shell` overlay that floats clear of your
+bar instead of stealing focus or spawning a window your tiler has to place,
+`wtype` for input so text lands in the focused surface through the compositor's
+own protocols, and PipeWire ducking so whatever you were listening to gets out
+of the way while you talk. It is driven entirely by keybinds and a Unix socket,
+which is what makes it scriptable rather than clickable.
+
+## Install
+
+### Go
+
+```bash
+go install github.com/mschulkind-oss/mavor/cmd/mavor@latest
+```
+
+### Release binary
+
+Each tagged release publishes a `linux/amd64` tarball and a `checksums.txt`
+on the [releases page](https://github.com/mschulkind-oss/mavor/releases).
+
+```bash
+tar -xzf mavor_v0.1.0_linux_amd64.tar.gz
+install -m 0755 mavor ~/.local/bin/mavor
+```
+
+### From source
+
+```bash
+git clone https://github.com/mschulkind-oss/mavor
+cd mavor
+mise install                 # gets the right toolchain
+just install                 # builds and copies binary to ~/.local/bin/mavor
+
+# Or deploy binary + install systemd user service in one step:
+just deploy
+```
+
+## Quick Start & Verification
+
+Run the built-in diagnostic tool to verify your Wayland and audio environment:
+
+```bash
+mavor doctor
+```
+
+Initialize your configuration file:
+
+```bash
+mavor config init
+```
+
+## Compositor integration
+
+### Push-to-Talk Mode (Recommended)
+
+```
+# ~/.config/sway/config
+exec mavor daemon
+bindsym $mod+grave exec mavor start
+bindsym --release $mod+grave exec mavor stop
+```
+
+### Toggle Mode
+
+```
+# ~/.config/sway/config
+exec mavor daemon
+bindsym $mod+grave exec mavor toggle
+```
+
+The overlay is a `wlr-layer-shell` surface on the `top` layer and does **not** request
+an exclusive zone, which means two things: it floats over your content without
+resizing windows, and the compositor places it *inside* the space other bars
+have reserved. `top_margin` is therefore a gap below Waybar, not an offset from
+the screen edge — a bar of any height, or no bar at all, works without
+configuring anything.
+
+## Systemd User Service
+
+Alternatively, run the daemon as a systemd user unit that starts automatically with your graphical session:
+
+```bash
+mavor service install --start
+mavor service status
+```
+
+## Configuration
+
+`$XDG_CONFIG_HOME/mavor/config.toml` (defaults to `~/.config/mavor/config.toml`).
+All paths support `~` and `$ENVIRONMENT_VARIABLES`. Run `mavor config show` to inspect.
+
+```toml
+top_margin   = 8                             # px between screen top and overlay
+engine       = "cli"                         # "cli" (whisper.cpp) or "sherpa" (CGO ONNX)
+model        = "base.en"                     # whisper ggml model name
+model_dir    = "~/.cache/mavor/models"       # where downloaded models live
+duck_audio   = true                          # duck music/browser audio while recording
+duck_volume  = "0%"                          # level while recording ("0%" mutes; raise to merely lower)
+duck_streams = ["spotify", "firefox"]        # target specific media apps
+socket       = "$XDG_RUNTIME_DIR/mavor.sock" # daemon IPC socket
+```
+
+## Models
+
+Models are downloaded explicitly, never at runtime — the daemon fails at
+startup with a `mavor models pull` hint rather than stalling a dictation on a
+multi-gigabyte fetch.
+
+`mavor models list` shows everything available, with what is already in the
+cache marked:
+
+```
+NAME                 ENGINE       SIZE  LANGUAGES            STREAM  STATUS         ALIASES
+tiny.en              whisper   74.1 MB  en                   no      –              whisper-tiny.en
+base.en              whisper  141.1 MB  en                   no      ✓ 141.1 MB  ★  whisper-base.en
+large-v3-turbo       whisper   1.51 GB  multi (99)           no      –              whisper-large-v3-turbo
+parakeet             sherpa   429.4 MB  en                   yes     –              parakeet-tdt
+sensevoice-small     sherpa   999.3 MB  zh, en, ja, ko, yue  no      –              sensevoice
+zipformer-streaming  sherpa   296.0 MB  en                   yes     –              zipformer
+
+★ active   ✓ downloaded   – not downloaded
+```
+
+- **STREAM** marks models that decode incrementally as you speak. Whisper is
+  encoder-decoder over 30-second windows, so it always transcribes after you
+  stop; the streaming sherpa transducers do not.
+- **SIZE** is the download. The sherpa archives expand to roughly twice that
+  on disk.
+- **ALIASES** are alternate names accepted by `mavor models pull` and by
+  `model` / `sherpa_model` in `config.toml`.
+
+```bash
+mavor models list                # the catalog above
+mavor models list --installed    # only what is downloaded
+mavor models list --verbose      # a block per model, with the detail below
+mavor models pull base.en        # production default
+mavor models pull tiny.en        # smallest; what the test suite uses
+```
+
+`--verbose` adds the properties that do not fit a column:
+
+```
+parakeet
+  NeMo FastConformer transducer, 80ms chunk — decodes while you speak
+  engine      sherpa (in-process sherpa-onnx, CGO)
+  download    429.4 MB
+  languages   en
+  streaming   yes — decodes incrementally while you speak
+  speed       fast (relative tier, not measured)
+  vocabulary  hotwords via sherpa_hotwords_file
+  gpu         none in practice — the bundled ONNX Runtime is a CPU-only build
+  aliases     parakeet-tdt
+  status      ✓ downloaded (850.7 MB)
+  source      https://github.com/k2-fsa/sherpa-onnx/releases/...
+```
+
+- **speed** is a relative tier across the catalog, estimated from architecture
+  and parameter count. Where a real benchmark exists it is labelled `measured`
+  and carries the real-time factor from [`docs/reports/`](docs/reports/).
+- **vocabulary** is what biasing the model can take. sherpa-onnx implements it
+  by boosting paths during transducer beam search, so only the transducers can
+  use a `sherpa_hotwords_file`; the CTC and encoder-decoder models cannot.
+  Whisper models take none today — mavor does not pass an initial prompt.
+- **gpu** depends on the build you are running, not on the model. Run
+  `mavor doctor`, which reports what your whisper.cpp and ONNX Runtime can
+  actually use rather than what the config asks for.
+
+Whisper models are fetched from the whisper.cpp GGML repository and land in
+`model_dir` as `ggml-<name>.bin`. Sherpa models come from the sherpa-onnx
+release assets and unpack into `model_dir/sherpa/<name>/`.
+
+## Development
+
+`just --list` for the full set. The interesting ones:
+
+| target          | what it runs                                                  |
+|-----------------|---------------------------------------------------------------|
+| `just check`    | format + vet + unit tests (fast dev gate)                     |
+| `just check-ci` | read-only CI / pre-commit verification                        |
+| `just test`     | unit tests only — fast, no Wayland required                   |
+| `just test-int` | integration tests: spawns headless sway + waybar + daemon     |
+| `just test-e2e` | e2e: real whisper transcription with the `tiny.en` model      |
+| `just storybook`| runs UI storybook test and produces HTML screenshot report    |
+| `just install`  | builds and installs binary to `~/.local/bin/mavor`            |
+| `just deploy`   | installs binary and sets up systemd user service              |
+| `just doctor`   | runs environment health check (`mavor doctor`)                |
+| `just build`    | compiles binary at `bin/mavor`                                |
+| `just dev`      | runs the daemon against your live Wayland session, verbose    |
+
+### Test layout
+
+- **Unit tests** (`go test ./...`): pure Go, mocked Recorder/Transcriber/
+  Overlay/Output. Fast, run under `-race`.
+- **Integration tests** (`go test -tags=integration ./test/integration/...`):
+  spin up a real headless wlroots sway, optionally waybar, the real daemon
+  binary, a host PipeWire null-sink, and assert against grim screenshots
+  and `wl-paste` output.
+- **End-to-end test** (`go test -tags=e2e ./...`): real whisper-cli plus
+  a downloaded model.
+
+The integration test rig lives in `test/integration/harness.go`. Each
+test gets its own `XDG_RUNTIME_DIR`, dbus session, headless sway, and
+optionally waybar + null-sink. Cleanup happens in `t.Cleanup`.
+
+### Project layout
+
+```
+cmd/mavor/                   # CLI entrypoint & subcommands (daemon, doctor, config, service, models)
+internal/state/              # Idle ⇄ Recording ⇄ Transcribing FSM
+internal/audio/              # Recorder interface + parec impl + VAD + PipeWire ducking
+internal/speech/             # Pluggable STT engines (whisper-cli, sherpa-onnx CGO, HTTP server)
+internal/overlay/            # Layer-shell HUD: paint.go renders, overlay_wl.go presents
+internal/wayland/            # Minimal hand-written Wayland client (wire protocol, layer-shell, shm)
+internal/ipc/                # JSON-over-Unix-socket protocol
+internal/output/             # wtype + wl-copy dispatch
+internal/config/             # XDG_CONFIG_HOME/mavor/config.toml loader with ~/$VAR expansion
+internal/daemon/             # wires everything; main.go is a thin caller
+test/integration/            # headless sway + audio-stack test harness
+```
+
+### Build tags
+
+The default build is pure Go. `CGO_ENABLED=0` works, cross-compilation works,
+and no system development headers are needed to build it.
+
+- `sherpa`: link the in-process sherpa-onnx recognizers. This is the only
+  variant that needs cgo, and therefore the only one that cannot be
+  cross-compiled.
+- `integration`: build the headless-sway test harness.
+- `e2e`: opt in to tests that exercise real whisper-cli + a downloaded model.
+
+## Built on
+
+`mavor` is a thin daemon around other people's hard work. In rough order of how
+much of the heavy lifting they do:
+
+**Speech recognition**
+
+- [whisper.cpp](https://github.com/ggml-org/whisper.cpp) — the `whisper-cli`
+  and `whisper-server` binaries behind the `cli` and `server` engines, and the
+  GGML model format the catalog pulls.
+- [sherpa-onnx](https://github.com/k2-fsa/sherpa-onnx) and its Go bindings,
+  [sherpa-onnx-go](https://github.com/k2-fsa/sherpa-onnx-go) — the in-process
+  `sherpa` engine, including the streaming transducers.
+  ([ONNX Runtime](https://github.com/microsoft/onnxruntime) rides along inside
+  the platform modules; a `sherpa`-tagged build links roughly 90 MB of it.)
+- [OpenAI Whisper](https://github.com/openai/whisper),
+  [NVIDIA NeMo](https://github.com/NVIDIA/NeMo) (Parakeet),
+  [k2-fsa/icefall](https://github.com/k2-fsa/icefall) (Zipformer),
+  [Useful Sensors](https://github.com/usefulsensors/moonshine) (Moonshine) and
+  [FunASR](https://github.com/modelscope/FunASR) (SenseVoice, Paraformer) — the
+  model families the catalog carries.
+
+**Desktop integration**
+
+- [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots) and the
+  [wlr-layer-shell](https://github.com/swaywm/wlr-protocols) protocol — what
+  lets the overlay be an anchored surface rather than a window your tiler has
+  to place. mavor speaks the protocol directly rather than through a library.
+- [golang.org/x/image](https://pkg.go.dev/golang.org/x/image) — the rasterizer
+  the pill is drawn with, and the Go font it is typeset in. Embedding the font
+  is what makes the overlay render identically on every machine.
+- [wtype](https://github.com/atx/wtype) — synthetic keystrokes over
+  `virtual-keyboard-unstable-v1`.
+- [wl-clipboard](https://github.com/bugaevc/wl-clipboard) — `wl-copy` and
+  `wl-paste`.
+- [PipeWire](https://pipewire.org/) and
+  [PulseAudio](https://www.freedesktop.org/wiki/Software/PulseAudio/) utilities
+  — `parec` for capture and `pactl` for ducking.
+- [sway](https://swaywm.org/) and [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots)
+  — the compositor this is built for, and the headless one the integration
+  tests run against.
+
+**Go modules**
+
+| Module | License |
+|---|---|
+| [`golang.org/x/image`](https://pkg.go.dev/golang.org/x/image) | BSD-3-Clause |
+| [`golang.org/x/sys`](https://pkg.go.dev/golang.org/x/sys) | BSD-3-Clause |
+| [`github.com/k2-fsa/sherpa-onnx-go`](https://github.com/k2-fsa/sherpa-onnx-go) | Apache-2.0 |
+| [`github.com/k2-fsa/sherpa-onnx-go-linux`](https://github.com/k2-fsa/sherpa-onnx-go-linux) | Apache-2.0 |
+| [`github.com/pelletier/go-toml/v2`](https://github.com/pelletier/go-toml) | MIT |
+| [`golang.org/x/text`](https://pkg.go.dev/golang.org/x/text) | BSD-3-Clause |
+
+**Testing**
+
+- [grim](https://sr.ht/~emersion/grim) for the screenshots the integration
+  suite and the UI storybook assert against, and
+  [Waybar](https://github.com/Alexays/Waybar) as the bar the overlay has to
+  stay clear of.