DOCKER-BUILDX-LS(1)
π 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 theNAME/NODEcolumn - the explicit node to build against for the target platform is marked with a
*in thePLATFORMScolumn
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 forls. 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
- debian trixie: docker-buildx 0.13.1+ds1-3 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms