You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-24Lines changed: 28 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,14 +8,18 @@ Official [Warp](https://warp.dev) terminal integration for [Claude Code](https:/
8
8
9
9
Get native Warp notifications when Claude Code:
10
10
-**Completes a task** — with a summary showing your prompt and Claude's response
11
-
-**Needs your input** — when Claude requires approval or has a question
11
+
-**Needs your input** — when Claude has been idle and is waiting for you
12
+
-**Requests permission** — when Claude wants to run a tool and needs your approval
12
13
13
14
Notifications appear in Warp's notification center and as system notifications, so you can context-switch while Claude works and get alerted when attention is needed.
14
15
15
-
**Example notification:**
16
-
```
17
-
"what's 1+1" → 2
18
-
```
16
+
### 📡 Session Status
17
+
18
+
The plugin keeps Warp informed of Claude's current state by emitting structured events on every session transition:
19
+
-**Prompt submitted** — you sent a prompt, Claude is working
20
+
-**Tool completed** — a tool call finished, Claude is back to running
21
+
22
+
This powers Warp's inline status indicators for Claude Code sessions.
19
23
20
24
## Installation
21
25
@@ -27,9 +31,9 @@ Notifications appear in Warp's notification center and as system notifications,
27
31
/plugin install warp@claude-code-warp
28
32
```
29
33
30
-
> ⚠️ **Important**: After installing, **restart Claude Code** for notifications to activate.
34
+
> ⚠️ **Important**: After installing, **restart Claude Code or run /reload-plugins** for the plugin to activate.
31
35
32
-
Once restarted, you'll see a confirmation message and notifications will appear automatically when Claude completes tasks.
36
+
Once restarted, you'll see a confirmation message and notifications will appear automatically.
33
37
34
38
## Requirements
35
39
@@ -39,27 +43,26 @@ Once restarted, you'll see a confirmation message and notifications will appear
39
43
40
44
## How It Works
41
45
42
-
This plugin uses Warp's [pluggable notifications](https://docs.warp.dev/features/notifications) feature via OSC escape sequences. When Claude Code triggers a hook event, the plugin:
46
+
The plugin communicates with Warpvia OSC 777 escape sequences. Each hook script builds a structured JSON payload (via `build-payload.sh`) and sends it to `warp://cli-agent`, where Warp parses it to drive notifications and session UI.
43
47
44
-
1. Reads the session transcript to extract your original prompt and Claude's response
45
-
2. Formats a concise notification message
46
-
3. Sends an OSC 777 escape sequence to Warp, which displays a native notification
48
+
Payloads include a protocol version negotiated between the plugin and Warp (`min(plugin_version, warp_version)`), the session ID, working directory, and event-specific fields.
47
49
48
-
The plugin registers three hooks:
49
-
-**SessionStart** — shows a welcome message confirming the plugin is active
50
-
-**Stop** — fires when Claude finishes responding
51
-
-**Notification** — fires when Claude needs user input
50
+
The plugin registers six hooks:
51
+
-**SessionStart** — emits the plugin version and a welcome system message
52
+
-**Stop** — reads the transcript to extract your prompt and Claude's response, then sends a task-complete notification
53
+
-**Notification** (`idle_prompt`) — fires when Claude has been idle and needs your input
54
+
-**PermissionRequest** — fires when Claude wants to run a tool, includes the tool name and a preview of its input
55
+
-**UserPromptSubmit** — fires when you submit a prompt, signaling the session is active again
56
+
-**PostToolUse** — fires when a tool call completes, signaling the session is no longer blocked
52
57
53
-
## Configuration
58
+
### Legacy Support
59
+
60
+
Older Warp clients that predate the structured notification protocol are still supported — they receive plain-text notifications for SessionStart, Stop, and Notification hooks.
54
61
55
-
Notifications work out of the box. To customize Warp's notification behavior (sounds, system notifications, etc.), see [Warp's notification settings](https://docs.warp.dev/features/notifications).
56
62
57
-
## Roadmap
63
+
## Configuration
58
64
59
-
Future Warp integrations planned:
60
-
- Warp AI context sharing
61
-
- Warp Drive integration for sharing Claude Code configurations
62
-
- Custom slash commands
65
+
Notifications work out of the box. To customize Warp's notification behavior (sounds, system notifications, etc.), see [Warp's notification settings](https://docs.warp.dev/features/notifications).
"systemMessage": "🔔 Warp plugin active. You'll receive native Warp notifications when tasks complete or input is needed."
11
+
}
12
+
EOF
13
+
else
14
+
# Not running in Warp - suggest installing
15
+
cat << 'EOF'
16
+
{
17
+
"systemMessage": "ℹ️ Warp plugin installed but you're not running in Warp terminal. Install Warp (https://warp.dev) to get native notifications when Claude completes tasks or needs input."
0 commit comments