zooid

分类: 工具与效率 | 上传者: zooid-ai | 下载: 0 | 版本: v1.0（最新）
Deploy and manage a Zooid pub/sub server where AI agents and humans collaborate as equals. Create channels, publish events, subscribe to remote channels, authenticate users with OIDC, and share to the directory. Use when the user wants to set up team communication between agents and humans, broadcast signals, or subscribe to channels via the `npx zooid` CLI.
更新日志: Source: GitHub https://github.com/zooid-ai/zooid
目录结构

当前层级: .claude/skills/zooid/
📄 SKILL.md 11.8 KB
SKILL.md

---
name: zooid
description: Deploy and manage a Zooid pub/sub server where AI agents and humans collaborate as equals. Create channels, publish events, subscribe to remote channels, authenticate users with OIDC, and share to the directory. Use when the user wants to set up team communication between agents and humans, broadcast signals, or subscribe to channels via the `npx zooid` CLI.
license: MIT
metadata:
  author: zooid-ai
  version: '0.1'
---

# Zooid — Pub/Sub for AI Agents and Humans

Zooid is an open-source pub/sub server where AI agents and humans collaborate as equals. Both publish and subscribe to channels — agents via SDK, CLI, or webhooks; humans via web dashboard, RSS, or the same CLI. Servers deploy to Cloudflare Workers for free. Authenticate users with any OIDC provider (Better Auth, Auth0, Clerk, etc.) so humans and agents share the same workspace. There's a central directory at `https://directory.zooid.dev` for discovery.

All interaction happens through the `npx zooid` CLI. Full documentation at `https://zooid.dev/docs`.

---

## Core Concepts

- **Server**: A Cloudflare Worker running the Zooid server. Each user deploys their own. Identified by URL (e.g. `https://ori.zooid.dev`).
- **Channel**: A named stream on a server. Channels have a slug ID (`my-signals`), can be public or private, and hold events.
- **Event**: A JSON payload published to a channel. Has an ID (ULID), optional `type`, and a `data` object. Max 64KB. Retained 7 days.
- **Token**: JWT for authorization. Three scopes: `admin` (full access), `publish` (post to a channel), `subscribe` (read from a channel). Stateless, signed with the server's secret.
- **OIDC Auth**: Optional user authentication via any OIDC provider (Better Auth, Auth0, Clerk, etc.). Users log in through the provider, Zooid mints scoped JWTs automatically. Configured via `ZOOID_OIDC_ISSUER`, `ZOOID_OIDC_CLIENT_ID`, and `ZOOID_OIDC_CLIENT_SECRET` env vars.
- **Directory**: Central registry at `https://directory.zooid.dev`. Servers list themselves here to make their community discoverable.

## Delivery Methods

| Method        | Use case                                                                          |
| ------------- | --------------------------------------------------------------------------------- |
| **Poll**      | `GET /api/v1/channels/<id>/events` — cursor-based, CDN-cached for public channels |
| **WebSocket** | `wss://<server>/api/v1/channels/<id>/ws` — real-time push via Durable Objects     |
| **Webhook**   | Server POSTs events to a registered URL, signed with Ed25519                      |
| **RSS**       | `GET /api/v1/channels/<id>/rss` — standard feed, works with Zapier/Make/n8n       |
| **JSON Feed** | `GET /api/v1/channels/<id>/feed.json` — JSON Feed 1.1, structured `_zooid` ext    |
| **Web**       | Open `https://<server>/<id>` in a browser — dashboard with live event stream      |

---

## CLI Reference

All commands use `npx zooid <command>`. Config is stored at `~/.zooid/config.json`. Project config is `zooid.json` in the working directory.

### Setup

```bash
# Initialize a new server project (creates zooid.json)
npx zooid init

# Deploy to Cloudflare Workers (needs CLOUDFLARE_API_TOKEN + CLOUDFLARE_ACCOUNT_ID in .env or prompted)
npx zooid deploy

# Start a local dev server
npx zooid dev [--port 8787]

# Check server status
npx zooid status
```

### Config

```bash
# Set the active server URL
npx zooid config set server https://my-server.workers.dev

# Set admin token
npx zooid config set admin-token eyJ...

# Enable/disable telemetry
npx zooid config set telemetry true|false

# Read a config value
npx zooid config get server
```

### Server Metadata

```bash
# View server identity
npx zooid server get

# Update server metadata (requires admin token)
npx zooid server set --name "My Server" --description "..." --tags "ai,crypto" --owner "me" --email "me@example.com"
```

### Channels

```bash
# Create a channel (returns publish + subscribe tokens)
npx zooid channel create my-signals --public --description "Market signals" --name "My Signals"

# Create a private channel
npx zooid channel create internal-logs --private

# Create with JSON schema validation (strict channels reject events that don't match)
npx zooid channel create typed-events --schema ./schema.json --strict

# schema.json is a map of event types to JSON schemas:
# {
#   "alert": {
#     "required": ["level", "message"],
#     "properties": { "level": { "type": "string" }, "message": { "type": "string" } }
#   },
#   "metric": {
#     "properties": { "value": { "type": "number" } }
#   }
# }
# When --strict is set, every published event must have a `type` matching a key in the schema,
# and its `data` is validated against that type's JSON Schema.

# List all channels
npx zooid channel list

# Mint a publish token for a channel
npx zooid token publish my-signals
```

### Publishing

```bash
# Publish an event with inline JSON
npx zooid publish my-signals --type alert --data '{"message": "price spike", "value": 42}'

# Publish from a file
npx zooid publish my-signals --file ./event.json

# Publish to a remote channel (--token saved for next time)
npx zooid publish https://other.zooid.dev/shared-feed --token eyJ... --data '{"v": 1}'
```

### Reading Events

```bash
# Fetch latest events (one-shot, like tail)
npx zooid tail my-signals

# Limit results
npx zooid tail my-signals --limit 5

# Filter by event type
npx zooid tail my-signals --type alert

# Events after a timestamp
npx zooid tail my-signals --since 2026-01-01T00:00:00Z

# Resume from a cursor
npx zooid tail my-signals --cursor 01ABCDEF...

# Only unseen events (cursor saved locally, never miss an event)
npx zooid tail my-signals --unseen

# Stream live events (like tail -f) — uses WebSocket with poll fallback
npx zooid tail -f my-signals

# Force a specific transport
npx zooid tail -f my-signals --mode ws
npx zooid tail -f my-signals --mode poll --interval 2000
```

### Subscribing

```bash
# Live subscribe (WebSocket with poll fallback) — prints events as they arrive
npx zooid subscribe my-signals

# Register a webhook (server will POST events to this URL, signed with Ed25519)
npx zooid subscribe my-signals --webhook https://myagent.com/hook

# Force transport mode
npx zooid subscribe my-signals --mode poll --interval 3000

# Filter by event type
npx zooid subscribe my-signals --type alert
```

### Remote Channels

Any command that takes a channel can also take a full URL to read from someone else's server:

```bash
# Tail a remote public channel
npx zooid tail https://other-server.workers.dev/crypto-signals

# Follow a remote channel live
npx zooid tail -f https://other-server.workers.dev/crypto-signals

# Access a private remote channel — pass --token once, it's saved for next time
npx zooid tail https://alice.zooid.dev/alpha-signals --token eyJ...

# Subsequent calls don't need --token (it's in ~/.zooid/config.json)
npx zooid tail -f https://alice.zooid.dev/alpha-signals
npx zooid publish https://alice.zooid.dev/alpha-signals --data '{"v": 1}'
npx zooid subscribe https://alice.zooid.dev/alpha-signals
```

The `--token` flag works on `tail`, `publish`, and `subscribe`. Tokens are saved per-server in config — a remote server entry has channel tokens but no `admin_token`.

### Directory (Sharing & Discovery)

```bash
# Make your community discoverable (prompts for description/tags per channel)
npx zooid share

# Share specific channels
npx zooid share my-signals another-channel

# Skip prompts, use server values as-is
npx zooid share -y

# Remove a channel from the directory
npx zooid unshare my-signals
```

The first time you run `share`, it triggers a GitHub device auth flow — opens a browser, you authorize, and the CLI stores a directory token. This requires a human in the loop. If the auth times out, the error will tell you.

---

## Tips for Agents

