Skip to content

boring

Turn any repo into a one-command, isolated dev environment where mixed teams — engineers, marketers, managers — use code as a thinking medium. Wireframes, mockups, prototypes, pitches, with Claude as the collaborator at the keyboard.

These are the docs. If you're here for the pitch — what boring is, why it exists, who it's for — head to Why boring.

Where to start

  • Getting Started

    Install boring, drop a profile into your repo, open the container. The five-minute path from clone to working dev loop.

  • Anatomy of a Profile

    Every field in .boring/profile.yaml with examples. The schema reference.

  • Examples

    Three sample profiles to copy-modify: minimal (Shopify), Django + Postgres, Node + Redis.

  • Architecture Decision Records

    Every material design decision is recorded as an ARD at the time of the decision. Read these to understand the why.

  • Changelog

    What shipped, when, and what it changed.

  • Security

    Responsible disclosure path + the security model summary.

Quick install

curl -fsSL https://raw.githubusercontent.com/steig/boring/main/install.sh | bash
boring doctor

The installer clones the repo to ~/.local/share/boring/ and symlinks boring into ~/.local/bin/. Full requirements + dep table in Getting Started.

Status

v0.6.0-dev. Code surface covers ARD-0008's v0.3 through v0.6 slices end-to-end. v1.0 polish (brew formula, marketing final pass, broader real-world dogfood) is the gap to a tagged release.

This is a one-maintainer project in active dogfood, currently validated against two production repos (a Shopify theme and a Django + React + Postgres app), both private. The thesis — "mixed teams use code as a thinking medium with Claude as the collaborator" — is not yet validated by external users. If you try it and find a sharp edge, open an issue or email tom@steig.io.