Send push notifications when an Agent task finishes or when you need to notify users (currently supports Bark and email).
- β‘ Quick setup: Only three steps to get started: install a skill, set environment variables, and update AGENTS.md so the Agent can notify
- π₯οΈ Multi-device naming: Set
CODEX_MACHINE_NAMEto distinguish devices - π£ Multi-device notification Bark (iphone), Email (any devices)
Choose the notification tool you need to install:
$skill-installer https://github.com/caopulan/Notification-Skill/tree/main/bark-notify
$skill-installer https://github.com/caopulan/Notification-Skill/tree/main/email-notifySet environment variables (for example in ~/.zshrc or ~/.bashrc):
export CODEX_MACHINE_NAME="Your-Machine-Name"
# Bark
export CODEX_BARK_KEY="your-bark-key"
export CODEX_BARK_BASE_URL="https://api.day.app"
# Email
export CODEX_EMAIL_SMTP_HOST="smtp.example.com"
export CODEX_EMAIL_SMTP_PORT="587"
export CODEX_EMAIL_USERNAME="user@example.com"
export CODEX_EMAIL_PASSWORD="..."
export CODEX_EMAIL_FROM="user@example.com"
export CODEX_EMAIL_TO="recipient1@example.com,recipient2@example.com"
export CODEX_EMAIL_USE_TLS="false" # true/false, default false
export CODEX_EMAIL_USE_SSL="true" # true/false, default true- Add a project name in
AGENTS.md - Otherwise, the directory name is used as the project name
You can configure the global AGENTS.md to notify for all tasks on this machine. For example in ~/.codex/AGENTS.md:
- After each task, notify the user via the bark-notify/email-notify skill
- Bark
python bark-notify/scripts/send_bark_notification.py \
--task-title "Task summary" \
--status "success" \
--summary "What was done" \
--project-name "..."python email-notify/scripts/send_email_notification.py \
--task-title "..." \
--status "success" \
--summary "..." \
--project-name "..."