|
| 1 | +# Deep Code 任务完成通知 |
| 2 | + |
| 3 | +当 AI 助手完成一轮任务后，Deep Code 可以自动执行一个通知脚本，将任务结果发送到你指定的渠道（如 Slack、系统通知等）。 |
| 4 | + |
| 5 | +## 工作原理 |
| 6 | + |
| 7 | +在 `settings.json` 中配置 `notify` 字段，指向一个可执行脚本的完整路径。每次 AI 助手完成任务应答后，Deep Code 会执行该脚本，并通过环境变量注入上下文信息。 |
| 8 | + |
| 9 | +## 注入的环境变量 |
| 10 | + |
| 11 | +| 环境变量 | 说明 | |
| 12 | +|----------|------| |
| 13 | +| `DURATION` | 会话耗时，单位秒（整数） | |
| 14 | +| `STATUS` | 会话状态：`"completed"` 或 `"failed"` | |
| 15 | +| `FAIL_REASON` | 失败原因（仅失败时设置） | |
| 16 | +| `BODY` | 最后一条 AI 助手回复的文本内容 | |
| 17 | +| `TITLE` | 会话标题（对应 resume 列表中的标题） | |
| 18 | + |
| 19 | +## 配置方法 |
| 20 | + |
| 21 | +编辑 `~/.deepcode/settings.json`，添加 `notify` 字段： |
| 22 | + |
| 23 | +```json |
| 24 | +{ |
| 25 | + "env": { |
| 26 | + "MODEL": "deepseek-v4-pro", |
| 27 | + "BASE_URL": "https://api.deepseek.com", |
| 28 | + "API_KEY": "sk-..." |
| 29 | + }, |
| 30 | + "thinkingEnabled": true, |
| 31 | + "reasoningEffort": "max", |
| 32 | + "notify": "/path/to/your-notify-script.sh" |
| 33 | +} |
| 34 | +``` |
| 35 | + |
| 36 | +你也可以在 `env` 中配置通知脚本所需的自定义环境变量，例如 Slack Webhook URL： |
| 37 | + |
| 38 | +```json |
| 39 | +{ |
| 40 | + "env": { |
| 41 | + "MODEL": "deepseek-v4-pro", |
| 42 | + "BASE_URL": "https://api.deepseek.com", |
| 43 | + "API_KEY": "sk-...", |
| 44 | + "SLACK_WEBHOOK_URL": "https://hooks.slack.com/services/*****/****/**********" |
| 45 | + }, |
| 46 | + "notify": "/Users/you/.deepcode/notify-slack.sh" |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +这些 `env` 中的变量会被注入到脚本的执行环境中。 |
| 51 | + |
| 52 | +## Slack 通知 |
| 53 | + |
| 54 | +### 1. 获取 Slack Webhook URL |
| 55 | + |
| 56 | +1. 创建 [Slack App](https://api.slack.com/apps) |
| 57 | +2. 在 App 页面点击 **Incoming Webhooks** → **Add New Webhook to Workspace**，生成 Webhook URL |
| 58 | + |
| 59 | +### 2. 创建通知脚本 |
| 60 | + |
| 61 | +创建 `~/.deepcode/notify-slack.sh`： |
| 62 | + |
| 63 | +```bash |
| 64 | +#!/usr/bin/env bash |
| 65 | +SLACK_WEBHOOK_URL="${SLACK_WEBHOOK_URL:-}" |
| 66 | +CURRENT_DIR=$(pwd) |
| 67 | +BRANCH=$(git branch --show-current 2>/dev/null) |
| 68 | +curl -X POST "$SLACK_WEBHOOK_URL" \ |
| 69 | + -H "Content-type: application/json" \ |
| 70 | + --data "{ |
| 71 | + \"text\": \"✅ Deep Code 任务已完成\n · cwd: $CURRENT_DIR\n · Branch: $BRANCH\n · Duration: $DURATION 秒\" |
| 72 | + }" |
| 73 | +``` |
| 74 | + |
| 75 | +给脚本添加可执行权限： |
| 76 | + |
| 77 | +```bash |
| 78 | +chmod +x ~/.deepcode/notify-slack.sh |
| 79 | +``` |
| 80 | + |
| 81 | +### 3. 配置 settings.json |
| 82 | + |
| 83 | +```json |
| 84 | +{ |
| 85 | + "env": { |
| 86 | + "SLACK_WEBHOOK_URL": "https://hooks.slack.com/services/*****/****/**********" |
| 87 | + }, |
| 88 | + "notify": "/Users/you/.deepcode/notify-slack.sh" |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +> Python 版本的脚本同样支持，你可以在 `env` 中传入并引用任意自定义环境变量。 |
| 93 | +
|
| 94 | +## 飞书 / 企业微信等 Webhook 通知 |
| 95 | + |
| 96 | +以下示例使用 `node` 构建 JSON（自动转义特殊字符），`curl` 发送。通过 `env` 传入 `WEBHOOK_URL`： |
| 97 | + |
| 98 | +```bash |
| 99 | +#!/bin/bash |
| 100 | +WEBHOOK_URL="${WEBHOOK_URL:-}" |
| 101 | + |
| 102 | +STATUS="${STATUS:-completed}" |
| 103 | +TITLE="${TITLE:-Untitled}" |
| 104 | +DURATION="${DURATION:-0}" |
| 105 | +BODY="${BODY:-(no output)}" |
| 106 | + |
| 107 | +PAYLOAD=$(node -e " |
| 108 | +process.stdout.write(JSON.stringify({ |
| 109 | + msg_type: 'interactive', |
| 110 | + card: { |
| 111 | + header: { title: { tag: 'plain_text', content: 'DeepCode: ' + process.env.TITLE + ' ' + process.env.STATUS + ' [' + process.env.DURATION + 's]' } }, |
| 112 | + elements: [{ tag: 'markdown', content: (process.env.BODY || '').slice(0, 2000) || '(no output)' }] |
| 113 | + } |
| 114 | +})) |
| 115 | +") |
| 116 | + |
| 117 | +curl -s -X POST "$WEBHOOK_URL" \ |
| 118 | + -H "Content-Type: application/json" \ |
| 119 | + -d "$PAYLOAD" |
| 120 | +``` |
| 121 | + |
| 122 | +```json |
| 123 | +{ |
| 124 | + "env": { |
| 125 | + "WEBHOOK_URL": "https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxx" |
| 126 | + }, |
| 127 | + "notify": "/Users/you/.deepcode/notify-feishu.sh" |
| 128 | +} |
| 129 | +``` |
| 130 | + |
| 131 | +将 `WEBHOOK_URL` 替换为你的飞书机器人 Webhook 地址。此模式同样适用于 Slack、企业微信等 webhook 类通知，只需修改 JSON payload 格式。 |
| 132 | + |
| 133 | +## 终端通知（iTerm2 / Windows Terminal） |
| 134 | + |
| 135 | +如果你的终端是 iTerm2 或 Windows Terminal，可以直接通过 OSC 9 转义序列弹出终端原生通知，无需额外依赖。 |
| 136 | + |
| 137 | +创建 `~/.deepcode/notify.sh`： |
| 138 | + |
| 139 | +```bash |
| 140 | +#!/bin/bash |
| 141 | +# iTerm2 / Windows Terminal OSC 9 通知 |
| 142 | +printf '\x1b]9;DeepCode: task %s (%ss)\x07' "${STATUS:-completed}" "${DURATION}" |
| 143 | +``` |
| 144 | + |
| 145 | +```json |
| 146 | +{ |
| 147 | + "notify": "/Users/you/.deepcode/notify.sh" |
| 148 | +} |
| 149 | +``` |
| 150 | + |
| 151 | +Windows 用户如使用 Git Bash，上述脚本同样可用；也可创建 `.bat` 脚本： |
| 152 | + |
| 153 | +```batch |
| 154 | +@echo off |
| 155 | +REM Windows Terminal OSC 9 通知 |
| 156 | +echo \x1b]9;DeepCode: task %STATUS% (%DURATION%s)\x07 |
| 157 | +``` |
| 158 | + |
| 159 | +## macOS 系统通知 |
| 160 | + |
| 161 | +```bash |
| 162 | +#!/bin/bash |
| 163 | +# macOS 系统通知 |
| 164 | +osascript -e "display notification \"任务已${STATUS:-完成}，耗时 ${DURATION}s\" with title \"DeepCode\"" |
| 165 | +``` |
| 166 | + |
| 167 | +```json |
| 168 | +{ |
| 169 | + "notify": "/Users/you/.deepcode/notify.sh" |
| 170 | +} |
| 171 | +``` |
| 172 | + |
| 173 | +## Linux 系统通知 |
| 174 | + |
| 175 | +需要安装 `libnotify-bin`： |
| 176 | + |
| 177 | +```bash |
| 178 | +sudo apt install libnotify-bin # Debian/Ubuntu |
| 179 | +``` |
| 180 | + |
| 181 | +创建 `~/.deepcode/notify.sh`： |
| 182 | + |
| 183 | +```bash |
| 184 | +#!/bin/bash |
| 185 | +# Linux notify-send 通知 |
| 186 | +notify-send "DeepCode" "任务已${STATUS:-完成}，耗时 ${DURATION}s" |
| 187 | +``` |
| 188 | + |
| 189 | +```json |
| 190 | +{ |
| 191 | + "notify": "/home/you/.deepcode/notify.sh" |
| 192 | +} |
| 193 | +``` |
| 194 | + |
| 195 | +## Windows msg 弹窗通知 |
| 196 | + |
| 197 | +```batch |
| 198 | +@echo off |
| 199 | +REM Windows msg 弹窗通知 |
| 200 | +msg %USERNAME% "DeepCode: task %STATUS% (%DURATION%s)" |
| 201 | +``` |
| 202 | + |
| 203 | +```json |
| 204 | +{ |
| 205 | + "notify": "C:\\Users\\you\\.deepcode\\notify.bat" |
| 206 | +} |
| 207 | +``` |
| 208 | + |
| 209 | +## 自定义通知脚本 |
| 210 | + |
| 211 | +你可以根据通知脚本注入的环境变量自行编写任意逻辑的通知脚本（Python、Node.js、Ruby 等均可），只要脚本可执行即可。脚本中可通过 `env` 字段传入额外需要的配置变量。 |
0 commit comments