Getting started

A tool that helps to review your changes.

Overview

flowchart LR install[Install CLI] --> auth[gh auth login] auth --> probe[probe] probe --> init[init] init --> review[review] init --> sync["sync
(to keep your context up to date)"]

Install

npm install -g co-maintainer
co-maintainer --version

Review my changes now

In a clone of the repository, replace owner/repo with your repository:

gh auth login
co-maintainer init owner/repo
co-maintainer review

Ways to use it

You want	Where it runs	Typical entry	Read
Try a PR or local branch quickly	Your machine	`review` or `review owner/repo 123`	local-review · PR review
Team-wide PR reviews without everyone running the CLI	Your server + GitHub App	`set` App credentials, then `serve`	serve
Operate repos, tokens, concurrency	Browser on the server	Dashboard after `serve`	dashboard
Review a local diff without every developer running init/sync	Laptop + server	`set --remote-host` then `review --remote`	remote-review
Refresh guides after main moves	Same place as `init`	`sync owner/repo`	sync
Review pushes to `main` without PRs	Your server (`serve`), with the GitHub App or CI	Tick Push in the App's events, or add the CI workflow	commit-watch-review