peon-ping

• Install
• What you'll hear
• Quick controls
• Configuration
• Peon Trainer
• MCP server
• Multi-IDE support
• Remote development
• Mobile notifications
• Sound packs
• Debugging
• Uninstall
• Requirements
• How it works
• Links

Install

Option 1: Homebrew (recommended)

brew install PeonPing/tap/peon-ping

Then run peon-ping-setup to register hooks and download sound packs. macOS and Linux.

Option 2: Installer script (macOS, Linux, WSL2)

curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.sh | bash

⚠️ WSL2 audio notes. peon-ping plays audio on the Windows side. On first run it probes your Windows host once (cached per Windows build) to pick the best playback path:

• On Windows 10 / Windows 11 pre-24H2, WPF MediaPlayer is used directly — native MP3 + WAV, no extra dependencies.

• On Windows 11 24H2+ (build 26100+), Microsoft removed legacy Windows Media Player from the OS and WPF MediaPlayer fails (MILAVERR_INVALIDWMPVERSION). peon-ping falls back to System.Media.SoundPlayer, which uses the Win32 PlaySound API and works everywhere — but it's WAV-only, so MP3 packs require ffmpeg to transcode on the fly:

  copy

  sudo apt update; sudo apt install -y ffmpeg
  

You can override the auto-detection with PEON_WSL_AUDIO_BACKEND=auto|mediaplayer|soundplayer:

• auto (default) — probe + cache as described above
• mediaplayer — force WPF MediaPlayer over the WSL UNC path (fails silently on 24H2+)
• soundplayer — force tmpfile copy + SoundPlayer (universal, requires ffmpeg for non-WAV files)

Option 3: Installer for Windows

Invoke-WebRequest -Uri "https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.ps1" -OutFile ".\install.ps1" -UseBasicParsing
powershell -ExecutionPolicy Bypass -File .\install.ps1

Installs a curated starter set of packs by default. Re-run to update while preserving config/state. Or pick your packs interactively at peonping.com and get a custom install command.

Windows installer parameters:

• -All — install all available packs
• -Packs peon,sc_kerrigan,... — install specific packs only
• -Lang en,fr,... — install only packs matching language(s)
• -Local — install packs, config, hooks, and skills into ./.claude/ for the current project
• -Global — explicit global install (same as default)
• -InitLocalConfig — create ./.claude/hooks/peon-ping/config.json only

-Local does not install the global peon CLI shim or modify your user PATH. Hooks are registered in the project-level ./.claude/settings.json with absolute paths so they work from any working directory within the project.

Windows examples:

powershell -ExecutionPolicy Bypass -File .\install.ps1 -All
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Packs peon,sc_kerrigan
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Local
powershell -ExecutionPolicy Bypass -File .\install.ps1 -InitLocalConfig

If the initial download fails with a TLS error on older Windows PowerShell, run this once in the same session and retry:

