Skip to main content

Quickstart

Get PeonPing running and hear your first notification in under 2 minutes.
1

Install PeonPing

brew install PeonPing/tap/peon-ping
peon-ping-setup
This installs PeonPing, registers hooks in ~/.claude/settings.json, and downloads 5 curated sound packs.
2

Start your AI coding agent

Open Claude Code, Cursor, OpenCode, or any supported IDE:
claude
# or: cursor, opencode, amp, etc.
You should hear a greeting sound:
  • Peon (default): “Ready to work?”
  • GLaDOS: “Oh, it’s you.”
  • Kerrigan: “I gotcha.”
3

Ask your agent to do something

Give your agent a task:
Create a hello.py file that prints "Hello, World!"
When the agent finishes, you’ll hear a completion sound:
  • Peon: “Work, work.”
  • GLaDOS: “Okay.”
  • Kerrigan: “Easily amused, huh?”
Plus a large overlay notification banner showing the task is complete.
4

Preview all sounds (optional)

Want to hear what other sounds are in your active pack?
peon preview
This plays all sounds from the session.start category. To preview other categories:
peon preview task.complete
peon preview task.error
peon preview input.required

Quick controls

Need to mute sounds during a meeting?
peon toggle          # Mute/unmute
peon pause           # Mute sounds
peon resume          # Unmute sounds
peon status          # Check if paused or active

Switch sound packs

Try different game characters:
peon packs use glados       # Portal GLaDOS
peon packs use peasant      # Warcraft Peasant
peon packs use sc_kerrigan  # StarCraft Kerrigan
peon packs next             # Cycle to next pack
Browse all 165+ packs:
peon packs list --registry
Or visit peonping.com/#picker for an interactive browser with audio previews.

Adjust volume

peon volume           # Show current volume
peon volume 0.5       # Set volume (0.0–1.0)
peon volume 0.3       # Quieter for the office

Configure notifications

PeonPing shows large overlay banners by default. Switch to standard system notifications:
peon notifications standard
Or disable desktop notifications entirely (sounds only):
peon notifications off
Learn more in Notifications.

IDE-specific setup

PeonPing auto-detects and configures Claude Code, Cursor, and OpenCode. For other IDEs, see:

Amp

Filesystem watcher adapter

GitHub Copilot

Repository hooks.json setup

Gemini CLI

settings.json adapter

All integrations

See all 13+ supported IDEs

Next steps

Sound Events

Learn about all CESP event categories

Configuration

Customize volume, packs, and notifications

Remote Development

Set up audio relay for SSH and devcontainers

CLI Reference

Explore all CLI commands

Build docs developers (and LLMs) love