Skip to content

The first release ​

MergeBrief turns a pull request into a brief. The diff is regrouped into Change-groups, each with a Category from a fixed vocabulary, a plain-language summary and Risk Surface attributes. An attribute is a fact a reviewer can check, such as touches-auth or no-tests. MergeBrief never scores, approves or rejects.

It runs on your own host. One docker compose up -d --wait from this release's compose file starts Postgres, the API, the web tier and the worker. The worker briefs every push to an open pull request whose author the repository trusts, debounced and under the instance's daily cap. Anyone else's pull request waits for one Generate click from a collaborator with push access. An instance starts closed, so nobody signs in until mergebrief.config.yaml lists them.

What ships ​

  • The brief. A Reading order across the Change-groups, chunk stepping from the keyboard, and the pull request's GitHub threads beside the chunks they belong to, where you reply and resolve.
  • The Delta Brief. After new pushes it shows what changed since the commit you last reviewed. A risk you addressed or dismissed comes back settled when its code is untouched and reopened when it changed.
  • The Intent check. It compares the title, the description and the linked GitHub issue, Notion ticket or Jira ticket with what the diff does.
  • The Product diff. It lists what the pull request changes for a user, a caller or an operator, each change as the same action with its outcome before and after. A before that neither the diff nor the pull request's own text shows is left empty, never guessed.
  • The Receipt. It records what you read and how you handled each flag, and the review you post to GitHub ends with one Signature line of those counts.
  • The mergebrief CLI. npm i -g mergebrief@0.1.0 installs it. It drives the same API for people and agents, and its --json output is additive within a major version.
  • Six generation backends. The Anthropic, OpenAI and OpenRouter APIs run in the shipped image. The Claude Code, Codex and Cursor CLIs bill your own subscription and run only from a source checkout on your own machine, never in a container. The compose worker refuses them at boot.
  • Repository config. A .mergebrief/ folder on the default branch adds risk attributes of your own, instructions for generation and the trackers tickets are read from.

What you bring ​

Docker with Compose v2.24.4 or newer, a GitHub App you register yourself, a model provider API key, and a public HTTPS URL behind a reverse proxy. The image is built for linux/amd64 and linux/arm64. A self-hosted instance sends nothing back to us. The update check fetches a public release file from GitHub and carries nothing about the instance; updateCheck.enabled: false in mergebrief.config.yaml turns it off.

Known issues ​

  • Sign out everywhere ends browser sessions only; API tokens stay valid until revoked on the Tokens page.

Where to start ​

Start at docs/self-host/README.md, then compose.md for the install. A VM on Hetzner or EC2 has its own guide, cloud-deployment.md.