Documentation

Install the GitHub App. Hosted trials cover up to three organizations per installing identity; BYOK covers additional organizations. These pages also cover the open-source CLI, CI merge gating, configuration, and running the whole stack on your own hardware.

Quickstart

Install the GitHub App. Hosted trials cover up to three organizations per installing identity; BYOK covers additional organizations.

Coding agents

Add Postil to an agent's pre-PR workflow with one local command and a ready-to-paste AGENTS.md or CLAUDE.md snippet.

Configuration

The full .postil.yaml reference, including CodeRabbit config translation (reads .coderabbit.yaml).

CLI reference

Every command and flag: review, respond, plan, config, init, doctor, hook, plus environment variables and exit codes.

Exit codes

The precise CLI contract: 0 clean or below the gate threshold, 1 gate-failing findings, 2 operational error.

The gate

postil/gate semantics, fail-on thresholds, and how to require it in branch protection.

postil plan

Dry-run a config change against stored envelopes before deploying it. No model calls.

Envelope schema

The JSON contract between the CLI and everything else: findings, counts, gate, usage.

Content policy

Default-on review of prose with a built-in baseline, repo-specific extensions, and an explicit opt-out.

Forges

GitHub, GitLab, Bitbucket, and Azure DevOps: auth per forge and what each one supports.

Self-hosted

Run the CLI in your own CI with your own key, or host the full web + worker control plane yourself.

Models

Recommended OpenRouter and local models, token-cost math, and how to run the live model benchmark.

The short version

# GitHub App: install and choose repositories
# new non-draft PRs are reviewed during the hosted trial

# local
curl -fsSL https://postil.dev/install.sh | sh
# or: cargo install --git https://github.com/postil-dev/postil-cli --locked
postil doctor            # verify endpoint, key, and model
postil review --staged

# CI (GitHub Actions)
- uses: postil-dev/postil-action@00442e2340edaa4a681955dbb25e20650ca1514c # tested pair
  with:
    cli-ref: dcf4e34c4804d4bf64705ab6367c883cea23b33a
    cli-release: v0.7.2

Exit codes: 0 clean or below the gate threshold, 1 gate-failing findings, 2 operational error. Postil never reports an operational error as a pass.