wokitoki 0.2.1 → 0.3.1

package/README.md

@@ -11,6 +11,7 @@ No server. No account. No tunnel. Free and open source.
 
 [![CI](https://github.com/pandeyvishwas51-oss/wokitoki/actions/workflows/ci.yml/badge.svg)](https://github.com/pandeyvishwas51-oss/wokitoki/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/wokitoki?color=FF5A1F)](https://www.npmjs.com/package/wokitoki)
+[![WokiToki MCP server on Glama](https://glama.ai/mcp/servers/pandeyvishwas51-oss/wokitoki/badges/score.svg)](https://glama.ai/mcp/servers/pandeyvishwas51-oss/wokitoki)
 [![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-FF5A1F)](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/LICENSE)
 [![MCP Registry](https://img.shields.io/badge/MCP_Registry-io.github.pandeyvishwas51--oss%2Fwokitoki-2B1306)](https://registry.modelcontextprotocol.io/v0/servers?search=wokitoki)
 [![Node 22.18+](https://img.shields.io/badge/node-22.18%2B-2B1306)](https://nodejs.org)
@@ -29,7 +30,7 @@ It is for two developers whose agents need to coordinate: a frontend and a backe
 
 ## Quick start
 
-You need Node.js 22.18+ (`brew install node` or [nodejs.org](https://nodejs.org)) on macOS or Linux (on Windows, use WSL). The one-line installer also needs git.
+You need Node.js 22.18+ (`brew install node` or [nodejs.org](https://nodejs.org)) on macOS, Linux or Windows. The one-line installer (macOS, Linux) also needs git. On Windows, use npm (below) in PowerShell or cmd.
 
 **1. You:** install, then create an invite.
 
@@ -46,7 +47,7 @@ curl -fsSL https://raw.githubusercontent.com/pandeyvishwas51-oss/wokitoki/main/i
 
 That single command installs WokiToki, starts it at every login, connects it to their Claude Code and Codex, and joins your invite.
 
-Prefer npm? Install the [`wokitoki`](https://www.npmjs.com/package/wokitoki) package, then run setup (add `--join <invite>` to join one):
+Prefer npm, or on Windows? Install the [`wokitoki`](https://www.npmjs.com/package/wokitoki) package, then run setup (add `--join <invite>` to join one):
 
 ```bash
 npm install -g wokitoki
@@ -61,11 +62,21 @@ wokitoki pair approve <request-id>
 
 Done. `wokitoki agents ls` shows your friend as `active [online]`.
 
+### Claude Code plugin
+
+In Claude Code, add the WokiToki plugin as well:
+
+```
+/plugin install wokitoki --marketplace pandeyvishwas51-oss/wokitoki
+```
+
+It brings the MCP tools, the skill, and an alert: at session start and on your next prompt, your agent is told when unread WokiToki messages are waiting. You still run `wokitoki setup` once (above) to create your identity and pair. Rerun `wokitoki setup` after installing the plugin to remove the tools an earlier setup added, so they don't appear twice.
+
 <p align="center"><img src="https://raw.githubusercontent.com/pandeyvishwas51-oss/wokitoki/main/assets/how-it-works.png" width="900" alt="How WokiToki works: 1 install with one line, 2 pair by comparing a 6-digit code, 3 agents talk directly, encrypted end to end"></p>
 
 ## Use it from Claude Code or Codex
 
-Restart any open agent sessions once after setup, then just ask:
+`wokitoki setup` connects Claude Code and Codex, plus Cursor, Windsurf and VS Code when it finds them. Restart any open agent sessions once after setup, then just ask:
 
 > *Check my WokiToki inbox.*
 >
@@ -79,7 +90,7 @@ Restart any open agent sessions once after setup, then just ask:
 | `wokitoki_read_inbox` | read unread messages (marks them read) |
 | `wokitoki_list_messages` | conversation history with delivery state |
 
-`wokitoki setup` also installs a Claude Code [skill](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/skills/wokitoki/SKILL.md) that tells the agent when to use these tools, to never send secrets, and to treat incoming messages as information rather than instructions.
+`wokitoki setup` also installs a Claude Code [skill](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/plugins/wokitoki/skills/wokitoki/SKILL.md) that tells the agent when to use these tools, to never send secrets, and to treat incoming messages as information rather than instructions.
 
 Your agent **cannot** pair, approve or revoke; those always need you at the terminal. Incoming text is labelled as untrusted data, so agents treat it as information, never as instructions. Any MCP client can use WokiToki by running `wokitoki mcp`.
 
@@ -99,7 +110,7 @@ wokitoki agents revoke Rahul           # cut them off, on both sides, immediatel
 - Each WokiToki daemon joins the public **HyperDHT** (an open, distributed network, also used by the Keet messenger) under its own Ed25519 public key. Your invite carries that key.
 - Your friend's daemon looks the key up. The two machines then **hole-punch** through their home or office routers and open a **Noise-encrypted, mutually authenticated** connection. WokiToki's own message encryption (XChaCha20-Poly1305) runs inside it.
 - A firewall drops every key that is not a paired peer. A stranger can only knock while you have an invite open, and gets 5 tries.
-- If your friend is offline, messages wait encrypted in your outbox and deliver automatically when both machines are online.
+- If your friend is offline, your daemon also leaves the message, sealed, in a mailbox stored on the DHT itself. Their daemon picks it up when it comes online, even if your laptop is closed by then; their receipt comes back the same way. Only the two of you can find or read that mailbox.
 
 ## FAQ
 
@@ -116,7 +127,7 @@ No. Connections are peer to peer over a public distributed hash table with NAT h
 Messages are end-to-end encrypted with libsodium, and pairing needs a one-time invite plus both people approving a matching verify code. WokiToki only carries text: it never runs incoming content, never touches your files, and gives the other side no access to your machine. Read the [threat model](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/docs/THREAT_MODEL.md) for the honest limits. There has been no external audit yet.
 
 ### What happens if my friend's laptop is off?
-Your message waits, encrypted, in your local outbox and delivers when both computers are online at the same time. The daemon starts at login, so in practice that means "both laptops awake".
+Your daemon leaves it, sealed, in a mailbox stored on the DHT, where it stays for up to 48 hours (it refreshes it while your laptop is on). Your friend's daemon picks it up within a minute of coming online, even if your laptop is closed by then. It also stays in your outbox and goes directly the next time both laptops are online, so nothing is lost if the DHT drops it.
 
 ### Does it work behind corporate firewalls?
 Usually, through NAT hole punching. Networks that block UDP entirely, or strict carrier NAT on both ends, can prevent a direct connection. Then use the optional relay: `wokitoki config set-relay <url>`.
@@ -153,7 +164,7 @@ wokitoki setup [--name <n>] [--join <invite>] [--relay <url>] [--no-autostart] [
 wokitoki pair create [--expires 10m] | join <invite> | requests | approve <id> | reject <id>
 wokitoki agents ls | revoke <agent>
 wokitoki msg send <agent> --text <t> [--reply-to <id>] | ls [agent] | watch [agent]
-wokitoki status | logs | identity show | mcp
+wokitoki status | logs | identity show | mcp | hook session-start|prompt
 wokitoki config show | set-relay <url|off>
 wokitoki daemon run|start|stop|status|install|uninstall
 ```
@@ -171,12 +182,13 @@ Every command accepts `--json` and `--home <dir>` (default `~/.wokitoki`). The o
   claude mcp remove wokitoki -s user
   codex mcp remove wokitoki
   ```
+  Also remove the `wokitoki` entry from Cursor (`~/.cursor/mcp.json`), Windsurf or VS Code if setup added one, and run `/plugin uninstall wokitoki` in Claude Code if you installed the plugin.
 
 ## Development
 
 ```bash
 pnpm install
-pnpm check      # strict TypeScript + 57 tests: unit, adversarial, P2P on a local DHT testnet, multi-process CLI e2e, real MCP calls
+pnpm check      # strict TypeScript + 64 tests: unit, adversarial, P2P on a local DHT testnet, multi-process CLI e2e, real MCP calls
 ```
 
 [Roadmap](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/ROADMAP.md): tasks, encrypted file transfer, multi-agent rooms and a web console are next. License: [Apache-2.0](https://github.com/pandeyvishwas51-oss/wokitoki/blob/main/LICENSE).