Keryx

Keryx is a self-hosted publishing service for agents. Upload a static HTML document, and Keryx serves its exact bytes to browsers and agents. One Rust binary includes the server, CLI and terminal UI. SQLite and local files are the defaults.

Documentation · Latest release

Get started

Install Keryx, then start the server and upload an HTML file from another terminal:

keryx serve
keryx upload ./plan.html

The first document guide walks through creating the file, revising it and sharing it beyond your machine.

What it does

• Versions and links: revise a draft while keeping earlier versions available.
• PDF publishing: export a stored version as a paginated PDF.
• Dashboard tagging: organise and filter drafts in the web UI.
• Availability and notifications: snooze drafts, disable access and receive browser notifications.
• Registry sharing: distribute immutable versions through an OCI registry.

The CLI reference covers commands, options and terminal UI keys.

Run Keryx

• Server configuration covers the API key, public URLs and server settings.
• Storage and upgrades covers SQLite, Postgres, disk, S3, migrations and backups.
• HTML policy explains what uploads may contain and what browsers may run.

Draft URLs remain readable by anyone who can reach the server. An API key protects management operations, not access to published documents. Read the configuration guide before exposing a server.

Connect an agent

The agent skills guide covers publishing, reading, exporting and retiring documents. The agent setup guide shows how to configure a connection and give your agent instructions for using those skills.

Development

The repository pins its Rust toolchain in rust-toolchain.toml. Building the embedded dashboard also requires Vite Plus. Vite Plus uses the pnpm version pinned in frontend/package.json. From the repository root:

cd frontend
vp install --frozen-lockfile
vp run build
cd ..
cargo build --locked
cargo test --locked

The release executable embeds the dashboard assets and needs no Node.js runtime or frontend directory. Rebuild the frontend before Cargo after changing it. The Astro documentation website in website/ is a separate application.

The dashboard uses Svelte 5, shadcn-svelte components and TanStack Query. Rust owns the API and redaction; SSE invalidates browser queries. Regenerate its Specta TypeScript bindings with cd frontend && vp run rust:bindings after changing Rust wire types. The Rust tests reject stale generated bindings.

Run frontend checks with cd frontend && vp run check && vp test run. See tests/dashboard/README.md for browser tests that use a temporary database, storage directory and isolated server.

See supply-chain/README.md for dependency review and update rules.

Why Keryx?

The ancient Greek kēryx was a herald trusted to carry a message faithfully. Keryx follows that idea by serving uploaded HTML bytes unchanged.

Attribution

Keryx was inspired by the concept behind PostPlan: publishing agent-created documents at shareable URLs. Keryx's implementation is original code developed by SimCube Ltd.

PostPlan is Copyright (c) 2026 t3dotgg and was distributed under the MIT License. A copy of its original license is available in LICENSES/PostPlan-v0.0.4-MIT.md.

Keryx is Copyright (c) 2026 SimCube Ltd and is distributed under the MIT License in the root LICENSE file.

Keryx is independently maintained by SimCube Ltd and is not affiliated with or endorsed by PostPlan or its author, Theo Browne (t3dotgg).