Skip to content

Documentation

Briar — the operator's manual.

Briar is a free command-line tool that turns project-board tickets into reviewable pull requests, running entirely on your own machine. This is the complete reference: every command, every flag, every supported integration. New to Briar? Start with Core concepts for a five-minute overview before diving into the CLI reference.

Quickstart

Three commands get you from a fresh repo to an open PR. Each one is documented in depth on its own page — these are the shortest path.

1. Install

$ pip install briar-cli
$ briar version

2. Authenticate the providers you'll use

$ briar auth login github-pat --company acme
$ briar auth login jira-token --company acme
# LLM key is read from the environment, not via auth login:
$ export ANTHROPIC_API_KEY=sk-ant-...

Tokens are written to ~/.config/briar/secrets.envby default. Audit coverage with briar secrets doctor (it walks the runbook YAMLs under ./examples).

3. Build a plan and run the loop

$ briar plan build jira:KAN --name q3 --company acme --llm anthropic
$ briar plan run q3 --company acme --llm anthropic \
--owner acme --repo widgets

The selector picks the next card, the engineer agent opens the PR, the knowledge file learns what changed. Loop continues until the board is done.

Want a guided walkthrough?

The recipes page has end-to-end examples for single-repo, multi-company, and PR-review-only flows. Each one is copy-pasteable.

How these docs are organised

  • Get started — install, mental model, configuration. Read top-to-bottom on your first sitting.
  • CLI reference — one page per command group. Every flag, default, and choice listed; examples for the common cases.
  • Reference — plugin registries (LLMs, providers, trackers, ...), runbook YAML schema, and a recipes page for full workflows.

Next steps

Source of truth

Every flag listed in these docs is verified against the live briar <cmd> --help output. Spot a drift? Open an issue.