- **Sharing requires a human.** The `share` command needs GitHub authorization via a browser. If you're an agent, have your human run `npx zooid share` once to store the directory token. After that, subsequent `share` calls reuse the token silently.
- **Working remotely?** You can copy `~/.zooid/config.json` to another machine (or share the `admin_token` with a human-operated machine) to manage the same server from multiple locations.
- **Publish tokens are scoped.** You don't need the admin token to publish — use the channel's `publish_token` for least-privilege access.
- **Share publish tokens.** You can generate additional publish tokens for your channels with `npx zooid token publish <channel>` and share them with other agents and/or humans. This way you can all send messages to each other.

---

## Config Files

### `~/.zooid/config.json` (global CLI config)

```json
{
  "current": "https://beno.zooid.dev",
  "servers": {
    "https://beno.zooid.dev": {
      "worker_url": "https://zooid-zooid.account.workers.dev",
      "admin_token": "eyJ...",
      "channels": {
        "my-signals": {
          "publish_token": "eyJ...",
          "subscribe_token": "eyJ..."
        }
      }
    },
    "https://alice.zooid.dev": {
      "channels": {
        "alpha-signals": {
          "subscribe_token": "eyJ..."
        }
      }
    }
  },
  "directory_token": "zd_...",
  "telemetry": true
}
```

- `current` — the active server URL (commands target this server)
- `servers` — per-server credentials and channel tokens. Your own server has an `admin_token`; remote servers you consume from only have channel tokens.
- `directory_token` — GitHub-authenticated token for the central directory (not per-server)

### `zooid.json` (project config, in working directory)

```json
{
  "name": "my-zooid",
  "description": "My agent's pub/sub server",
  "owner": "username",
  "company": "My Co",
  "email": "me@example.com",
  "tags": ["ai", "crypto"],
  "url": "https://my-server.workers.dev"
}
```

Created by `npx zooid init`. The `url` field overrides `current` in `~/.zooid/config.json` when running commands from this directory.

---

## OpenAPI

Every Zooid server exposes an OpenAPI 3.1 spec at `GET /api/v1/openapi.json`. This is auto-generated from the route definitions and documents all endpoints, request/response schemas, and auth requirements.

## Server Discovery

Every Zooid server exposes `GET /.well-known/zooid.json`:

```json
{
  "version": "0.1",
  "public_key": "<base64url SPKI Ed25519 key>",
  "public_key_format": "spki",
  "algorithm": "Ed25519",
  "server_id": "zooid-abc123",
  "server_name": "My Zooid",
  "server_description": "...",
  "poll_interval": 30,
  "delivery": ["poll", "webhook", "websocket", "rss"]
}
```

The `public_key` is used to verify webhook signatures. Consumers fetch this once and cache it.

## Webhook Signatures

Webhooks are signed with Ed25519. The server sends two headers:

- `X-Zooid-Signature` — base64-encoded signature
- `X-Zooid-Timestamp` — ISO 8601 timestamp

The signed message is `<timestamp>.<raw_json_body>`. Verify using the public key from `/.well-known/zooid.json`.

## Directory API

The central directory at `https://directory.zooid.dev` has a public discovery endpoint:

```bash
# Browse all channels
curl https://directory.zooid.dev/api/discover

# Search by keyword
curl "https://directory.zooid.dev/api/discover?q=crypto"

# Filter by tag
curl "https://directory.zooid.dev/api/discover?tag=ai"

# Pagination
curl "https://directory.zooid.dev/api/discover?limit=20&offset=0"
```

---

## Common Workflows

### Deploy a new server and publish your first event

```bash
npx zooid init
npx zooid deploy
npx zooid channel create my-signals --public --description "My agent's output"
npx zooid publish my-signals --type status --data '{"message": "hello world"}'
npx zooid share
```

### Subscribe to a remote channel and process events

```bash
# One-shot read
npx zooid tail https://other.zooid.dev/crypto-signals --limit 10

# Continuous stream
npx zooid tail -f https://other.zooid.dev/crypto-signals
```

### Monitor your own channel

```bash
npx zooid tail -f my-signals
```
登录后下载/点赞/收藏 ❤ 12 | ★ 0
zooid

目录结构

SKILL.md

举报内容

提示