[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12

Option 4: Clone and inspect first

git clone https://github.com/PeonPing/peon-ping.git
cd peon-ping
./install.sh

On Windows PowerShell:

git clone https://github.com/PeonPing/peon-ping.git
Set-Location peon-ping
.\install.ps1

Option 5: Nix (macOS, Linux)

Run directly from source without installing:

nix run github:PeonPing/peon-ping -- status
nix run github:PeonPing/peon-ping -- packs install peon

Or install to your profile:

nix profile install github:PeonPing/peon-ping

Development shell (bats, shellcheck, nodejs):

nix develop  # or use direnv

Home Manager module (declarative configuration)

For reproducible setups, use the Home Manager module:

# In your home.nix or flake.nix
{ inputs, pkgs, ... }:

let
  peonCursorAdapterPath = "${inputs.peon-ping.packages.${pkgs.system}.default}/share/peon-ping/adapters/cursor.sh";
in {
  imports = [ inputs.peon-ping.homeManagerModules.default ];

  programs.peon-ping = {
    enable = true;
    package = inputs.peon-ping.packages.${pkgs.system}.default;
    claudeCodeIntegration = true;

    settings = {
      default_pack = "glados";
      volume = 0.7;
      enabled = true;
      desktop_notifications = true;
      categories = {
        "session.start" = true;
        "task.complete" = true;
        "task.error" = true;
        "input.required" = true;
        "resource.limit" = true;
        "user.spam" = true;
      };
    };

    # Install packs from og-packs (simple string notation)
    # and custom sources (attrset with name + src)
    installPacks = [
      "peon"
      "glados"
      "sc_kerrigan"
      # Custom pack from GitHub (openpeon.com registry)
      {
        name = "mr_meeseeks";
        src = pkgs.fetchFromGitHub {
          owner = "kasperhendriks";
          repo = "openpeon-mrmeeseeks";
          rev = "main";  # or use a commit hash for reproducibility
          sha256 = "sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=";
        };
      }
    ];
    enableZshIntegration = true;
  };

  # Optional extra IDE hooks, like Cursor
  home.file.".cursor/hooks.json".text = builtins.toJSON {
    version = 1;
    hooks = {
      afterAgentResponse = [{ command = "bash ${peonCursorAdapterPath} afterAgentResponse"; }];
      stop               = [{ command = "bash ${peonCursorAdapterPath} stop"; }];
    };
  };
}

Sound pack installation: The installPacks option supports two formats:

• Simple strings (e.g., "peon", "glados") — fetched from the og-packs repository
• Custom sources — attrset with name and src fields, where src can be any Nix fetcher result (e.g., pkgs.fetchFromGitHub)

For packs listed on openpeon.com, find the GitHub repository link and use pkgs.fetchFromGitHub:

{
  name = "pack_name";
  src = pkgs.fetchFromGitHub {
    owner = "github-owner";
    repo = "repo-name";
    rev = "main";  # or a commit hash/tag
    sha256 = "";   # Leave empty first, Nix will tell you the correct hash
  };
}

Claude Code hooks: set programs.peon-ping.claudeCodeIntegration = true; to install the Claude Code hook scripts under ~/.claude/hooks/peon-ping/ and merge the standard peon-ping hook entries into ~/.claude/settings.json.

Other IDE hooks: adapters for other IDEs are still opt-in so the module does not overwrite unrelated IDE settings. peon-ping provides adapter scripts such as cursor.sh in adapters/, and you can wire them like this:

${inputs.peon-ping.packages.${pkgs.system}.default}/share/peon-ping/adapters/$YOUR_IDE.sh EVENT_NAME

See the Cursor example above.

What you'll hear

Plus large overlay banners on every screen (macOS/WSL/MSYS2) and terminal tab titles (● project: done) — you'll know something happened even if you're in another app.

peon-ping implements the Coding Event Sound Pack Specification (CESP) — an open standard for coding event sounds that any agentic IDE can adopt.

Quick controls

Need to mute sounds and notifications during a meeting or pairing session? Two options:

Prefer it to happen automatically? Set focus_detect to have peon-ping honor macOS Focus / Do Not Disturb. Sounds and notifications go quiet whenever a Focus is on and resume when you turn it off. See also headphones_only and meeting_detect.

Other CLI commands:

Windows note: Windows currently supports the day-one controls (status, toggle, volume, core packs, notifications on/off, debug, logs, trainer). More advanced commands like setup, rotation, preview, and mobile are tracked as follow-up Windows parity work.

peon setup                # Interactive setup wizard (volume, categories, notifications)
peon pause                # Mute sounds
peon resume               # Unmute sounds
peon mute                 # Alias for 'pause'
peon unmute               # Alias for 'resume'
peon status               # Check if paused or active (concise)
peon status --verbose     # Show full details (notifications, headphones, IDEs, etc.)
peon volume               # Show current volume
peon volume 0.7           # Set volume (0.0–1.0)
peon rotation             # Show current rotation mode
peon rotation random      # Set rotation mode (random|round-robin|session_override)
peon packs list           # List installed sound packs
peon packs list --registry # Browse all available packs in the registry
peon packs community      # List all registry packs grouped by trust tier (Windows)
peon packs search <query> # Search registry packs by name (Windows)
peon packs install <p1,p2> # Install packs from the registry
peon packs install --all  # Install all packs from the registry
peon packs install-local <path> # Install a pack from a local directory
peon packs use <name>     # Switch to a specific pack (auto-installs from registry on Windows)
peon packs use --install <name>  # Switch to pack, installing from registry if needed
peon packs next           # Cycle to the next pack
peon packs remove <p1,p2> # Remove specific packs
peon packs bind <name>    # Bind a pack to the current directory
peon packs bind --pattern <path> # Bind a pack to a directory pattern, e.g. "*/services"
peon packs unbind         # Remove the current directory
peon packs bindings       # List all assigned bindings
peon packs ide-bind <ide> <name> # Bind a pack to an IDE id, e.g. codex
peon packs ide-unbind <ide> # Remove an IDE binding
peon packs ide-bindings   # List all IDE-based bindings
peon packs exclude add <path> # Silence sounds & notifications for a glob or directory
peon packs exclude remove <path> # Stop silencing the given path
peon packs exclude list   # List silenced paths
peon sounds list [pack]   # List sounds in a pack, marking disabled ones
peon sounds disable <category> <file> [--pack=<name>]  # Mute a single sound within a pack
peon sounds enable <category> <file> [--pack=<name>]   # Re-enable a previously disabled sound
peon notifications on     # Enable desktop notifications
peon notifications off    # Disable desktop notifications
peon notifications overlay   # Use large overlay banners (default)
peon notifications standard  # Use standard system notifications
peon notifications test      # Send a test notification
peon notifications position [pos]    # Get/set notification position (top-left, top-center, top-right, bottom-left, bottom-center, bottom-right)
peon notifications dismiss [N]       # Get/set auto-dismiss time in seconds (0 = persistent)
peon notifications label [text|reset] # Get/set project label override for notifications
peon notifications template [key] [fmt]  # Get/set/reset message templates (keys: stop, permission, error, idle, question)
peon preview              # Play all sounds from session.start
peon preview <category>   # Play all sounds from a specific category
peon preview --list       # List all categories in the active pack
peon mobile ntfy <topic>  # Set up phone notifications (free)
peon mobile off           # Disable phone notifications
peon mobile test          # Send a test notification
peon debug on             # Enable debug logging
peon debug off            # Disable debug logging
peon debug status         # Show debug state, log directory, file count, total size
peon logs                 # Show last 50 lines of today's log
peon logs --last N        # Show last N lines across all log files
peon logs --session ID    # Filter today's log by session ID
peon logs --session ID --all  # Search all log files for session ID
peon logs --clear         # Delete all log files (with confirmation)
peon relay --daemon       # Start audio relay (for SSH/devcontainer)
peon relay --stop         # Stop background relay

Available CESP categories for peon preview: session.start, task.acknowledge, task.complete, task.error, input.required, resource.limit, user.spam. (Extended categories session.end and task.progress are defined in the CESP spec and supported by pack manifests, but not currently triggered by built-in hook events.)

Tab completion is supported — type peon packs use <TAB> to see available pack names.

Pausing mutes sounds and desktop notifications instantly. Persists across sessions until you resume. Tab titles remain active when paused.

Configuration

Quickstart — peon setup

The fastest way to configure peon-ping is the interactive wizard:

peon setup

It walks you through every common setting in one go — press Enter at any prompt to keep the current value:

  ╔══════════════════════════════════════╗
  ║       peon-ping  setup wizard        ║
  ╚══════════════════════════════════════╝

  ── Volume ──
  > Volume (0.0 - 1.0) (0.5):

  ── Sound categories ──
  >   Session start [on/off] (on):
  >   Task acknowledge [on/off] (off):
  >   Task complete [on/off] (on):
  >   Task error [on/off] (on):
  >   Input required (permissions, questions) [on/off] (on):
  >   Resource limit (context compaction) [on/off] (on):
  >   User spam (rapid prompts) [on/off] (on):

  ── Notifications ──
  > Desktop notifications [on/off] (on):

  Overlay theme:
    1) Neon (cyberpunk)
    2) Glass (translucent)
    3) Sakura (cherry blossom)
    4) Jarvis (iron man)
  > Theme [neon]:

  Notification position:
    1) Top center
    2) Top right
    ...
  > Position [top-center]:

  Auto-dismiss:
    1) Persistent (click to dismiss)
    2) 3 seconds
    3) 4 seconds
    ...
  > Dismiss time [4]:

  ✓ Configuration saved!

