Squire Docs

A real-time collaborative document editor for people and their AI agents, built with Yjs, TipTap, and Node.js. Multiple users and agents can edit the same document simultaneously with automatic conflict resolution. MIT licensed (see LICENSE).

Run it yourself

curl -fsSL https://squiredocs.com/install.sh | sh

This creates a squire-docs folder, downloads the release's compose.yml, squire wrapper, and settings file (checked against SHA256SUMS), starts Squire Docs with Postgres and Redis in Docker, waits until everything is healthy, and prints a one-time claim link as its last line. Open the link, click Continue, and you are signed in as the owner. Then connect your agent with claude mcp add --transport http squire-local http://localhost:3910/mcp and click Approve. That is two clicks and no passwords, email, or API keys. Requires Docker with Compose 2.24 or later.

• Agents: follow https://squiredocs.com/self-host.md (this repository's AGENTS.md), which lists every command with its success condition.
• People: see /documentation/self-hosting on any instance.
• ./squire <command> in the install folder runs the in-container CLI, for example ./squire claim-link to sign in again or ./squire doctor.
• The squire-data volume holds the generated secrets, including the key that encrypts stored API keys. docker compose down -v deletes it along with every document; docker compose down is the safe way to stop.

This is the beginning of the README. Read the rest at the original. Read the full README ↗