Manage Runners Logo
Manage Runners
Documentation menu

CLI command reference

Every manage-runners 1.0.1 command with its scopes, safety properties and help text.

This reference is generated from manage-runners itself. Each page lists the command's required token scopes, whether it changes state or creates paid resources, which confirmation it needs, and its full help text. The agent guideexplains how to read these properties.

Commands

general

CommandSummary
manage-runners commandsList CLI commands
manage-runners helpShow command help
manage-runners versionShow CLI version metadata; --check compares it with the latest release
manage-runners self-updateReplace this binary with the latest release, or --version, after verifying its SHA-256
manage-runners completionGenerate shell completion scripts
manage-runners setupRun the human setup wizard
manage-runners doctorRun read-only diagnostics

config

CommandSummary
manage-runners config showShow effective non-secret configuration
manage-runners config profilesList configured API profiles
manage-runners config set-apiStore an API origin after HTTPS validation; the default profile otherwise uses https://api.managerunners.com

setup

CommandSummary
manage-runners setup skillInstall or manage the embedded agent skill

auth

CommandSummary
manage-runners auth loginStore a PAT from stdin or a named environment variable
manage-runners auth statusShow authentication status without printing the token
manage-runners auth logoutRemove the local credential; optionally revoke the current PAT
manage-runners auth profilesList local profiles without credentials
manage-runners auth useSelect the default profile

runner

CommandSummary
manage-runners runner listList owned runners
manage-runners runner getGet one runner by exact ID or unique name
manage-runners runner watchPoll a runner until a target or terminal state
manage-runners runner metricsShow resource monitoring metrics for one or all monitored runners
manage-runners runner ssh-keysList SSH keys available through the runner provider credential
manage-runners runner createCreate one runner; may create paid Hetzner resources
manage-runners runner updateUpdate one runner; product, GitLab host, runner token, concurrency, executor, SSH key or monitoring changes recreate an active runner's VM
manage-runners runner pausePause a runner and delete its active VM
manage-runners runner resumeResume a paused runner; may create paid Hetzner resources
manage-runners runner duplicateDuplicate a runner; may create paid Hetzner resources
manage-runners runner deleteDelete an active or paused runner
manage-runners runner forgetRemove only an UNKNOWN dashboard record
manage-runners runner waitWait for a runner target state after a mutation

schedule

CommandSummary
manage-runners schedule getRead a runner schedule
manage-runners schedule setCreate or replace a runner schedule
manage-runners schedule enableEnable an existing schedule
manage-runners schedule disableDisable a schedule without deleting it
manage-runners schedule deletePermanently delete a schedule

product

CommandSummary
manage-runners product listList GitLab runner products
manage-runners product getGet one product by exact ID
manage-runners product locationsShow bookable datacenters and prices for a product

provider

CommandSummary
manage-runners provider hetzner ssh-keysValidate a Hetzner token and list SSH keys

profile

CommandSummary
manage-runners profile showShow the current non-sensitive user profile

subscription

CommandSummary
manage-runners subscription showShow the current subscription and schedule entitlement
manage-runners subscription plansList available subscription plans

org

CommandSummary
manage-runners org listList your organizations with role and default marker
manage-runners org useStore the organization for the profile's organization-scoped commands, or clear it

Global flags

These flags work with every command.

      --agent                     agent mode: JSON and non-interactive
      --api-url string            API origin; must match the selected profile
      --credential-store string   credential store: keyring|file, also via $MANAGE_RUNNERS_CREDENTIAL_STORE; file keeps only a scoped, expiring PAT in a 0600 file, never your password or 2FA secret (default "keyring")
      --json                      emit JSON
      --no-color                  disable color output
      --non-interactive           disable prompts
      --org string                organization id or name for runner, schedule, subscription and provider commands; overrides the profile's organization
      --output string             output format: human|json|jsonl (default "human")
      --profile string            configured API profile
      --request-id string         request ID sent to the API
      --timeout duration          maximum command duration (for example 30s)
      --token-env string          named PAT environment variable for this invocation; overrides $MANAGE_RUNNERS_TOKEN; nothing is stored