What the wizard covers:

• Volume — playback volume (0.0 – 1.0)
• Sound categories — enable/disable each CESP category individually (session start, task complete, permission prompts, errors, etc.)
• Desktop notifications — master switch for overlay banners
• Overlay theme — choose the visual style (neon, glass, sakura, jarvis)
• Position — where notifications appear (top-center, top-right, etc.)
• Auto-dismiss — how long notifications stay visible (0 = persistent, click to dismiss)

When you're done, the wizard prints a summary and saves everything to ~/.claude/hooks/peon-ping/config.json. You can rerun peon setup anytime to tweak settings — it always shows your current values as defaults.

Tip: All individual peon subcommands (peon volume, peon notifications position top-right, etc.) still work if you prefer scripting or tweaking one setting at a time — see the Quick controls section.

Slash commands and manual config

peon-ping also installs slash commands in Claude Code:

• /peon-ping-toggle — mute/unmute sounds
• /peon-ping-config — change any setting (volume, packs, categories, etc.)
• /peon-ping-rename <name> — give this session a custom name shown in notification titles and the terminal tab title (zero tokens, hook-intercepted); no argument resets to auto-detect

You can also just ask Claude to change settings for you — e.g. "enable round-robin pack rotation", "set volume to 0.3", or "add glados to my pack rotation". No need to edit config files manually.

Config location depends on install mode:

• Global install: $CLAUDE_CONFIG_DIR/hooks/peon-ping/config.json (default ~/.claude/hooks/peon-ping/config.json)
• Local install: ./.claude/hooks/peon-ping/config.json

{
  "volume": 0.5,
  "categories": {
    "session.start": true,
    "task.acknowledge": true,
    "task.complete": true,
    "task.error": true,
    "input.required": true,
    "resource.limit": true,
    "user.spam": true
  }
}

Independent Controls

peon-ping has three independent controls that can be mixed and matched:

This means you can:

• Keep sounds but disable desktop popups: peon notifications off

• Keep desktop popups but disable sounds: peon pause

• Enable mobile push without desktop popups: set desktop_notifications: false and mobile_notify.enabled: true

• volume: 0.0–1.0 (quiet enough for the office)

• desktop_notifications: true/false — toggle desktop notification popups independently from sounds (default: true). When disabled, sounds continue playing but visual popups are suppressed. Mobile notifications are unaffected.

• notification_style: "overlay" or "standard" — controls how desktop notifications appear (default: "overlay")

  • overlay: large, visible banners — JXA Cocoa overlay on macOS, Windows Forms popup on WSL/MSYS2. Clicking the overlay focuses your terminal (supports Ghostty, Warp, iTerm2, Zed, Terminal.app). On iTerm2, clicking focuses the correct tab/pane/window — not just the app.
  • standard: system notifications — terminal-notifier / osascript on macOS, Windows toast on WSL/MSYS2. When terminal-notifier is installed (brew install terminal-notifier), clicking a standard notification focuses your terminal automatically (supports Ghostty, Warp, iTerm2, Zed, Terminal.app). On native Windows, clicking a toast notification focuses the IDE or terminal window (supports VS Code, Cursor, Windsurf, Windows Terminal, PowerShell). With multiple windows open, the notification targets the exact window that originated the event via PID-based process tree matching.

• overlay_theme: "jarvis", "glass", "sakura", or omit for the default overlay — macOS only (default: none)

  • jarvis: circular HUD with rotating arcs, graduation ticks, and progress ring
  • glass: glassmorphism panel with accent color bar, progress line, and timestamp
  • sakura: zen garden with bonsai tree and animated cherry blossom petals

• categories: Toggle individual CESP sound categories on/off (e.g. "session.start": false to disable greeting sounds)

• annoyed_threshold / annoyed_window_seconds: How many prompts in N seconds triggers the user.spam easter egg

• silent_window_seconds: Suppress task.complete sounds and notifications for tasks shorter than N seconds. (e.g. 10 to only hear sounds for tasks that take longer than 10 seconds)

• session_start_cooldown_seconds (number, default: 30): Deduplicates greeting sounds when multiple workspaces start at the same time (e.g. opening OpenCode or Cursor with many folders). Only the first session start plays the greeting; subsequent ones within this window stay silent. Set to 0 to disable deduplication and always play a greeting.

• suppress_idle_prompt_repeats (boolean, default: true): Claude Code re-fires its idle_prompt notification every ~60s while the terminal is unfocused. peon-ping routes idle_prompt to task.complete so you still get a sound when input is needed — but without dedupe the same sound replays on every poke. When true, an idle_prompt is suppressed if a task.complete for the same session already fired inside idle_prompt_suppress_window_seconds. Set to false to restore the periodic nudge.

• idle_prompt_suppress_window_seconds (number, default: 3600): Window used by suppress_idle_prompt_repeats. After a task.complete fires for a session, subsequent idle_prompt notifications for that session stay silent for this many seconds. Set to 0 to disable the window (effectively the same as suppress_idle_prompt_repeats: false).

• suppress_subagent_complete (boolean, default: false): Suppress sounds and notifications from sub-agent activity. When Claude Code's Task tool dispatches parallel sub-agents, each one fires its own events: a completion sound on finish, task.error on failed Bash commands, input.required on permission requests. Set this to true to hear only the parent session's sounds. Events fired from inside a sub-agent are detected via the agent_id field Claude Code adds to their hook payloads; separate-session sub-agents (older clients, other IDEs) are still detected by the SubagentStart timing heuristic.

• default_pack: The fallback pack used when no more specific rule applies (default: "peon"). Replaces the old active_pack key — existing configs are migrated automatically on peon update.

• path_rules: Array of { "pattern": "...", "pack": "..." } objects. Assigns a pack to sessions based on the working directory using glob matching (*, ?). First matching rule wins. Beats pack_rotation and default_pack; overridden by session_override assignments.

  copy

  "path_rules": [
    { "pattern": "*/work/client-a/*", "pack": "glados" },
    { "pattern": "*/personal/*",      "pack": "peon" }
  ]
  

