Manage Runners
Documentation menu

manage-runners runner create

Create one GitLab or GitHub (--platform github) runner; may create paid Hetzner or DigitalOcean (--provider digitalocean) resources; --cache or --send-to by name also needs runners:read

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

This command may create paid Hetzner or DigitalOcean resources. Read confirmations before running it non-interactively.

Usage

Create one GitLab or GitHub (--platform github) runner; may create paid Hetzner or DigitalOcean (--provider digitalocean) resources; --cache or --send-to by name also needs runners:read

Usage:
  manage-runners runner create [flags]

Flags:
      --cache string                     S3 cache id, or a name, which needs runners:read; see cache list (GitLab runners)
      --concurrency int                  runner concurrency; 1 to 32 for GitHub runners
      --dashboard string                 show metrics in the dashboard: on|off; on requires an active paid subscription
      --digitalocean-connection string   DigitalOcean connection id instead of --provider-token-env, with --provider digitalocean; see provider digitalocean connections
      --executor string                  runner executor (GitLab runners)
      --github-owner string              GitHub user or organization (GitHub runners)
      --github-repository string         GitHub repository of the owner; omit for an organization runner
      --github-runner-group string       runner group of an organization runner; omit for the default group
      --github-token-env string          environment variable containing a fine-grained GitHub token: Administration read and write for a repository, Self-hosted runners read and write for an organization
      --gitlab-host string               GitLab host (GitLab runners)
      --hetzner-token string             saved Hetzner token id instead of --hetzner-token-env; see provider hetzner tokens
      --hetzner-token-env string         environment variable containing the Hetzner token
      --idempotency-key string           idempotency key
      --interval duration                polling interval (default 2s)
      --label stringArray                runner label
      --location string                  location of the cloud provider, for example fsn1 (Hetzner) or fra1 (DigitalOcean); see product locations
      --name string                      runner name; omit it to get a generated name such as swift-falcon
      --no-cache[=true|false]            use no cache
      --no-send-to[=true|false]          send metrics to no connection
      --platform string                  CI platform: gitlab|github (default "gitlab")
      --product-id string                product id
      --profile string                   configuration profile
      --provider string                  cloud provider: hetzner|digitalocean (default "hetzner")
      --provider-token-env string        environment variable containing the token of the cloud provider; a DigitalOcean token needs the custom scopes account:read, droplet:create, droplet:read, droplet:update, droplet:delete, image:read, reserved_ip:create, reserved_ip:read, reserved_ip:update, reserved_ip:delete, ssh_key:read and tag:create
      --runner-token-env string          environment variable containing the runner token (GitLab runners)
      --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
      --ssh-key-id stringArray           SSH key id
      --timeout duration                 maximum wait duration (default 10m0s)
      --wait[=true|false]                wait for a terminal runner state
      --watchdog string                  restart the runner by a forced pause and resume when its collector reports nothing for --watchdog-timeout minutes, at most 3 times in 24 hours: on|off; needs metrics shown in the dashboard or sent to a connection
      --watchdog-timeout int             minutes without collector reports before the watchdog restarts the runner, 5 to 60; omitted: 10
      --yes[=true|false]                 confirm the paid resource operation

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