Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _vendor/github.com/docker/buildx/docs/bake-reference.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions _vendor/modules.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# github.com/moby/moby v27.5.0+incompatible
# github.com/moby/buildkit v0.18.1
# github.com/docker/buildx v0.19.2
# github.com/moby/buildkit v0.19.0
# github.com/docker/buildx v0.20.0
# github.com/docker/cli v27.5.0+incompatible
# github.com/docker/compose/v2 v2.32.4
# github.com/docker/scout-cli v1.15.0
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history
title: docker buildx history
layout: cli
aliases:
- /engine/reference/commandline/buildx_history/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/inspect/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_inspect
title: docker buildx history inspect
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_inspect/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_inspect_attachment
title: docker buildx history inspect attachment
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_inspect_attachment/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_logs
title: docker buildx history logs
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_logs/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/ls.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_ls
title: docker buildx history ls
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_ls/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_open
title: docker buildx history open
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_open/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
16 changes: 16 additions & 0 deletions content/reference/cli/docker/buildx/history/rm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
datafolder: buildx
datafile: docker_buildx_history_rm
title: docker buildx history rm
layout: cli
aliases:
- /engine/reference/commandline/buildx_history_rm/
---

<!--
This page is automatically generated from Docker's source code. If you want to
suggest a change to the text that appears here, open a ticket or pull request
in the source repository on GitHub:

https://github.com/docker/buildx
-->
2 changes: 2 additions & 0 deletions data/buildx/docker_buildx.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ cname:
- docker buildx debug
- docker buildx dial-stdio
- docker buildx du
- docker buildx history
- docker buildx imagetools
- docker buildx inspect
- docker buildx ls
Expand All @@ -26,6 +27,7 @@ clink:
- docker_buildx_debug.yaml
- docker_buildx_dial-stdio.yaml
- docker_buildx_du.yaml
- docker_buildx_history.yaml
- docker_buildx_imagetools.yaml
- docker_buildx_inspect.yaml
- docker_buildx_ls.yaml
Expand Down
56 changes: 51 additions & 5 deletions data/buildx/docker_buildx_bake.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,34 @@ options:
experimentalcli: false
kubernetes: false
swarm: false
- option: list
value_type: string
description: List targets or variables
details_url: '#list'
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: list-targets
value_type: bool
default_value: "false"
description: List available targets
deprecated: false
deprecated: true
hidden: true
experimental: false
experimentalcli: true
experimentalcli: false
kubernetes: false
swarm: false
- option: list-variables
value_type: bool
default_value: "false"
description: List defined variables
deprecated: false
deprecated: true
hidden: true
experimental: false
experimentalcli: true
experimentalcli: false
kubernetes: false
swarm: false
- option: load
Expand Down Expand Up @@ -125,7 +135,7 @@ options:
value_type: string
default_value: auto
description: |
Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output
Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output
details_url: '#progress'
deprecated: false
hidden: false
Expand Down Expand Up @@ -259,6 +269,42 @@ examples: |-
See the [Bake file reference](/build/bake/reference/)
for more details.

### List targets and variables (--list) {#list}

The `--list` flag displays all available targets or variables in the Bake
configuration, along with a description (if set using the `description`
property in the Bake file).

To list all targets:

```console {title="List targets"}
$ docker buildx bake --list=targets
TARGET DESCRIPTION
binaries
default binaries
update-docs
validate
validate-golangci Validate .golangci.yml schema (does not run Go linter)
```

To list variables:

```console
$ docker buildx bake --list=variables
VARIABLE VALUE DESCRIPTION
REGISTRY docker.io/username Registry and namespace
IMAGE_NAME my-app Image name
GO_VERSION <null>
```

By default, the output of `docker buildx bake --list` is presented in a table
format. Alternatively, you can use a long-form CSV syntax and specify a
`format` attribute to output the list in JSON.

```console
$ docker buildx bake --list=type=targets,format=json
```

### Write build results metadata to a file (--metadata-file) {#metadata-file}

Similar to [`buildx build --metadata-file`](/reference/cli/docker/buildx/build/#metadata-file) but
Expand Down
10 changes: 7 additions & 3 deletions data/buildx/docker_buildx_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,7 @@ options:
value_type: string
default_value: auto
description: |
Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output
Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output
details_url: '#progress'
deprecated: false
hidden: false
Expand Down Expand Up @@ -1317,8 +1317,12 @@ examples: |-
--progress=VALUE
```

Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use `plain` to show container
output (default `auto`).
Set type of progress output. Supported values are:
- `auto` (default): Uses the `tty` mode if the client is a TTY, or `plain` otherwise
- `tty`: An interactive stream of the output with color and redrawing
- `plain`: Prints the raw build progress in a plaintext format
- `quiet`: Suppress the build output and print image ID on success (same as `--quiet`)
- `rawjson`: Prints the raw build progress as JSON lines

> [!NOTE]
> You can also use the `BUILDKIT_PROGRESS` environment variable to set its value.
Expand Down
2 changes: 1 addition & 1 deletion data/buildx/docker_buildx_debug_build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ options:
value_type: string
default_value: auto
description: |
Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output
Set type of progress output (`auto`, `quiet`, `plain`, `tty`, `rawjson`). Use plain to show container output
deprecated: false
hidden: false
experimental: false
Expand Down
46 changes: 46 additions & 0 deletions data/buildx/docker_buildx_history.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
command: docker buildx history
short: Commands to work on build records
long: Commands to work on build records
usage: docker buildx history
pname: docker buildx
plink: docker_buildx.yaml
cname:
- docker buildx history inspect
- docker buildx history logs
- docker buildx history ls
- docker buildx history open
- docker buildx history rm
clink:
- docker_buildx_history_inspect.yaml
- docker_buildx_history_logs.yaml
- docker_buildx_history_ls.yaml
- docker_buildx_history_open.yaml
- docker_buildx_history_rm.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

38 changes: 38 additions & 0 deletions data/buildx/docker_buildx_history_inspect.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
command: docker buildx history inspect
short: Inspect a build
long: Inspect a build
usage: docker buildx history inspect [OPTIONS] [REF]
pname: docker buildx history
plink: docker_buildx_history.yaml
cname:
- docker buildx history inspect attachment
clink:
- docker_buildx_history_inspect_attachment.yaml
inherited_options:
- option: builder
value_type: string
description: Override the configured builder instance
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug
shorthand: D
value_type: bool
default_value: "false"
description: Enable debug logging
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

Loading