• exclude_dirs: Array of glob or directory patterns. If the current working directory matches one of these entries, all sounds and notifications are silenced for that invocation (the hook logs suppressed=True reason=excluded_dir pattern=<match>). Bare directory paths also match descendants, so "~/conductor/workspaces" silences everything under that tree. Use this for noisy background agents (e.g. CodexBar/ClaudeProbe), throwaway scratch dirs, or sensitive workspaces where audio alerts are unwanted.

  copy

  "exclude_dirs": [
    "~/conductor/workspaces",
    "~/Library/Application Support/CodexBar*"
  ]
  

• ide_rules: Array of { "ide": "...", "pack": "..." } objects. Assigns a pack by IDE/source after path_rules and before rotation/default fallback. First matching rule wins. Common ids: claude, codex, cursor, opencode, kilo, kiro, gemini, copilot, windsurf, kimi, antigravity, amp, deepagents, openclaw, rovodev.

  copy

  "ide_rules": [
    { "ide": "codex",  "pack": "glados" },
    { "ide": "claude", "pack": "peon" }
  ]
  

• pack_rotation: Array of pack names (e.g. ["peon", "sc_kerrigan", "peasant"]). Used when pack_rotation_mode is random or round-robin. Leave empty [] to use default_pack (or path_rules / ide_rules) only.

• pack_rotation_mode: "random" (default), "round-robin", or "session_override". With random/round-robin, each session picks one pack from pack_rotation. With session_override, the /peon-ping-use <pack> command assigns a pack per session. Invalid or missing packs fall back through the hierarchy. ("agentskill" is accepted as a legacy alias for "session_override".)

• session_ttl_days (number, default: 7): Expire stale per-session pack assignments older than N days. Keeps .state.json from growing unbounded when using session_override mode.

• headphones_only (boolean, default: false): Only play sounds when headphones or external audio devices are detected. When enabled, sounds are suppressed if built-in speakers are the active output — useful for open offices. Check status with peon status. Supported on macOS (via system_profiler) and Linux (via PipeWire wpctl or PulseAudio pactl).

• terminal_tab_title (boolean, default: true): Update the terminal tab title with the current session status (for example ● project: done). Set to false if you already manage tab titles with your own shell prompt or terminal automation and only want peon-ping's sounds/notifications.

• suppress_sound_when_tab_focused (boolean, default: false): Skip sound playback when the terminal tab that generated the hook event is the currently active/focused tab. Sounds still play for background tabs as an alert that something happened elsewhere. Desktop and mobile notifications are unaffected. Useful when you only want audio cues from tabs you're not watching. macOS only (uses osascript to check frontmost app and iTerm2 tab focus).

• meeting_detect Detects if the microphone is currently being used and temporarily suppresses the audio only until the microphone is no longer in use. Notification still appears.

