Run Open Code Review with Docker

Prerequisites#

• Docker Engine 23 or later.
• An API key for an LLM provider ocr supports, such as ANTHROPIC_API_KEY or OPENAI_API_KEY.

Review your changes#

ocr needs a provider and model before it can review. It saves them in /home/sysadmin/.opencodereview/config.json, which --rm deletes when the container exits, so configure and review in the same container. Start a shell in the image with your key and the checkout:

docker run -it --rm -e ANTHROPIC_API_KEY -v "$PWD:/workspace" \
  --entrypoint zsh ghcr.io/hambn/open-code-review:ubuntu-browser

Then, inside it:

ocr config set provider anthropic
ocr config set model <model>
ocr review                      # staged, unstaged, and untracked changes
ocr review --from main --to HEAD

./run.sh <args> suits commands that need no saved settings, such as ./run.sh --help. See the upstream configuration reference (opens in new tab) for other providers and their variables.

Run without registry access#

On a machine that can pull, save the image:

docker save ghcr.io/hambn/open-code-review:ubuntu-browser -o open-code-review.tar

Copy the tar to the offline host and pass its path first; the remaining arguments go to ocr:

./airgapped.run.sh open-code-review.tar --help

The script loads the tar and runs OPEN_CODE_REVIEW_IMAGE with --pull=never. After it has loaded the image once, start a shell as shown above with --pull=never added. A review still needs network access to your LLM provider.

Variables#

Workspace#

The current directory is mounted at /workspace, the image's working directory. ocr runs as sysadmin (UID 1000); the checkout must be a Git repository for ocr review.

Files#

• run.sh pulls the image if needed and runs ocr with your arguments.
• airgapped.run.sh loads a saved tar and runs it without pulling.

#!/usr/bin/env bash
# Offline host: load the image from a tar saved on an online host, never pull.
#   docker save ghcr.io/hambn/open-code-review:ubuntu-browser -o open-code-review.tar
set -euo pipefail

image=${OPEN_CODE_REVIEW_IMAGE:-ghcr.io/hambn/open-code-review:ubuntu-browser}
tar=${1:-open-code-review.tar}
shift $(($# > 0 ? 1 : 0))
[[ -f "$tar" ]] || {
    echo "missing $tar; docker save it on an online host first" >&2
    exit 1
}

docker load -i "$tar"
docker run -it --rm --pull=never \
    -v "$PWD:/workspace" \
    "$image" "$@"

#!/usr/bin/env bash
# Run Open Code Review against the current directory.
set -euo pipefail

image=${OPEN_CODE_REVIEW_IMAGE:-ghcr.io/hambn/open-code-review:ubuntu-browser}
docker run -it --rm \
    -v "$PWD:/workspace" \
    "$image" "$@"