Manage Runners
Documentation menu

manage-runners external-runner create

Add an external runner; then install the agent with install-command; --send-to by name also needs runners:read

Required scopes runners:write
Required flags none
Changes state yes
Destructive no
Paid resource effect none
Confirmation none
Non-interactive use supported

Usage

Add an external runner; then install the agent with install-command; --send-to by name also needs runners:read

Usage:
  manage-runners external-runner create [flags]

Flags:
      --dashboard string          show metrics in the dashboard: on|off; on requires an active paid subscription
      --label stringArray         label; repeat for several; on update the given labels replace all, and --label '' removes them
      --name string               runner name: letters, digits, spaces and '-'
      --no-send-to[=true|false]   send metrics to no connection
      --platform string           CI platform of the server: gitlab|github; autoscaling registers its burst runners there, so it cannot change while the runner has a policy
      --profile string            configuration profile
      --send-to string            send metrics to this Metrics connection: id, or a name, which needs runners:read; see metrics list; requires an active paid subscription

Every command also accepts the global flags. For machine-readable help, run manage-runners help external-runner create --output json.