• focus_detect (boolean, default: false): Honor macOS Focus / Do Not Disturb. peon-ping plays sounds via afplay and draws overlays in a custom window, and both bypass Notification Center, so the system Focus toggle has no effect on them by default. When enabled, peon-ping reads the Focus state directly and suppresses output whenever any Focus (Do Not Disturb, Work, Sleep, etc.) is active, then resumes automatically when you turn Focus off. Mobile push (if configured) is unaffected, since your phone honors its own Focus. macOS only, and it fails open (if the Focus state can't be read, sounds play as normal).

• focus_detect_mode (string, default: "all"): What focus_detect suppresses while a Focus is active. "all" mutes both the sound and the overlay/desktop notification. "sound" mutes only the sound (notifications still appear). "notifications" mutes only the notification (sound still plays). Ignored when focus_detect is false.

• notification_position (string, default: "top-center"): Where overlay notifications appear on screen. Options: "top-left", "top-center", "top-right", "bottom-left", "bottom-center", "bottom-right".

• notification_dismiss_seconds (number, default: 4): Auto-dismiss overlay notifications after N seconds. Set to 0 for persistent notifications that require a click to dismiss.

• notification_all_screens (boolean, default: true): Show overlay notifications on all screens (true) or only the main screen (false). Themed overlays (glass, jarvis, sakura) previously only showed on one screen — existing configs with those themes are migrated to false automatically. macOS only.

• CLAUDE_SESSION_NAME env var: Set before launching claude to give a session a custom name. Shows in both desktop notification titles and terminal tab titles. Priority over all config-based naming. Example: CLAUDE_SESSION_NAME="Auth Refactor" claude or export CLAUDE_SESSION_NAME="Feature: Auth" then claude. Each terminal gets its own title automatically since peon-ping runs as a child of that Claude instance.

• notification_title_override (string, default: ""): Override the project name shown in notification titles. When empty, the project name is auto-detected from /peon-ping-rename > CLAUDE_SESSION_NAME > .peon-label > notification_title_script > project_name_map > git repo name > folder name.

• notification_title_marker (string, default: "●"): Character(s) shown before the project name in notification titles and terminal tab titles. Desktop notification titles use Project by default; terminal tab titles keep Project: status. Set to "" to disable. Example: "🔔".

• notification_title_ide (boolean, default: false): Include the normalized IDE label in desktop notification titles as Project - IDE. When disabled, the title stays Project and the message/body carries the status/details.

• notification_title_script (string, default: ""): Shell command run at event time to compute the project name dynamically. Receives env vars: PEON_SESSION_ID, PEON_CWD, PEON_HOOK_EVENT, PEON_IDE, PEON_SESSION_NAME. Use stdout (trimmed, max 50 chars); non-zero exit falls through to the next tier. PEON_IDE is the normalized IDE/source id such as codex or claude. Example: "basename $PEON_CWD".

• project_name_map (object, default: {}): Map directory paths to custom project labels for notifications. Keys are path patterns, values are display names. Example: { "/home/user/work/client-a": "Client A" }.

• notification_templates (object, default: {}): Custom message/body format strings for notification events. Keys are event types (stop, permission, error, idle, question), values are template strings with variable substitution. Available variables: {project}, {ide}, {ide_id}, {summary}, {tool_name}, {status}, {event}. Example: { "stop": "{status}: {summary}", "permission": "{status}: {tool_name}" }.

Pack Selection Hierarchy

peon-ping resolves which sound pack to use through a 6-layer hierarchy. The first layer that produces a valid, installed pack wins:

If a layer references a pack that is not installed, it falls through to the next layer. If exclude_dirs matches the current working directory, the entire invocation is silenced — no sound, no notification.

Per-Project Pack Assignment (path_rules)

Assign different sound packs to different projects based on directory path. Use the CLI or edit config.json directly.

CLI (recommended):

peon packs bind glados                     # Bind glados to the current directory
peon packs bind sc_kerrigan --pattern "*/services/*"  # Bind to a glob pattern
peon packs bind duke_nukem --install       # Bind and install from registry if needed
peon packs unbind                          # Remove binding for the current directory
peon packs unbind --pattern "*/services/*" # Remove a specific pattern binding
peon packs bindings                        # List all bindings

Manual config:

"path_rules": [
  { "pattern": "*/work/client-a/*", "pack": "glados" },
  { "pattern": "*/personal/*",      "pack": "peon" },
  { "pattern": "*/services/*",      "pack": "sc_kerrigan" }
]

Rules use glob matching (*, ?). First matching rule wins. Path rules override pack_rotation and default_pack but are overridden by session_override assignments.

Per-IDE Pack Assignment (ide_rules)

Use this layer when a path is noisy or shared across tools and you want a pack to follow the IDE instead.

CLI (recommended):

peon packs ide-bind codex glados        # Use glados for Codex sessions
peon packs ide-bind claude peon         # Use peon for Claude Code
peon packs ide-unbind codex             # Remove one IDE rule
peon packs ide-bindings                 # List IDE rules and recent detections

Manual config:

"ide_rules": [
  { "ide": "codex",  "pack": "glados" },
  { "ide": "claude", "pack": "peon" }
]

ide_rules run after path_rules.

Common Use Cases

Sounds without popups

Want voice feedback but no visual distractions?

peon notifications off

This keeps all sound categories playing while suppressing desktop notification banners. Mobile notifications (if configured) continue working.

You can also use the alias:

peon popups off

Silent mode with notifications only

Want visual alerts but no audio?

peon pause  # or set "enabled": false in config

With desktop_notifications: true, you'll get popups but no sounds.

Complete silence

Disable everything:

peon pause
peon notifications off
peon mobile off

Peon Trainer

Your peon is also your personal trainer. Built-in Pavel-style daily exercise mode — the same orc who tells you "work work" now tells you to drop and give him twenty.

Quick start

peon trainer on              # enable trainer
peon trainer goal 200        # set daily goal (default: 300/300)
# ... code for a while, peon nags you every ~20 min ...
peon trainer log 25 pushups  # log what you did
peon trainer log 30 squats
peon trainer status          # check progress

How it works

Trainer reminders piggyback on your coding session. When you start a new session, the peon immediately encourages you to start strong with pushups before you write any code. Then every ~20 minutes of active coding, you'll hear the peon yelling at you to do more reps. No background daemon needed. Log your reps with peon trainer log, and progress resets automatically at midnight.

Commands

Schedule vs uniform goals

Exercises can have either a uniform daily goal (same every day) or a per-day schedule (different goals on different days). These are mutually exclusive:

• Setting a uniform goal removes any schedule for that exercise
• Setting a day-specific goal removes any uniform goal for that exercise

Days use short names: mon, tue, wed, thu, fri, sat, sun

peon trainer goal pushups 300         # 300 pushups every day (uniform)
peon trainer goal pushups mon 400     # Override: 400 on Monday (creates schedule)
peon trainer goal squats sun 0        # Rest day for squats on Sunday
peon trainer goal fri 150             # Light day for all exercises on Friday

On rest days (goal=0), reminders are skipped and status shows [REST DAY]. You can still log reps on rest days if you want.

Claude Code skill

In Claude Code, you can log reps without leaving your conversation:

/peon-ping-log 25 pushups
/peon-ping-log 30 squats

Custom voice lines

Drop your own audio files into ~/.claude/hooks/peon-ping/trainer/sounds/:

trainer/sounds/session_start/  # session greeting ("Pushups first, code second! Zug zug!")
trainer/sounds/remind/         # reminder lines ("Something need doing? YES. PUSHUPS.")
trainer/sounds/log/            # acknowledgment ("Work work! Muscles getting bigger maybe!")
trainer/sounds/complete/       # celebration ("Zug zug! Human finish all reps!")
trainer/sounds/slacking/       # disappointment ("Peon very disappointed.")

Update trainer/manifest.json to register your sound files.

MCP server

peon-ping includes an MCP (Model Context Protocol) server so any MCP-compatible AI agent can play sounds directly via tool calls — no hooks required.

The key difference: the agent chooses the sound. Instead of automatically playing a fixed sound on every event, the agent calls play_sound with exactly what it wants — duke_nukem/SonOfABitch when a build fails, sc_kerrigan/IReadYou when reading files.

Setup

Add to your MCP client config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "peon-ping": {
      "command": "node",
      "args": ["/path/to/peon-ping/mcp/peon-mcp.js"]
    }
  }
}

