DOCKER-BUILDX-LS(1)

πŸ“¦ version 0.13.1, in debian trixie

πŸ’… DOCKER-BUILDX-LS(1) β€” like, the manual page bestie

okay so this is the manual page for docker-buildx-ls from the docker-buildx family of docs β€” it lives in section 1 of the manual, and we're gonna go through the whole thing together, no skimming, no skipping, periodt. ✨


✨ NAME ✨

docker-buildx-ls β€” list builder instances 🫢


🌸 SYNOPSIS 🌸

docker buildx ls

that's it. that's the whole vibe. one command, zero drama. πŸ’–


πŸ¦‹ DESCRIPTION πŸ¦‹

So what does it do? It lists all builder instances and the nodes for each instance. Every single one. All of them. We're not gatekeeping builders here. πŸ‘‘

$ docker buildx ls
NAME/NODE           DRIVER/ENDPOINT                   STATUS    BUILDKIT   PLATFORMS
elated_tesla*       docker-container
 \_ elated_tesla0    \_ unix:///var/run/docker.sock   running   v0.10.3    linux/amd64
 \_ elated_tesla1    \_ ssh://ubuntu@1.2.3.4          running   v0.10.3    linux/arm64*, linux/arm/v7, linux/arm/v6
default             docker
 \_ default          \_ default                       running   v0.8.2     linux/amd64

ngl this output is kind of iconic. let's break it down:

  • each builder has one or more nodes associated with it β€” it's giving squad energy fr fr 🧚
  • the current builder's name is marked with a * in the NAME/NODE column
  • the explicit node to build against for the target platform is marked with a * in the PLATFORMS column

so when you see a little star, that's the main character. ⭐


πŸ”₯ OPTIONS πŸ”₯

  • --format="table" β€” format the output. default is "table", and yes you can change it, keep reading bestie πŸ’…
  • -h, --help[=false] β€” help for ls. it's the little "hey what does this do again" button πŸ₯Ί

πŸŽ€ EXAMPLE πŸŽ€

πŸ’œ Format the output (--format)

The formatting options (--format) pretty-prints builder instances output using a Go template. ooooh fancy ✨

Valid placeholders for the Go template are listed below:

  • .Name β€” Builder or node name
  • .DriverEndpoint β€” Driver (for builder) or Endpoint (for node)
  • .LastActivity β€” Builder last activity
  • .Status β€” Builder or node status
  • .Buildkit β€” BuildKit version of the node
  • .Platforms β€” Available node's platforms
  • .Error β€” Error
  • .Builder β€” Builder object

When using the --format option, the ls command will either output the data exactly as the template declares or, when using the table directive, includes column headers as well. pick your fighter 🫢

The following example uses a template without headers and outputs the Name and DriverEndpoint entries separated by a colon (:):

$ docker buildx ls --format "{{.Name}}: {{.DriverEndpoint}}"
elated_tesla: docker-container
elated_tesla0: unix:///var/run/docker.sock
elated_tesla1: ssh://ubuntu@1.2.3.4
default: docker
default: default

The Builder placeholder can be used to access the builder object and its fields. For example, the following template outputs the builder's and nodes' names with their respective endpoints:

$ docker buildx ls --format "{{.Builder.Name}}: {{range .Builder.Nodes}}\n  {{.Name}}: {{.Endpoint}}{{end}}"
elated_tesla:
  elated_tesla0: unix:///var/run/docker.sock
  elated_tesla1: ssh://ubuntu@1.2.3.4
default: docker
  default: default

see how clean that is? no cap, templates are lowkey a superpower. πŸ¦‹


🌈 SEE ALSO 🌈


and that's the whole page bestie!! πŸ’– this was DOCKER-BUILDX-LS(1) from Apr 2025, part of the docker-buildx docs β€” go forth and list those builders, you absolute legend πŸ‘‘πŸŒΈβœ¨

πŸ“¦ where this page comes from