ProPR
Log in Get ProPR

Quickstart

Install propr-cli and run propr setup. The guided flow verifies the host, authorizes agents, connects GitHub, and starts the Docker stack. Then label an issue or approve a plan and review the resulting pull request.

propr setup Guided
  1. Verify hostDocker + Node.js
  2. Authorize agentsexisting credentials
  3. Connect GitHubrelay or your App
  4. Start stackpublished images
propr setup checks each boundary before the stack starts.

Setup overview

Two commands to a running stack.

propr setup checks the host, scaffolds the stack root, authorizes agents, enrolls the default ProPR Connect path, and starts the services. Rerun it safely whenever setup changes.

npm install -g propr-cli
propr setup
ProPR setup, step by step.Follow the guided CLI flow from installation through a running stack.

System requirements

  • Host/platformLinux amd64 is the native, recommended production path. Apple Silicon works through Docker Desktop running the published Linux amd64 images under emulation. Native arm64 images are not available.
  • Docker accessDocker must be installed and running. On Linux, the user needs direct read/write access to /var/run/docker.sock.
  • Node.jsNode.js 22+ and npm are required. The npm global install location must be writable by the installing user, or installation must use the OS-appropriate elevated or user-prefix method.
  • CapacityThe evaluation minimum is 2 vCPU, 4 GB RAM, and 20 GB free disk. 8 GB RAM is recommended for normal use.
  • AccountsGitHub and at least one supported agent-provider account are required. The active GitHub / ProPR Connect installation must have access to the repository being monitored. Run only one active ProPR processor for the same GitHub installation and repository; additional stacks must monitor disjoint repositories or remain stopped because Connect intentionally fans deliveries to all connected sockets and overlapping processors duplicate work.
  • NetworkThe host needs outbound HTTPS and WebSocket access to the documented destinations. No inbound public port is required. The UI and API bind to loopback.

Read the complete system requirements, including the Docker capability and security contract.

Or let your coding agent handle the ProPR setup

The ProPR data folder is the directory containing .env, data/, logs/, and repos/. The canonical full prompt keeps deeper capacity, network, authorization, and verification detail in the setup docs.

Prompt for your coding agentCopy and paste this into your agent chat.
Install ProPR safely on this host. The ProPR data folder is the directory containing `.env`, `data/`, `logs/`, and `repos/`.

1. Verify and report the applicable platform prerequisites, Node.js 22+, Docker Engine and CLI or Docker Desktop, and Docker daemon access.
2. Install the current public CLI with `npm install -g propr-cli` and verify `propr --version`.
3. Preserve existing data. When reusing the ProPR data folder already configured for this CLI, run plain `propr check` there before any changes. Stop and report a failure.
4. Run interactive plain `propr setup`. Let the wizard create or select the ProPR data folder, then pause so I can complete external authorization and scope choices.
5. Finish with plain `propr check` and `propr status` against the configured stack.

Never request credentials, tokens, private keys, cookies, or one-time codes in prompts, chat, or logs.

ProPR saves the data folder selected during setup, so later commands resolve it without repeated --root arguments. The human completes provider and GitHub authorization in the providers' own flows.

Run it knowing exactly what it touches.

The propr CLI is a thin, transparent wrapper. It verifies the host, uses the agent credentials already on it, connects GitHub, and starts the published images through the launcher on your Docker daemon. The documentation covers every path and port.

  1. 01 Verify host
  2. 02 Authorize agents
  3. 03 Connect GitHub
  4. 04 Start stack

Verify the host

propr setup checks Node.js, Docker and daemon access before changing the stack. It reports missing prerequisites instead of starting a partial installation.

Authorize agents

The guided setup detects supported agent credentials already on the host and lets you choose which agents to enable. Authentication stays in each provider's own flow.

Connect GitHub

propr setup enrolls the default ProPR Connect path and saves a revocable relay credential. Your own GitHub App remains available for a fully self-managed connection.

Start the stack

The setup creates the stack root, writes its configuration, pulls the published images, and starts the services on your Docker daemon. It then reports the local web UI address.

Two ways to connect, same workflow after.

ProPR Connect: the guided default.

propr setup completes shared-App enrollment and stores a durable relay credential in your .env. The stack uses it to fetch short-lived installation tokens. propr login and propr relay enroll remain available for manual setup and token management.

Your own GitHub App: full control.

Register a GitHub App on your account or organization with scoped permissions (contents, issues, and pull requests), install it on the repositories ProPR should work on, and point .env at the app ID, installation ID, and private key. Everything stays under your ownership — the posture described in trust and security.

The guided path

Follow the full loop from prompt to reviewed pull request, with each ProPR handoff made explicit.

Configure agents & repos

Set repositories, branches, trigger labels, agents, and model IDs from the web UI.

Deploy to a server

Run the stack on a Linux host with persistent storage and TLS at your reverse proxy.

Run a real workflow next.

Recipes turn the running stack into practical work: improve a PR after review, update a stale branch, split a large change, or move repository todos into a plan. Start with the PR follow-up recipe — the fastest proof that GitHub comments become commits.

Open recipes