If installed via Homebrew: $(brew --prefix peon-ping)/libexec/mcp/peon-mcp.js. See mcp/README.md for full setup instructions.

What the agent can do

Requires Node.js 18+. Contributed by @tag-assistant.

Multi-IDE Support

peon-ping works with any agentic IDE that supports hooks. Adapters translate IDE-specific events to the CESP standard.

Windows: All adapters have native PowerShell (.ps1) versions. The Windows installer (install.ps1) copies them to ~/.claude/hooks/peon-ping/adapters/. Filesystem watchers (Amp, Antigravity, Kimi, Trae) use .NET FileSystemWatcher instead of fswatch/inotifywait — no extra dependencies needed.

OpenAI Codex setup

Codex support uses an adapter and is not auto-registered by peon-ping-setup.

The Codex adapter expects the peon-ping runtime to exist at ~/.claude/hooks/peon-ping/, even if you only use Codex and do not use Claude Code.

Setup:

1. Install the peon-ping runtime first:

   copy

   bash "$(brew --prefix peon-ping)"/libexec/install.sh --no-rc
   

   Or with the standard installer:

   copy

   curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/install.sh | bash -s -- --no-rc
   

2. Add this to ~/.codex/config.toml:

   copy

   notify = ["bash", "~/.claude/hooks/peon-ping/adapters/codex.sh"]
   

3. Restart Codex.

If you installed with Homebrew, the runtime files are managed under ~/.claude/hooks/peon-ping/, and the Codex adapter forwards Codex notify events into that shared runtime.

Amp setup

A filesystem watcher adapter for Amp (by Sourcegraph). Amp doesn't expose event hooks like Claude Code, so this adapter watches Amp's thread files on disk and detects when the agent finishes a turn.

Setup:

