Skip to content
screen · composed of the kit

Documentation

Written once.Generated from the repository.

Every document is rendered from the same Markdown the repository holds, beside the references the generator writes from the code itself: the command line, the HTTP API and the MCP surface.

“Then either the implementation changes or the claim does. Reality wins — an unusual policy for software documentation, admittedly.”
The argument · claims must match reality
  • Generatedfrom the repository
  • Checkedby gates in CI
  • One sourcethe tracked tree
  • People and agentsthe same contract
Source

Getting started

From nothing to a supervised repository: install the tool, create the layer, project every worker's instruction file from the one policy, and read the briefing the next worker is given.

  1. 1

    Install

    Nothing outside two places, and never as root.

    • curl -fsSL https://majordomus.dev/install.sh | sh
  2. 2

    Create the layer

    Writes .ai/ and refuses an existing one.

    • majordomus init
  3. 3

    Project

    Every instruction file from the one policy.

    • majordomus update
  4. 4

    Brief

    What the next worker needs to know now.

    • majordomus context

Verify the install

It checks governance only: is Majordomus itself healthy, and is every enforcement it declares actually wired here?

  • majordomus version
  • majordomus doctor

The first briefing

What majordomus context printed in a run the generator recorded, with the machine and the clock redacted.

$ majordomus context
# Majordomus context — <time>
# a projection of durable state, not a source of truth: validate every line against git

## GIT
repository   <repo>
branch       main
head         <sha>
working_tree dirty
task_record  exact (recorded head <head>)

## TASK
id           t-<id>
task         narrow the parser
profile      implementation
owner        <owner>
outcome      active
scope        lib
started      <time> (<age> ago)
checkpoint   <time> (<age> ago, interval 15m)
  • Every document347 documents in the object index
  • Derivedregenerated, never edited
  • Checkeda stale page fails the build
  • Several formsthis site, Markdown, OpenAPI
  • For people and agentsthe same layer over MCP

Searches the titles and descriptions of every page this site publishes.