Documentation

Installation

Install Ringly in two steps on Windows 10/11.

Installation is a two-step process. Skipping either step is the only way the native toast won’t show up — it’s not a design choice, it’s a Windows 10/11 requirement (see About the AUMID below).

Step 1 — Install the ringly CLI

In your terminal:

npm install -g ringly
ringly init

The interactive installer does it all:

  • registers the Claude.Code.CLI AUMID on Windows (required for ToastNotificationManager to authorize the toast),
  • creates a Start Menu shortcut bound to that AUMID,
  • writes the initial configuration to ~/.claude/settings.json (with an automatic backup),
  • prints the exact step 2 command to paste into Claude Code.

Non-interactive mode

If you’re in CI or prefer to apply defaults without the TUI:

ringly init --non-interactive

Applies auto language, all events except SubagentStop on, sound on, debug off, update check on.

Step 2 — Install the plugin inside Claude Code

Inside Claude Code:

/plugin marketplace add nickdevcode/Ringly
/plugin install ringly@ringly

The plugin registers the 5 hooks (Notification, Stop, StopFailure, SubagentStop, SessionStart) and the embedded dispatcher uses the AUMID already registered in step 1.

From here, tweak language, events, sound, and debug via ringly config (TUI) or by editing ~/.claude/settings.json directly.

Verifying the install

Run doctor to confirm everything is wired up:

ringly doctor

You should see something like:

9 passed · 0 warnings · 0 failed

If something is off, the command itself will point you at the fix.

To fire a test toast:

ringly test --event Stop

A toast should appear in the bottom-right corner of your screen within a moment.

About the AUMID

The Application User Model ID is how Windows 10/11 identifies apps that fire toasts. ToastNotificationManager requires this ID to be registered system-wide before authorizing the notification to show up in the Action Center.

Ringly uses Claude.Code.CLI as its AUMID and registers it automatically during ringly init, alongside a Start Menu shortcut that points at that ID. Without that registration, Windows silently drops the toast by design — no warning, no error, nothing.

That’s why skipping step 1 doesn’t work, even if the plugin is registered in Claude Code.

Quick troubleshooting

  • No toast appears. Check Focus Assist / Do Not Disturb on Windows. Run ringly doctor to inspect AUMID registration and notification permissions.
  • AUMID missing after reinstall. Run ringly init --force to recreate the Start Menu shortcut and re-register the application ID.
  • Hook seems silent. Enable debug: true by running ringly config and check the log path printed at the end of ringly doctor.

More details in Troubleshooting.

Edit on GitHub Last updated: 2026-05-26