Summary

Code-Notify addresses the need for timely desktop notifications from AI coding assistants like Claude Code, Codex, Gemini CLI, and Oh My Pi. It targets developers who use these tools, providing essential alerts for task completion or when user input is required, thereby reducing context switching and improving workflow efficiency.

How It Works

The project integrates with AI coding tools by leveraging their respective hook systems, configuring them to trigger a notification script (notifier.sh) or a managed extension. For tools like Codex and Oh My Pi, it manages specific configurations (e.g., ~/.omp/agent/extensions/code-notify.js or notify = ["/absolute/path/to/notifier.sh", "codex"] for Codex). This approach allows Code-Notify to intercept and relay events such as task completions, enabling a unified notification pipeline. Notifications can be delivered via native system alerts, custom sounds, voice announcements, or mirrored to Slack and Discord channels.

Quick Start & Requirements

Installation is streamlined across platforms:

• macOS: brew tap mylee04/tools && brew install code-notify
• Linux/WSL: curl -sSL https://raw.githubusercontent.com/mylee04/code-notify/main/scripts/install.sh | bash
• npm: npm install -g code-notify (macOS/Linux/Windows)
• Windows: irm https://raw.githubusercontent.com/mylee04/code-notify/main/scripts/install-windows.ps1 | iex A Node.js environment is required for npm installations. Official downloads are available at https://github.com/mylee04/code-notify/releases.

Highlighted Details

• Multi-Tool Integration: Supports Claude Code, OpenAI Codex, Google Gemini CLI, and Oh My Pi (omp).
• Cross-Platform: Operates on macOS, Linux, and Windows.
• Rich Notification Options: Includes native desktop alerts, custom sound playback, voice announcements (macOS/Windows), and Slack/Discord webhook integration.
• Usage Alerts: Opt-in notifications for Codex and Claude token usage thresholds (20%, 10%, and reset events).
• macOS Click-through: Allows users to configure which application opens when a macOS notification is clicked.

Maintenance & Community

No specific details regarding maintainers, community channels (like Discord/Slack), or project sponsorships were found in the provided README content.

Licensing & Compatibility

The project is distributed under the MIT License, which generally permits broad use, modification, and distribution, including for commercial purposes, with minimal restrictions.

Limitations & Caveats

Currently, the integration with Codex and Oh My Pi primarily supports completion events; approval and request_permissions prompts are not yet exposed via their hook systems. By default, notifications are limited to idle prompts, though other alert types can be explicitly enabled. Background usage watching (cn usage watch start) is only supported on macOS and Linux.