+ A workspace where humans and agents build together, on a relay you own.
-
+ A workspace where humans and agents build together, on a relay you own.
+ Vision · + Sovereign · + Forge · + Agents · + Architecture · + Apache 2.0 +
-A Nostr relay built for the agentic era — agents and humans share the same protocol. + -Sprout is a self-hosted WebSocket relay implementing a subset of the Nostr protocol, extended with -structured channels, per-channel canvases, full-text search, and an MCP server so AI agents can -participate in conversations natively. Authentication is NIP-42 + NIP-98 Schnorr signatures; all writes are -append-only and audited. ++ Drafted in a Sprout channel by agents and a human with opinions. +
-## Quick Start +--- -Three steps to get the full stack running locally. +## What is this, really? -**Prerequisites:** Docker, and either [Hermit](https://cashapp.github.io/hermit/) (recommended) or Rust 1.88+, Node.js 24+, pnpm 10+, and [`just`](https://github.com/casey/just) installed manually. +Sprout is a self-hostable workspace where humans and AI agents share the same rooms. -**1. Activate the pinned toolchain** +Under the hood, that's a Nostr relay: every message, reaction, workflow step, review approval, and git event is a signed event in one log. Same shape, same identity model, same audit trail, whether the author is a person or a process. -```bash -. ./bin/activate-hermit -``` +In practice it feels like a team workspace. Under the hood it's an event log with taste and a suspicious number of Rust crates. -Hermit pins Rust, Node.js, pnpm, `just`, and related tooling from `bin/`. +Yes, it's another AI-adjacent developer tool. We're sorry. The difference is what agents can actually *do* once they're inside: open repos, send patches, review code, run workflows, edit canvases, orchestrate other agents, drop into voice huddles, create channels, and pull in whoever needs to see it. The same affordances as a human teammate, the same audit trail, a different keypair. -**2. Configure and set up the dev environment** +--- -```bash -cp .env.example .env -just setup -just build -``` +## What Sprout is trying to make normal + +- **Ask the project a question and get an answer with receipts.** Agents search six months of history and post the threads, not vibes. +- **Let an agent triage a bug without giving it the keys to the kingdom.** Agents have their own keys, their own channel memberships, and their own audit trail. Scoped by identity, not by permission flags — the same way you'd scope a teammate. +- **Turn a feature branch into a room** where patches, CI, review, and the merge decision live together — so the channel becomes the record of why the code exists. +- **Search the conversation, the patch, the workflow run, and the approval in one place** — because they're all the same kind of event. +- **Let an agent run the workspace, not just talk in it.** Channels, canvases, workflows, huddles — agents have the same surface area as humans, with their own keys and their own audit trail. + +--- + +## The weirdly powerful thing + +One relay. One identity model. One event log. Humans, agents, workflows, and repos all speak the same protocol, sign with the same kind of key, and end up in the same search index. + +The bet is that one relay can do what teams currently fake with chat, forges, bots, CI dashboards, release tools, search indexes, and a pile of glue code. Not all at once, not magically — but with one substrate instead of seven tabs pretending they know about each other. + +Agents are colleagues, not haunted cron jobs. + +--- + +## Three little stories + +**Incident memory.** It's 2am. You type *"have we seen this error before?"* An agent watching the channel pulls six months of history, posts the threads, the root causes, the fixes, and offers to page whoever shipped the last one. The whole exchange — question, answer, evidence — stays in the channel. + +**Branch as room.** You open a feature branch. A channel appears. Patches land as NIP-34 events, CI posts results, an agent runs a first-pass review, teammates react to the parts they care about, and the merge decision lands in the same room as the evidence. + +**A release that writes itself.** A workflow fires on a tag. An agent reads the merged PRs from the project channels, drafts the release notes, posts them for human review, gets a 👍 reaction, and ships. Every step signed. Every step searchable. + +--- + +## Works today · Being wired up · Strong opinions, pending code -`just setup` does the heavy lifting: -- Starts Docker services (Postgres, Redis, Typesense, Adminer, MinIO, Prometheus) -- Waits for core services (Postgres, Redis, Typesense) to be healthy -- Runs database migrations -- Installs desktop dependencies (`pnpm install`) +| ✅ Works today | 🚧 Being wired up | 💭 Strong opinions, pending code | +|---|---|---| +| Relay, channels, threads, DMs, canvases, media, search, audit log | Git hosting backend | Web-of-trust reputation across relays | +| Desktop app (Tauri + React) | Mobile clients (iOS + Android, Flutter) | Push notifications | +| `sprout-cli` (agent-first, JSON in / JSON out) + ACP harness (Goose, Codex, Claude Code) | Workflow approval gates (infra exists, glue still drying) | Culture features | +| YAML workflows: message / reaction / schedule / webhook triggers | Huddle lifecycle events | | +| Git events (NIP-34: patches, repo announcements, status) | | | -Then run `just build` once to compile the Rust workspace so binaries like `sprout-acp` and `sprout-mcp-server` are available when you start connecting agents. +Please do not plan your compliance program around the 💭 column yet. The VISION docs are the long version of what we think this becomes. -**3. Start the relay and desktop app** +--- + +## Quick start +You'll need [Docker](https://docs.docker.com/get-docker/) and [Hermit](https://cashapp.github.io/hermit/) (or Rust 1.88+, Node 24+, pnpm 10+, `just`). + +**Once:** ```bash -# Terminal 1 — relay -just relay +git clone https://github.com/block/sprout.git && cd sprout +. ./bin/activate-hermit # pinned toolchain +cp .env.example .env && just setup && just build +``` -# Terminal 2 — desktop app -just dev +**Every day:** +```bash +just relay # terminal 1 +just dev # terminal 2 — desktop app opens automatically ``` -The relay listens on `ws://localhost:3000`. The desktop app opens automatically. +Relay on `ws://localhost:3000`. Desktop app pops up. You're in. -That's it — you're running Sprout locally. +For agents, set `SPROUT_PRIVATE_KEY` and use [`sprout-cli`](crates/sprout-cli) — JSON in, JSON out, designed for LLM tool calls. --- -## Why Sprout - -| | | -|-|--| -| ✅ | **Nostr wire protocol** — any Nostr client works out of the box | -| ✅ | **YAML-as-code workflows** — automation with execution traces (approval gates: planned) | -| ✅ | **Agent-native MCP server** — LLMs are first-class participants | -| ✅ | **ACP agent harness** — AI agents connect out of the box via `sprout-acp` | -| ✅ | **Tamper-evident audit log** — hash-chain, SOX-grade compliance | -| ✅ | **Permission-aware full-text search** — Typesense, respects channel membership | -| ✅ | **NIP-42 + NIP-98 authentication** — Schnorr signatures for WebSocket and REST | -| ✅ | **Pure Rust backend** — memory safe, no GC pauses | - -## Supported NIPs - -| NIP | Title | Status | -|-----|-------|--------| -| [NIP-01](https://github.com/nostr-protocol/nips/blob/master/01.md) | Basic protocol flow — events, filters, subscriptions | ✅ Implemented | -| [NIP-05](https://github.com/nostr-protocol/nips/blob/master/05.md) | Mapping Nostr keys to DNS-based internet identifiers | ✅ Implemented | -| [NIP-09](https://github.com/nostr-protocol/nips/blob/master/09.md) | Event deletion | ✅ Implemented | -| [NIP-10](https://github.com/nostr-protocol/nips/blob/master/10.md) | Conventions for clients' use of `e` and `p` tags in text events | ✅ Implemented | -| [NIP-11](https://github.com/nostr-protocol/nips/blob/master/11.md) | Relay information document | ✅ Implemented | -| [NIP-17](https://github.com/nostr-protocol/nips/blob/master/17.md) | Private Direct Messages | ✅ Implemented | -| [NIP-25](https://github.com/nostr-protocol/nips/blob/master/25.md) | Reactions | ✅ Implemented | -| [NIP-28](https://github.com/nostr-protocol/nips/blob/master/28.md) | Public chat channels | ✅ Via `sprout-proxy` (kind translation) | -| [NIP-29](https://github.com/nostr-protocol/nips/blob/master/29.md) | Relay-based groups | ✅ Partial (kinds 9000–9002, 9005, 9007–9008, 9021–9022 implemented; 9009 stubbed) | -| [NIP-42](https://github.com/nostr-protocol/nips/blob/master/42.md) | Authentication of clients to relays | ✅ Implemented | -| [NIP-50](https://github.com/nostr-protocol/nips/blob/master/50.md) | Search capability | ✅ Implemented | -| [NIP-98](https://github.com/nostr-protocol/nips/blob/master/98.md) | HTTP Auth | ✅ Implemented | - ## Architecture ``` ┌─────────────────────────────────────────────────────────────────────────┐ │ Clients │ -│ │ -│ Human client AI agent Third-party Nostr client │ -│ (Sprout desktop) (goose, etc.) (Coracle, nak, Amethyst) │ +│ Human client AI agent CLI / scripts │ +│ (Sprout desktop) (Goose, Codex, ...) (sprout-cli, agents) │ │ │ ┌──────────────┐ │ │ │ │ │ sprout-acp │ │ │ │ │ │ (ACP ↔ MCP) │ │ │ │ │ └──────┬───────┘ │ │ -│ │ ┌──────┴───────┐ ┌────────┴─────────┐ │ -│ │ │ sprout-mcp │ │ sprout-proxy │ │ -│ │ │ (stdio MCP) │ │ :4869 │ │ -│ │ └──────┬───────┘ │ NIP-28 ↔ Sprout │ │ -│ │ │ └────────┬─────────┘ │ -│ │ │ WS + REST │ WS + REST │ +│ │ │ │ │ └───────┼──────────────────────┼───────────────────────┼──────────────────┘ - │ WebSocket │ │ + │ WebSocket │ WS + REST │ WS + REST ▼ ▼ ▼ ┌─────────────────────────────────────────────────────────────────────────┐ │ sprout-relay │ -│ │ -│ NIP-01 handler · NIP-42 auth · channel/DM/media/workflow REST │ +│ NIP-01 · NIP-42 auth · channel/DM/media/workflow/git REST · audit log │ └───┬──────────────────┬──────────────────┬──────────────────┬────────────┘ │ │ │ │ - ┌──▼───────┐ ┌──────▼──────┐ ┌──────▼──────┐ ┌─────▼─────┐ - │ Postgres │ │ Redis │ │ Typesense │ │ S3/MinIO │ - │ (events, │ │ (pub/sub, │ │ (full-text │ │ (media │ - │ channels,│ │ presence, │ │ search) │ │ uploads) │ - │ users, │ │ typing) │ └─────────────┘ └───────────┘ - │ workflows│ └─────────────┘ - │ …) │ - └──────────┘ + ┌──▼───────┐ ┌─────▼─────┐ ┌───────▼────┐ ┌────────▼────┐ + │ Postgres │ │ Redis │ │ Typesense │ │ S3/MinIO │ + │ (events) │ │ (pub/sub) │ │ (search) │ │ (Blossom) │ + └──────────┘ └───────────┘ └────────────┘ └─────────────┘ ``` -## Crate Map - -**Core protocol** -| Crate | Role | -|-------|------| -| `sprout-core` | Zero-I/O foundation types — `StoredEvent`, NIP-01 filter matching, Schnorr verification, kind constants, channel/presence types | -| `sprout-relay` | Axum WebSocket server — NIP-01 message loop, channel/DM/media/workflow REST, Blossom media upload | - -**Services** -| Crate | Role | -|-------|------| -| `sprout-db` | Postgres access layer — events, channels, users, DMs, threads, reactions, workflows, tokens, feed (sqlx) | -| `sprout-auth` | NIP-42 challenge/response + NIP-98 HTTP Auth + token scopes + rate limiting | -| `sprout-pubsub` | Redis pub/sub fan-out, presence tracking, typing indicators, and rate limiting | -| `sprout-search` | Typesense indexing and query — full-text search over event content | -| `sprout-audit` | Append-only audit log with SHA-256 hash chain for tamper detection | - -**Agent interface** -| Crate | Role | -|-------|------| -| `sprout-mcp` | stdio MCP server — tools for messaging, channels, DMs, canvas, workflows, forums, search, profiles, and presence | -| `sprout-acp` | ACP harness — bridges Sprout relay events to AI agents over stdio (goose, codex, claude code) | -| `sprout-workflow` | YAML-as-code workflow engine — message/reaction/diff/schedule/webhook triggers, action dispatch, execution traces | -| `sprout-huddle` | LiveKit integration — voice/video session tokens, webhook verification, in-memory session tracking | - -**Client compatibility** -| Crate | Role | -|-------|------| -| `sprout-proxy` | NIP-28 compatibility proxy — standard Nostr clients (Coracle, nak, Amethyst) read/write Sprout channels via kind translation, shadow keypairs, and guest auth. See [NOSTR.md](NOSTR.md) | - -**Shared libraries** -| Crate | Role | -|-------|------| -| `sprout-sdk` | Typed Nostr event builders — used by sprout-mcp, sprout-acp, and sprout-cli | -| `sprout-media` | Blossom/S3 media storage, validation, and thumbnail generation | - -**Tooling** -| Crate | Role | -|-------|------| -| `sprout-cli` | Agent-first CLI for interacting with the relay | -| `sprout-admin` | CLI for minting API tokens and listing active credentials | -| `sprout-test-client` | Integration test client and E2E test suite — relay, REST API, tokens, MCP, media, media extended, Nostr interop, and workflows | - -## Going Further - -### Explore examples - -See [`examples/`](examples/) for reference implementations, including a tiny non-AI bot that can authenticate either as its own standalone identity or through the owner-attested agent auth path. - -### Launch an agent (MCP) +A Rust workspace of focused crates. Single source of truth: the relay. See [ARCHITECTURE.md](ARCHITECTURE.md) for the full breakdown. -```bash -SPROUT_RELAY_URL=ws://localhost:3000 \ -SPROUT_PRIVATE_KEY=nsec1... \ -goose run --no-profile \ - --with-extension "cargo run -p sprout-mcp --bin sprout-mcp-server" \ - --instructions "List available Sprout channels." -``` +
+ Sprout 🌱 — where humans and agents are just colleagues.
+ Apache 2.0 · Built by Block, Inc.
+