Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (codex-notify-wsl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Codex Notify for WSL

Windows toast notifications for Codex running in WSL. Never miss an approval prompt again.

Features

Windows toast notifications when Codex needs approval
Configurable notification types (approval, success, error, long-running)
Multiple notification methods with automatic fallback
Simple configuration file
Minimal dependencies

Installation

npm (Recommended)

npm install -g codex-notify-wsl

Manual Installation

git clone https://github.com/yourusername/codex-notify-wsl.git
cd codex-notify-wsl
npm install
npm link

Quick Setup

Install a Windows notification tool (choose one):

BurntToast (Recommended):
```
# PowerShell Admin
Install-Module -Name BurntToast -Force
```
SnoreToast: Download from GitHub and place in C:\Windows\System32
Reload your shell:
```
source ~/.bashrc
```
Test notifications:
```
codex-notify test all
```

Usage

# Use Codex with notifications
codex "your prompt"

# Without notifications
codex-silent "your prompt"

# Direct Codex (bypass wrapper)
codex-real "your prompt"

Configuration

Configuration file: ~/.codex/notify.env

# Edit configuration
codex-notify config

# Or edit directly
nano ~/.codex/notify.env

Configuration Options

# Core Settings
NOTIFY_ENABLED=true          # Enable/disable all notifications
NOTIFY_METHOD=auto          # auto, burnttoast, snoretoast, msg, bell
NOTIFY_SOUNDS=true          # Play sounds
NOTIFY_PERSISTENT=false     # Keep notifications until dismissed
NOTIFY_DEBUG=false          # Verbose logging

# Event Triggers
NOTIFY_ON_APPROVAL=true     # Approval prompts
NOTIFY_ON_SUCCESS=true      # Task completion
NOTIFY_ON_ERROR=true        # Errors
NOTIFY_ON_LONG_RUN=true     # Long-running tasks (>60s)

# Customization
LONG_TASK_THRESHOLD=60      # Seconds before "long-running" alert
CUSTOM_PATTERNS=""          # Pipe-separated custom patterns
USE_EMOJIS=true            # Visual emojis in titles
NOTIFICATION_COOLDOWN=2     # Min seconds between notifications

Environment Variable Overrides

Override any setting via environment variables:

# Disable for one command
CODEX_NOTIFY_ENABLED=false codex "your prompt"

# Force specific method
CODEX_NOTIFY_METHOD=burnttoast codex "your prompt"

# Debug mode
CODEX_NOTIFY_DEBUG=true codex "your prompt"

Testing

# Test all notification types
codex-notify test all

# Test specific types
codex-notify test approval
codex-notify test success
codex-notify test error

Troubleshooting

No notifications appearing

Check Windows Focus Assist settings

Verify notification tool is installed:

Get-Module -ListAvailable -Name BurntToast

Check logs:
```
tail ~/.codex/notifications.log
```

Common Issues

Problem	Solution
No notifications	Check Focus Assist, install BurntToast/SnoreToast
No sound	Check Windows volume mixer
Wrong notification type	Adjust patterns in config file

How It Works

The wrapper script monitors Codex output for specific patterns:

"approval requested", "waiting for permission" → Approval notification
"task complete", "finished successfully" → Success notification
"error occurred", "failed" → Error notification
Tasks >60 seconds → Long-running notification

Requirements

WSL 2 on Windows 10/11
Codex CLI
PowerShell access from WSL
BurntToast or SnoreToast (optional but recommended)

Files

codex-notify         # Main wrapper script
.env.example        # Configuration template
install.sh          # Installation script
README.md          # This file

Contributing

Pull requests welcome. Please test changes with both BurntToast and fallback methods.

License

MIT