1. Ensure peon-ping is installed (curl -fsSL https://peonping.com/install | bash)

2. Install fswatch (macOS) or inotify-tools (Linux):

   copy

   brew install fswatch        # macOS
   sudo apt install inotify-tools  # Linux
   

3. Start the watcher:

   copy

   bash ~/.claude/hooks/peon-ping/adapters/amp.sh        # foreground
   bash ~/.claude/hooks/peon-ping/adapters/amp.sh &       # background
   

Event mapping:

• New thread file created → Greeting sound ("Ready to work?", "Yes?")
• Thread file stops updating + agent finished turn → Completion sound ("Work, work.", "Job's done!")

How it works:

The adapter watches ~/.local/share/amp/threads/ for JSON file changes. When a thread file stops updating (1s idle timeout) and the last message is from the assistant with text content (not a pending tool call), it emits a Stop event — meaning the agent is done and waiting for your input.

Environment variables:

GitHub Copilot CLI setup

Native GitHub Copilot CLI integration with full CESP v1.0 conformance.

Recommended: user-level (global) wiring — no per-repo setup.

install.sh and install.ps1 automatically register Copilot CLI hooks at ~/.copilot/hooks/peon-ping.json whenever the ~/.copilot/ directory exists. Re-run the installer if you installed Copilot CLI after peon-ping. The wiring uses PascalCase event names, which tells Copilot CLI to deliver the VS Code-compatible (snake_case) payload that peon.sh / peon.ps1 reads natively — no per-repo adapter required.

Hooks registered globally:

postToolUse is intentionally not wired: peon has no PostToolUse handler and routing it through Stop floods the debounce window, swallowing real Stop events.

Prerequisite (Windows): Copilot CLI hooks require PowerShell 7+ (pwsh on PATH) and a permissive execution policy:

winget install Microsoft.PowerShell
powershell -NoProfile -Command "Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned -Force"

Alternative: per-repository wiring with the adapter.

If you want Copilot CLI hooks committed to a specific repository (e.g. for a team workflow), use .github/hooks/hooks.json with the adapters/copilot.sh (or .ps1 on Windows) translator:

{
  "version": 1,
  "hooks": {
    "sessionStart": [
      {
        "type": "command",
        "bash": "bash ~/.claude/hooks/peon-ping/adapters/copilot.sh sessionStart",
        "powershell": "powershell -NoProfile -File %USERPROFILE%\\.claude\\hooks\\peon-ping\\adapters\\copilot.ps1 sessionStart"
      }
    ],
    "agentStop": [
      {
        "type": "command",
        "bash": "bash ~/.claude/hooks/peon-ping/adapters/copilot.sh agentStop",
        "powershell": "powershell -NoProfile -File %USERPROFILE%\\.claude\\hooks\\peon-ping\\adapters\\copilot.ps1 agentStop"
      }
    ],
    "postToolUseFailure": [
      {
        "type": "command",
        "bash": "bash ~/.claude/hooks/peon-ping/adapters/copilot.sh postToolUseFailure",
        "powershell": "powershell -NoProfile -File %USERPROFILE%\\.claude\\hooks\\peon-ping\\adapters\\copilot.ps1 postToolUseFailure"
      }
    ],
    "notification": [
      {
        "type": "command",
        "bash": "bash ~/.claude/hooks/peon-ping/adapters/copilot.sh notification",
        "powershell": "powershell -NoProfile -File %USERPROFILE%\\.claude\\hooks\\peon-ping\\adapters\\copilot.ps1 notification"
      }
    ]
  }
}

Add additional events from the table above as desired. The adapter translates Copilot CLI's camelCase payload (sessionId, toolName, stopReason, etc.) to the snake_case shape (session_id, tool_name, stop_reason) that peon.sh / peon.ps1 reads.

Features:

• Sound playback via afplay (macOS), pw-play/paplay/ffplay (Linux), MediaPlayer/SoundPlayer (Windows) — same priority chain as the shell hook
• CESP event mapping — Copilot CLI hooks map to standard CESP categories (session.start, task.complete, task.error, input.required, user.spam, resource.limit)
• Desktop notifications — large overlay banners by default, or standard notifications
• Spam detection — detects 3+ rapid prompts within 10 seconds, triggers user.spam voice lines
• Debouncing — Stop events suppressed within a 5s window to prevent spam from chained tool calls

OpenCode setup

A native TypeScript plugin for OpenCode with full CESP v1.0 conformance.

Quick install:

curl -fsSL https://raw.githubusercontent.com/PeonPing/peon-ping/main/adapters/opencode.sh | bash

The installer copies peon-ping.ts to ~/.config/opencode/plugins/ and creates a config at ~/.config/opencode/peon-ping/config.json. Packs are stored at the shared CESP path (~/.openpeon/packs/).

Features:

• Sound playback via afplay (macOS), pw-play/paplay/ffplay (Linux) — same priority chain as the shell hook
• CESP event mapping — session.created / session.idle / session.error / permission.asked / rapid prompt detection all map to standard CESP categories
• Desktop notifications — large overlay banners by default (JXA Cocoa, visible on all screens), or standard notifications via terminal-notifier / osascript. Fires only when the terminal is not focused.

…view the full README on GitHub.