---
slug: "notification-skill"
source_type: "readme"
source_url: "https://cdn.jsdelivr.net/gh/caopulan/Notification-Skill@main/README.md"
repo: "https://github.com/caopulan/Notification-Skill"
source_file: "README.md"
branch: "main"
---
# :bell: Notification Skill

[中文](https://github.com/caopulan/Notification-Skill/blob/HEAD/README_ZH.md)

Send push notifications when an Agent task finishes or when you need to notify users (currently supports Bark and email).

## :sparkles: Features
- :zap: **Quick setup:** Only three steps to get started: install a skill, set environment variables, and update AGENTS.md so the Agent can notify
- :desktop_computer: **Multi-device naming:** Set `CODEX_MACHINE_NAME` to distinguish devices
- 📣 **Multi-device notification** Bark (iphone), Email (any devices)

## :book: Usage

### 1. :package: Install Notification-Skill

Choose the notification tool you need to install:
```bash
$skill-installer https://github.com/caopulan/Notification-Skill/tree/main/bark-notify
$skill-installer https://github.com/caopulan/Notification-Skill/tree/main/email-notify
```

### 2. :gear: Configure

#### 1) :key: Get required keys or parameters
1. [Bark](https://github.com/finb/bark)
2. [Email](https://support.google.com/a/answer/176600?hl=en) (Gmail as example)

#### 2) :wrench: Set environment variables on the machine

Set environment variables (for example in `~/.zshrc` or `~/.bashrc`):

```bash
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
```

#### 3) :label: (Optional) Set project name

- Add a project name in `AGENTS.md`
- Otherwise, the directory name is used as the project name

### 3. :rocket: Use

#### 1) :memo: Add instructions in `AGENTS.md`
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
```

#### 2) :computer: Explicit invocation
1. Bark

```bash
python bark-notify/scripts/send_bark_notification.py \
  --task-title "Task summary" \
  --status "success" \
  --summary "What was done" \
  --project-name "..."
```
2. Email

```bash
python email-notify/scripts/send_email_notification.py \
  --task-title "..." \
  --status "success" \
  --summary "..." \
  --project-name "..."
```