Skip to content
Documentation

Install the runner

The runner is one binary for macOS, Linux and Windows on amd64 and arm64. Releases are published at code-downloads.champrep.com.

  • macOS 12 or later, Linux, or Windows 10, 11, or Server 2019 or later.
  • Git 2.24 or later on PATH. On Windows, Git for Windows.
  • Outbound HTTPS to code.champrep.com.
  • For the Docker executor: Docker Engine 25 or later running Linux containers.
  • For the Kubernetes executor: access to the cluster the jobs run in.
Terminal window
curl -fsSL https://code-downloads.champrep.com/install/runner.sh | sh

The installer picks your operating system and architecture, downloads the latest release, checks it against the release’s SHA256SUMS, and installs it to /usr/local/bin (it asks for sudo when needed). Without write access and without sudo, it installs to ~/.local/bin.

Check the installation:

Terminal window
champrep-code-runner version

In PowerShell:

Terminal window
irm https://code-downloads.champrep.com/install/runner.ps1 | iex

The installer checks the checksum and installs to %LOCALAPPDATA%\CHAMPREP\bin. To run the runner as a Windows service, copy the binary to a stable location first, for example C:\Program Files\CHAMPREP\champrep-code-runner.exe.

New installs get the latest release. To install an exact version, set CHPCODE_RUNNER_VERSION for the installer:

Terminal window
curl -fsSL https://code-downloads.champrep.com/install/runner.sh | CHPCODE_RUNNER_VERSION=0.1.1 sh
Terminal window
$env:CHPCODE_RUNNER_VERSION = '0.1.1'; irm https://code-downloads.champrep.com/install/runner.ps1 | iex

Set the variable on sh, after the pipe, not on curl. Every release stays available: releases.json lists them all, newest first.

To install somewhere else, set CHPCODE_INSTALL_DIR the same way.

Each release has a folder with one binary per platform and a SHA256SUMS file:

https://code-downloads.champrep.com/releases/<version>/runner/champrep-code-runner-<os>-<arch>
https://code-downloads.champrep.com/releases/<version>/runner/SHA256SUMS

<os> is darwin, linux or windows (Windows files end in .exe), and <arch> is amd64 or arm64. Verify the download before you run it:

Terminal window
shasum -a 256 -c SHA256SUMS --ignore-missing

Runners you already run keep working when a new version ships, so you can upgrade when it suits you:

  1. Stop the runner. Running jobs finish first: champrep-code-runner service stop (or Ctrl+C in a terminal).
  2. Run the installer again, optionally with CHPCODE_RUNNER_VERSION.
  3. Start it: champrep-code-runner service start (or champrep-code-runner run).

Your registration and configuration are kept. To go back to an earlier version, install it the same way.

Terminal window
champrep-code-runner service uninstall # if you installed the service
champrep-code-runner unregister --all # remove this machine's runners
sudo rm /usr/local/bin/champrep-code-runner

Then delete the runner in CHAMPREP Code (Settings > CI/CD > Runners) to revoke its token.