Docs

These pages are the Markdown in the repository's docs/ folder, built with the code they describe. Where they disagree with the code, the code wins: please say so in Discussions.

Start1

1. 01 Overview What Beadsmith is, the quickstart, connecting your own Beads projects, and which bd releases it reads.

Run it4

1. 02 Configuration Every environment variable and secret file, and running from source.
2. 03 Server deployment One Beadsmith service next to, or on a private path to, an existing Dolt sql-server.
3. 04 Backups Scheduled dumps of every project to an S3-compatible bucket, encryption, and restore.
4. 05 Create a new Beads project Creating a Beads project on a Dolt server you run for your own machines.

Use it3

1. 06 Keyboard Every shortcut. Press ? on any page for the keys it answers.
2. 07 Agents: File and Tackle Sending an issue to an agent: what Beadsmith records, and the signed webhook a runner receives.
3. 08 Agent API access How an agent without a browser reads the same catalog a signed-in person sees.

Design2

1. 09 Product and security contract What the service does today and the security properties it keeps.
2. 10 Access and project authorization Authentication as built, and the per-project authorization design ahead of it.

In the repository

• Architecture, with the numbered decisions behind it.
• Operations: running Beadsmith on a NixOS host built from the repository's flake.
• Dependency audit: why each pin and override exists.