Skip to content

docs: WSL & native post-install usage block #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rhishi99 merged 1 commit into from
Jun 26, 2026
Merged

docs: WSL & native post-install usage block #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ This project was **designed and built end-to-end with [Grok Build](https://grok.
/plugin install speaker@outloud
```

After install you'll see `/speaker:speak` (a.k.a. `/speak`) in the command list and the Stop hook starts capturing responses automatically. **The plugin still needs Python TTS deps + a working audio device** — see [Using OutLoud after install](#-using-outloud-after-install-wsl--native) (essential on WSL).

### Option B — Clone & set up locally (incl. WSL)

```bash
Expand All @@ -118,6 +120,47 @@ See the dedicated **[Status Line](#status-line-informational-only)** section bel

---

## ▶️ Using OutLoud after install (WSL & native)

Installing the plugin registers the commands and the Stop hook — but **speech needs Python TTS deps and an audio device**. Do this once:

**1. Install the voice deps** (in the same Python the plugin will call):

```bash
cd /path/to/claude-code-voice # WSL example: /mnt/e/.../claude-code-voice
pip3 install --user edge-tts playsound==1.2.2
```

> ⚠️ The plugin runs `python scripts/speaker.py`. On most WSL distros only `python3` exists — make `python` resolve:
> ```bash
> python --version || sudo apt install -y python-is-python3
> ```

**2. Smoke test (confirms edge-tts + audio):**

```bash
python scripts/speaker.py "Hello from OutLoud"
```

- You hear it → ready. ✅
- Silent but logs `Played cleanly...` → no audio device. WSL2 has **no sound by default**; you need **WSLg** (Windows 11 / recent Windows 10 provides PulseAudio out of the box).

**3. Drive it from Claude Code:**

| Command | Effect |
|---|---|
| `/speak on` | auto-narrate every reply (fires after the Stop hook) |
| `/speak last` | speak the last response on demand |
| `/speak "some text"` | speak arbitrary text now |
| `/speak off` | disable auto-narration |
| `/speak stop` | best-effort stop current playback |

> Tip: `/speak` with **no argument** is ambiguous (the agent will ask what you want). Use `/speak last` or `/speak on` to act directly.

The default engine is **edge-tts** (natural neural voice). `OUTLOUD_MUTE=1` is a global kill switch honored everywhere. If a response wasn't captured yet, capture happens on the **next** Stop — ask something first, then `/speak last`.

---

## 🐧 Test in WSL + Claude Code (simplest path)

> First time? This is the shortest route to hearing OutLoud inside Claude Code running in WSL. ~3 minutes.
Expand Down
Loading