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.
Requirements
Section titled “Requirements”- 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.
macOS and Linux
Section titled “macOS and Linux”curl -fsSL https://code-downloads.champrep.com/install/runner.sh | shThe 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:
champrep-code-runner versionWindows
Section titled “Windows”In PowerShell:
irm https://code-downloads.champrep.com/install/runner.ps1 | iexThe 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.
Install a specific version
Section titled “Install a specific version”New installs get the latest release. To install an exact version, set
CHPCODE_RUNNER_VERSION for the installer:
curl -fsSL https://code-downloads.champrep.com/install/runner.sh | CHPCODE_RUNNER_VERSION=0.1.1 sh$env:CHPCODE_RUNNER_VERSION = '0.1.1'; irm https://code-downloads.champrep.com/install/runner.ps1 | iexSet 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.
Download manually
Section titled “Download manually”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:
shasum -a 256 -c SHA256SUMS --ignore-missingUpgrade
Section titled “Upgrade”Runners you already run keep working when a new version ships, so you can upgrade when it suits you:
- Stop the runner. Running jobs finish first:
champrep-code-runner service stop(or Ctrl+C in a terminal). - Run the installer again, optionally with
CHPCODE_RUNNER_VERSION. - Start it:
champrep-code-runner service start(orchamprep-code-runner run).
Your registration and configuration are kept. To go back to an earlier version, install it the same way.
Uninstall
Section titled “Uninstall”champrep-code-runner service uninstall # if you installed the servicechamprep-code-runner unregister --all # remove this machine's runnerssudo rm /usr/local/bin/champrep-code-runnerThen delete the runner in CHAMPREP Code (Settings > CI/CD > Runners) to revoke its token.