Skip to content

softcane/aloud

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Aloud

Aloud reads Claude Code and Codex replies aloud on macOS.

Turn it on with aloud on in any Claude Code or Codex session. Aloud speaks a short summary after each assistant reply. Use Cmd + Ctrl + H for the full reply, or Cmd + Ctrl + . to stop playback.

Aloud uses Kokoro for local text-to-speech. The Python package installs Kokoro. Kokoro downloads its model files the first time speech generation starts, then reuses the local cache. Aloud does not send agent replies to an external TTS service.

Requirements

  • macOS.
  • Python 3.11 or 3.12.
  • Homebrew.
  • Claude Code, Codex CLI, or both.

Install

brew install python@3.11 pipx
pipx ensurepath
pipx install --python python3.11 git+https://github.com/softcane/aloud.git
aloud install
aloud doctor

Restart Claude Code or Codex after install. In Codex, open /hooks and trust the Aloud hooks. In macOS System Settings, give Hammerspoon Accessibility permission for the hotkeys.

The installer:

  • creates the Aloud config, cache, log, and session directories;
  • starts a launchd daemon for speech generation;
  • installs Hammerspoon hotkeys;
  • installs Claude Code commands and Codex prompt shortcuts;
  • merges Aloud hooks into Claude Code and Codex settings;
  • writes timestamped backups before editing hook settings.

Use

Inside Claude Code or Codex:

aloud on

Aloud arms only that session. Later replies in that session speak a short summary. The agent does not receive aloud on as a prompt.

Claude Code also supports /aloud-on and /aloud-off. In Codex, use aloud on and aloud off; Codex prompt shortcuts are available as /prompts:aloud-on and /prompts:aloud-off after Codex reloads its prompt list.

Controls:

  • aloud off: stop speaking this session.
  • Cmd + Ctrl + H: speak the full reply from the last session Aloud spoke.
  • Cmd + Ctrl + .: stop playback.
  • aloud full: speak the full reply from a terminal.
  • aloud stop: stop playback from a terminal.

Multiple sessions are tracked separately. If session A speaks, the full-reply hotkey reads session A even if session B finishes later.

Commands

aloud doctor
aloud self-test --no-audio
aloud voices
aloud voices --play
aloud uninstall

doctor checks the installed files and hooks. self-test --no-audio checks the registry without using Kokoro or audio hardware. voices --play previews Kokoro voices on the current macOS output device.

Files

Aloud writes mutable files under ~/Library:

  • config: ~/Library/Application Support/Aloud/config.json
  • socket and session registry: ~/Library/Application Support/Aloud/
  • WAV cache: ~/Library/Caches/Aloud/
  • daemon log: ~/Library/Logs/Aloud/daemon.log
  • launchd plist: ~/Library/LaunchAgents/io.aloud.daemon.plist

Edit config.json to change voice, speed, or retention settings.

launchctl unload ~/Library/LaunchAgents/io.aloud.daemon.plist
launchctl load -w ~/Library/LaunchAgents/io.aloud.daemon.plist

Uninstall

aloud uninstall
pipx uninstall aloud

Uninstall removes the launchd plist, Hammerspoon hotkeys, Claude Code commands, Codex prompt shortcuts, and hook entries. It leaves state, cache, and logs in place for inspection.

To remove those files too:

rm -rf ~/Library/Application\ Support/Aloud ~/Library/Caches/Aloud ~/Library/Logs/Aloud

Development

git clone https://github.com/softcane/aloud.git
cd aloud
python3.11 -m venv .venv
.venv/bin/python -m pip install -e '.[dev]'
.venv/bin/ruff check .
.venv/bin/ruff format --check .
.venv/bin/pytest
.venv/bin/aloud doctor
.venv/bin/aloud self-test --no-audio

Before release, also run live smoke tests in Claude Code and Codex CLI, then run one real audio smoke on the current macOS output device.

Credits

Aloud depends on Kokoro for local speech, espeak-ng for phonemization, and Hammerspoon for hotkeys.

License

MIT.

About

Aloud reads Claude Code and Codex replies out loud on your Mac.

Topics

Resources

License

Stars

4 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages