Edge Runners binary reference

1 minute readReference

The Edge runners binary supports several commands and flags to manage and operate the edge runner. Use this reference when configuring, starting, or managing the runner process from the command line.

Table 1. Available commands and flags for the edge runner binary
Command/Flag Description

--execution-mode

Specify the execution mode for the edge runner; native or docker.

-completion

Generate shell completion scripts for the edge runner CLI.

configure

Configure the edge runner with the necessary settings and credentials.

delete

Delete the edge runner configuration and associated data.

help

Show help information for the edge runner CLI.

run

Start the edge runner to listen for and execute jobs.

version

Display the version information for the edge runner binary.

-h, --help

Show help information for the edge runner CLI.

edge-runner [command] --help

Show help information for a specific command, replacing [command] with the desired command (for example, edge-runner configure --help).