Skip to content
Documentation

CHAMPREP Code runner

The CHAMPREP Code runner (champrep-code-runner) is a small program you install on a machine you control. It connects to CHAMPREP Code, picks up the CI/CD jobs of your pipelines, runs them, and sends back the log, the status and any artifacts. Your code and your build tools stay on your machine.

CHAMPREP has two command-line programs. They are separate downloads with separate commands:

CHAMPREP Code runnerCHAMPREP CLI
Commandchamprep-code-runnerchamprep
Who uses itA build machine, server or VMYou, at your terminal
What it doesRuns CI/CD jobs for CHAMPREP Code pipelinesWorks with CHAMPREP services, including Code, from a terminal
Install fromcode-downloads.champrep.comcli.champrep.com
DocsThis sectionCLI reference

If you want pipelines to run on your own machines, you need the runner. If you want to work with CHAMPREP from a terminal, you need the CLI. Many teams use both.

  1. You create a runner in CHAMPREP Code (a project, group or instance runner) and choose which jobs it takes: its tags, whether it runs untagged jobs, and whether it runs only protected branches and tags.
  2. You install champrep-code-runner on a machine and register it with the runner’s authentication token.
  3. You run it, in a terminal or as a service that starts at boot.
  4. The runner asks CHAMPREP Code for jobs over outbound HTTPS, runs each one with its executor (shell, Docker or Kubernetes), and reports back.

The runner only makes outbound connections. You do not need to open any inbound port.

ExecutorRuns each jobUse it for
shellDirectly on the host, as the runner’s userTrusted projects that need the host’s tools
dockerIn a fresh container from the job’s imageIsolated, reproducible builds
kubernetesIn a pod in your clusterScaling builds on a cluster you already run

The shell executor has no isolation between jobs and the host. Use it only for projects you trust.

  1. Install the runner.
  2. Register it with a runner token.
  3. Start it and keep it running with the runner commands.

If something does not work, see Troubleshooting.