June 20-22 Announcing HashiConf Europe full schedule: keynotes, sessions, labs & more Register Now
  • Infrastructure
    • terraform
    • packer
  • Networking
    • consul
  • Security
    • vault
    • boundary
  • Applications
    • nomad
    • waypoint
    • vagrant
  • HashiCorp Cloud Platform

    A fully managed platform to automate infrastructure on any cloud with HashiCorp products.

    • consul
    • terraform
    • vault
    • packerbeta
    Visit cloud.hashicorp.com
  • Overview
  • Tutorials
  • Docs
  • CLI
  • Plugins
  • Community
GitHub
Download
    • v0.8.x (latest)
    • v0.7.x
    • v0.6.x
    • v0.5.x
    • v0.4.x
    • v0.3.x
    • v0.2.x
    • v0.1.x
  • build
  • deploy
  • destroy
  • exec
  • init
  • install
  • login
  • logs
  • release
  • ui
  • up

  • artifact build
  • artifact list-builds
  • artifact list
  • artifact push
  • auth-method list
  • auth-method inspect
  • auth-method set oidc
  • auth-method delete
  • config get
  • config set
  • config source-get
  • config source-set
  • config sync
  • context
  • context clear
  • context create
  • context delete
  • context inspect
  • context list
  • context rename
  • context use
  • context verify
  • context set
  • deployment deploy
  • deployment destroy
  • deployment list
  • docs
  • fmt
  • hostname delete
  • hostname list
  • hostname register
  • job list
  • job inspect
  • job cancel
  • job get-stream
  • plugin
  • project apply
  • project inspect
  • project list
  • release list
  • runner agent
  • runner list
  • runner inspect
  • runner adopt
  • runner forget
  • runner reject
  • runner token
  • runner profile list
  • runner profile inspect
  • runner profile set
  • server bootstrap
  • server cookie
  • server config-set
  • server install
  • server restore
  • server run
  • server snapshot
  • server uninstall
  • server upgrade
  • status
  • trigger create
  • trigger update
  • trigger delete
  • trigger inspect
  • trigger list
  • user inspect
  • user invite
  • user modify
  • user token
  • version
  • workspace create
  • workspace inspect
  • workspace list

  • k8s bootstrap
  • token exchange
  • token invite
  • token new
Type '/' to Search

»Waypoint Runner list

Command: waypoint runner list

List registered runners

»Usage

Usage: waypoint runner list [options]

List runners that are registered with the Waypoint server.

This will list all runners that the Waypoint server currently knows about. This list does not guarantee each runner is online; Waypoint currently does not expose online/offline status. This lists runners that have registered at least once with the server.

This can be used to find pending runners that need to be adopted. Runners that are pending (not adopted) will not be sent any jobs or configuration. Runners that are accepted (adopted) are sent jobs. Runners that are "preadopted" are sent jobs but have avoided the manual adoption process by being preconfigured with a valid runner token (see "waypoint runner token"). Runners that are "rejected" are never given jobs, and error immediately if they try to register.

If a runner is pending, you can adopt it using "waypoint runner adopt ID" where "ID" comes from the output from this command. You can explicitly reject a runner using "waypoint runner reject ID". A runner can be rejected at any time, even after it is already adopted.

»Global Options

  • -plain - Plain output: no colors, no animation.
  • -app=<string> (-a) - App to target. Certain commands require a single app target for Waypoint configurations with multiple apps. If you have a single app, then this can be ignored.
  • -project=<string> (-p) - Project to target.
  • -workspace=<string> (-w) - Workspace to operate in.

»Operation Options

  • -label=<key=value> - Labels to set for this operation. Can be specified multiple times.
  • -local - True to use a local runner to execute the operation, false to use a remote runner. If unset, Waypoint will automatically determine where the operation will occur, defaulting to remote if possible.
  • -remote-source=<key=value> - Override configurations for how remote runners source data. This is specified to the data source type being used in your configuration. This is used for example to set a specific Git ref to run against.
  • -var=<key=value> - Variable value to set for this operation. Can be specified multiple times.
  • -var-file=<string> - HCL or JSON file containing variable values to set for this operation. If any ".auto.wpvars" or ".auto.wpvars.json" files are present, they will be automatically loaded.

»Command Options

  • -pending - List only runners pending adoption.
  • -json - Output runner configuration list information as JSON. This includes more fields since this is the complete API structure.
github logoEdit this page

Using Waypoint

The best way to understand what Waypoint can enable for your projects is to give it a try.

Waypoint tutorials
Waypoint documentation
Tutorial

Get Started - Kubernetes

Build, deploy, and release applications to a Kubernetes cluster.

View
Tutorial

Introduction to Waypoint

Waypoint enables you to publish any application to any platform with a single file and a single command.

View

Waypoint is maintained by HashiCorp, Inc.

View Code of Conduct
DocumentationCLI ReferenceTutorialsIntegrations
All systems normal