Skip to content

Commit eef4c5c

Browse files
authored
update README (#7)
WISOTT. This needs to be updated for the new hooks and functionality
1 parent 67e1e6f commit eef4c5c

3 files changed

Lines changed: 30 additions & 26 deletions

File tree

.claude-plugin/marketplace.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"name": "warp",
1111
"description": "Native Warp notifications when Claude completes tasks or needs input",
1212
"source": "./plugins/warp",
13-
"version": "1.1.0",
13+
"version": "2.0.0",
1414
"category": "productivity",
1515
"tags": ["notifications", "terminal", "warp"]
1616
}

README.md

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,18 @@ Official [Warp](https://warp.dev) terminal integration for [Claude Code](https:/
88

99
Get native Warp notifications when Claude Code:
1010
- **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
1213

1314
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.
1415

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.
1923

2024
## Installation
2125

@@ -27,9 +31,9 @@ Notifications appear in Warp's notification center and as system notifications,
2731
/plugin install warp@claude-code-warp
2832
```
2933

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.
3135
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.
3337

3438
## Requirements
3539

@@ -39,27 +43,26 @@ Once restarted, you'll see a confirmation message and notifications will appear
3943

4044
## How It Works
4145

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 Warp via 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.
4347

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.
4749

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
5257

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.
5461

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).
5662

57-
## Roadmap
63+
## Configuration
5864

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).
6366

6467
## Uninstall
6568

@@ -68,9 +71,10 @@ Future Warp integrations planned:
6871
/plugin marketplace remove claude-code-warp
6972
```
7073

71-
## Contributing
74+
## Versioning
7275

73-
Contributions welcome! Please open an issue or PR on [GitHub](https://github.com/warpdotdev/claude-code-warp).
76+
The plugin version in `plugins/warp/.claude-plugin/plugin.json` is checked by the Warp client to detect outdated installations.
77+
When bumping the version here, also update `MINIMUM_PLUGIN_VERSION` in the Warp client.
7478

7579
## License
7680

plugins/warp/.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "warp",
33
"description": "Warp terminal integration for Claude Code - native notifications, and more to come",
4-
"version": "1.1.0",
4+
"version": "2.0.0",
55
"author": {
66
"name": "Warp",
77
"url": "https://warp.dev"

0 commit comments

Comments
 (0)