diff --git a/commands/history/export.go b/commands/history/export.go
index c0c0f68dc672..5ccf25f3231a 100644
--- a/commands/history/export.go
+++ b/commands/history/export.go
@@ -139,8 +139,8 @@ func exportCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
var options exportOptions
cmd := &cobra.Command{
- Use: "export [OPTIONS] [REF]",
- Short: "Export a build into Docker Desktop bundle",
+ Use: "export [OPTIONS] [REF...]",
+ Short: "Export build records into Docker Desktop bundle",
RunE: func(cmd *cobra.Command, args []string) error {
if options.all && len(args) > 0 {
return errors.New("cannot specify refs when using --all")
diff --git a/commands/history/import.go b/commands/history/import.go
index afd956083614..ff43d6d8bf26 100644
--- a/commands/history/import.go
+++ b/commands/history/import.go
@@ -119,8 +119,8 @@ func importCmd(dockerCli command.Cli, _ RootOptions) *cobra.Command {
var options importOptions
cmd := &cobra.Command{
- Use: "import [OPTIONS] < bundle.dockerbuild",
- Short: "Import a build into Docker Desktop",
+ Use: "import [OPTIONS] -",
+ Short: "Import build records into Docker Desktop",
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
return runImport(cmd.Context(), dockerCli, options)
diff --git a/commands/history/inspect.go b/commands/history/inspect.go
index 0704e2f6ad28..c4546084fff0 100644
--- a/commands/history/inspect.go
+++ b/commands/history/inspect.go
@@ -648,7 +648,7 @@ func inspectCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
cmd := &cobra.Command{
Use: "inspect [OPTIONS] [REF]",
- Short: "Inspect a build",
+ Short: "Inspect a build record",
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
diff --git a/commands/history/inspect_attachment.go b/commands/history/inspect_attachment.go
index 71f7ec7a0858..8fb01191dfdb 100644
--- a/commands/history/inspect_attachment.go
+++ b/commands/history/inspect_attachment.go
@@ -113,7 +113,7 @@ func attachmentCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
cmd := &cobra.Command{
Use: "attachment [OPTIONS] REF [DIGEST]",
- Short: "Inspect a build attachment",
+ Short: "Inspect a build record attachment",
Args: cobra.RangeArgs(1, 2),
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
diff --git a/commands/history/logs.go b/commands/history/logs.go
index bd58ba9e6a94..98b4895f629d 100644
--- a/commands/history/logs.go
+++ b/commands/history/logs.go
@@ -98,7 +98,7 @@ func logsCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
cmd := &cobra.Command{
Use: "logs [OPTIONS] [REF]",
- Short: "Print the logs of a build",
+ Short: "Print the logs of a build record",
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
diff --git a/commands/history/ls.go b/commands/history/ls.go
index c902a3434629..f6135164f46f 100644
--- a/commands/history/ls.go
+++ b/commands/history/ls.go
@@ -107,7 +107,7 @@ func lsCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
var options lsOptions
cmd := &cobra.Command{
- Use: "ls",
+ Use: "ls [OPTIONS]",
Short: "List build records",
Args: cli.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
diff --git a/commands/history/open.go b/commands/history/open.go
index 8bab4b8f8af8..aa047b29fa8f 100644
--- a/commands/history/open.go
+++ b/commands/history/open.go
@@ -57,7 +57,7 @@ func openCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
cmd := &cobra.Command{
Use: "open [OPTIONS] [REF]",
- Short: "Open a build in Docker Desktop",
+ Short: "Open a build record in Docker Desktop",
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
diff --git a/commands/history/trace.go b/commands/history/trace.go
index d1e04ad0cde9..1e2b0f1ba775 100644
--- a/commands/history/trace.go
+++ b/commands/history/trace.go
@@ -222,7 +222,7 @@ func traceCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
flags := cmd.Flags()
flags.StringVar(&options.addr, "addr", "127.0.0.1:0", "Address to bind the UI server")
- flags.StringVar(&options.compare, "compare", "", "Compare with another build reference")
+ flags.StringVar(&options.compare, "compare", "", "Compare with another build record")
return cmd
}
diff --git a/commands/imagetools/create.go b/commands/imagetools/create.go
index fee838c64f73..4ca733738550 100644
--- a/commands/imagetools/create.go
+++ b/commands/imagetools/create.go
@@ -274,7 +274,7 @@ func createCmd(dockerCli command.Cli, opts RootOptions) *cobra.Command {
var options createOptions
cmd := &cobra.Command{
- Use: "create [OPTIONS] [SOURCE] [SOURCE...]",
+ Use: "create [OPTIONS] [SOURCE...]",
Short: "Create a new image based on source images",
RunE: func(cmd *cobra.Command, args []string) error {
options.builder = *opts.Builder
diff --git a/commands/rm.go b/commands/rm.go
index cabbe9aa5dfd..fd3f2143fdb6 100644
--- a/commands/rm.go
+++ b/commands/rm.go
@@ -99,7 +99,7 @@ func rmCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
var options rmOptions
cmd := &cobra.Command{
- Use: "rm [OPTIONS] [NAME] [NAME...]",
+ Use: "rm [OPTIONS] [NAME...]",
Short: "Remove one or more builder instances",
RunE: func(cmd *cobra.Command, args []string) error {
options.builders = []string{rootOpts.builder}
diff --git a/docs/reference/buildx_dial-stdio.md b/docs/reference/buildx_dial-stdio.md
index 7fdc84ec0fe4..b7c0a290286e 100644
--- a/docs/reference/buildx_dial-stdio.md
+++ b/docs/reference/buildx_dial-stdio.md
@@ -1,5 +1,9 @@
# docker buildx dial-stdio
+```text
+docker buildx dial-stdio [OPTIONS] < in.fifo > out.fifo &
+```
+
Proxy current stdio streams to builder instance
@@ -17,13 +21,15 @@ Proxy current stdio streams to builder instance
## Description
-dial-stdio uses the stdin and stdout streams of the command to proxy to the configured builder instance.
-It is not intended to be used by humans, but rather by other tools that want to interact with the builder instance via BuildKit API.
+dial-stdio uses the stdin and stdout streams of the command to proxy to the
+configured builder instance. It is not intended to be used by humans, but
+rather by other tools that want to interact with the builder instance via
+BuildKit API.
## Examples
Example go program that uses the dial-stdio command wire up a buildkit client.
-This is for example use only and may not be suitable for production use.
+This is, for example, use only and may not be suitable for production use.
```go
client.New(ctx, "", client.WithContextDialer(func(context.Context, string) (net.Conn, error) {
@@ -45,4 +51,4 @@ client.New(ctx, "", client.WithContextDialer(func(context.Context, string) (net.
return c2
}))
-```
\ No newline at end of file
+```
diff --git a/docs/reference/buildx_du.md b/docs/reference/buildx_du.md
index 684f717a2e09..298782726cde 100644
--- a/docs/reference/buildx_du.md
+++ b/docs/reference/buildx_du.md
@@ -1,7 +1,7 @@
# buildx du
```text
-docker buildx du
+docker buildx du [OPTIONS]
```
diff --git a/docs/reference/buildx_history.md b/docs/reference/buildx_history.md
index ef0cf8b1dc6b..c7f3d064f881 100644
--- a/docs/reference/buildx_history.md
+++ b/docs/reference/buildx_history.md
@@ -1,20 +1,24 @@
# docker buildx history
+```text
+docker buildx history [OPTIONS] COMMAND
+```
+
Commands to work on build records
### Subcommands
-| Name | Description |
-|:---------------------------------------|:-----------------------------------------------|
-| [`export`](buildx_history_export.md) | Export a build into Docker Desktop bundle |
-| [`import`](buildx_history_import.md) | Import a build into Docker Desktop |
-| [`inspect`](buildx_history_inspect.md) | Inspect a build |
-| [`logs`](buildx_history_logs.md) | Print the logs of a build |
-| [`ls`](buildx_history_ls.md) | List build records |
-| [`open`](buildx_history_open.md) | Open a build in Docker Desktop |
-| [`rm`](buildx_history_rm.md) | Remove build records |
-| [`trace`](buildx_history_trace.md) | Show the OpenTelemetry trace of a build record |
+| Name | Description |
+|:---------------------------------------|:------------------------------------------------|
+| [`export`](buildx_history_export.md) | Export build records into Docker Desktop bundle |
+| [`import`](buildx_history_import.md) | Import build records into Docker Desktop |
+| [`inspect`](buildx_history_inspect.md) | Inspect a build record |
+| [`logs`](buildx_history_logs.md) | Print the logs of a build record |
+| [`ls`](buildx_history_ls.md) | List build records |
+| [`open`](buildx_history_open.md) | Open a build record in Docker Desktop |
+| [`rm`](buildx_history_rm.md) | Remove build records |
+| [`trace`](buildx_history_trace.md) | Show the OpenTelemetry trace of a build record |
### Options
diff --git a/docs/reference/buildx_history_export.md b/docs/reference/buildx_history_export.md
index ab8a1ff8cd7e..ae394077769d 100644
--- a/docs/reference/buildx_history_export.md
+++ b/docs/reference/buildx_history_export.md
@@ -1,7 +1,7 @@
# docker buildx history export
-Export a build into Docker Desktop bundle
+Export build records into Docker Desktop bundle
### Options
@@ -23,59 +23,57 @@ Desktop or shared across environments.
## Examples
-### Export a single build to a custom file (--output)
+### Export all build records to a file (--all)
+
+Use the `--all` flag and redirect the output:
```console
-docker buildx history export qu2gsuo8ejqrwdfii23xkkckt --output mybuild.dockerbuild
+docker buildx history export --all > all-builds.dockerbuild
```
-You can find build IDs by running:
+Or use the `--output` flag:
```console
-docker buildx history ls
+docker buildx history export --all -o all-builds.dockerbuild
```
-### Export multiple builds to individual `.dockerbuild` files (-o)
-
-To export two builds to separate files:
+### Use a specific builder instance (--builder)
```console
-# Using build IDs
-docker buildx history export qu2gsuo8ejqrwdfii23xkkckt qsiifiuf1ad9pa9qvppc0z1l3 -o multi.dockerbuild
-
-# Or using relative offsets
-docker buildx history export ^1 ^2 -o multi.dockerbuild
+docker buildx history export --builder builder0 ^1 -o builder0-build.dockerbuild
```
-Or use shell redirection:
+### Enable debug logging (--debug)
```console
-docker buildx history export ^1 > mybuild.dockerbuild
-docker buildx history export ^2 > backend-build.dockerbuild
+docker buildx history export --debug qu2gsuo8ejqrwdfii23xkkckt -o debug-build.dockerbuild
```
-### Export all build records to a file (--all)
-
-Use the `--all` flag and redirect the output:
+### Export a single build to a custom file (--output)
```console
-docker buildx history export --all > all-builds.dockerbuild
+docker buildx history export qu2gsuo8ejqrwdfii23xkkckt --output mybuild.dockerbuild
```
-Or use the `--output` flag:
+You can find build IDs by running:
```console
-docker buildx history export --all -o all-builds.dockerbuild
+docker buildx history ls
```
-### Use a specific builder instance (--builder)
+To export two builds to separate files:
```console
-docker buildx history export --builder builder0 ^1 -o builder0-build.dockerbuild
+# Using build IDs
+docker buildx history export qu2gsuo8ejqrwdfii23xkkckt qsiifiuf1ad9pa9qvppc0z1l3 -o multi.dockerbuild
+
+# Or using relative offsets
+docker buildx history export ^1 ^2 -o multi.dockerbuild
```
-### Enable debug logging (--debug)
+Or use shell redirection:
```console
-docker buildx history export --debug qu2gsuo8ejqrwdfii23xkkckt -o debug-build.dockerbuild
-```
\ No newline at end of file
+docker buildx history export ^1 > mybuild.dockerbuild
+docker buildx history export ^2 > backend-build.dockerbuild
+```
diff --git a/docs/reference/buildx_history_import.md b/docs/reference/buildx_history_import.md
index cc145ea0094b..1d2c06d04cbc 100644
--- a/docs/reference/buildx_history_import.md
+++ b/docs/reference/buildx_history_import.md
@@ -1,7 +1,11 @@
# docker buildx history import
+```text
+docker buildx history import [OPTIONS] -
+```
+
-Import a build into Docker Desktop
+Import build records into Docker Desktop
### Options
diff --git a/docs/reference/buildx_history_inspect.md b/docs/reference/buildx_history_inspect.md
index 942e1a3f6a3b..dcc202800fae 100644
--- a/docs/reference/buildx_history_inspect.md
+++ b/docs/reference/buildx_history_inspect.md
@@ -1,13 +1,17 @@
# docker buildx history inspect
+```text
+docker buildx history inspect [OPTIONS] [REF|COMMAND]
+```
+
-Inspect a build
+Inspect a build record
### Subcommands
-| Name | Description |
-|:-----------------------------------------------------|:---------------------------|
-| [`attachment`](buildx_history_inspect_attachment.md) | Inspect a build attachment |
+| Name | Description |
+|:-----------------------------------------------------|:----------------------------------|
+| [`attachment`](buildx_history_inspect_attachment.md) | Inspect a build record attachment |
### Options
@@ -74,7 +78,7 @@ docker buildx history inspect ^1
The formatting options (`--format`) pretty-prints the output to `pretty` (default),
`json` or using a Go template.
-**Pretty output**
+#### Pretty output
```console
$ docker buildx history inspect
@@ -105,7 +109,8 @@ sha256:217329d2af959d4f02e3a96dcbe62bf100cab1feb8006a047ddfe51a5397f7e3
Print build logs: docker buildx history logs g9808bwrjrlkbhdamxklx660b
```
-**JSON output**
+
+#### JSON output
```console
$ docker buildx history inspect --format json
@@ -160,7 +165,7 @@ $ docker buildx history inspect --format json
}
```
-**Go template output**
+#### Go template output
```console
$ docker buildx history inspect --format "{{.Name}}: {{.VCSRepository}} ({{.VCSRevision}})"
diff --git a/docs/reference/buildx_history_inspect_attachment.md b/docs/reference/buildx_history_inspect_attachment.md
index 6014e924d205..d4a4deb40090 100644
--- a/docs/reference/buildx_history_inspect_attachment.md
+++ b/docs/reference/buildx_history_inspect_attachment.md
@@ -1,7 +1,11 @@
# docker buildx history inspect attachment
+```text
+docker buildx history inspect attachment [OPTIONS] REF [DIGEST]
+```
+
-Inspect a build attachment
+Inspect a build record attachment
### Options
diff --git a/docs/reference/buildx_history_logs.md b/docs/reference/buildx_history_logs.md
index 212b43ccd25a..4f27c19b18c0 100644
--- a/docs/reference/buildx_history_logs.md
+++ b/docs/reference/buildx_history_logs.md
@@ -1,7 +1,11 @@
# docker buildx history logs
+```text
+docker buildx history logs [OPTIONS] [REF]
+```
+
-Print the logs of a build
+Print the logs of a build record
### Options
diff --git a/docs/reference/buildx_history_ls.md b/docs/reference/buildx_history_ls.md
index 88a7ce34f066..9f27d238df12 100644
--- a/docs/reference/buildx_history_ls.md
+++ b/docs/reference/buildx_history_ls.md
@@ -1,5 +1,9 @@
# docker buildx history ls
+```text
+docker buildx history ls [OPTIONS]
+```
+
List build records
@@ -45,10 +49,10 @@ docker buildx history ls --filter status=error
You can filter the list using the `--filter` flag. Supported filters include:
-| Filter | Supported comparisons | Example |
-|:-------|:----------------------|:--------|
-| `ref`, `repository`, `status` | Support `=` and `!=` comparisons | `--filter status!=success` |
-| `startedAt`, `completedAt`, `duration` | Support `<` and `>` comparisons with time values | `--filter duration>30s` |
+| Filter | Supported comparisons | Example |
+|:---------------------------------------|:-------------------------------------------------|:---------------------------|
+| `ref`, `repository`, `status` | Support `=` and `!=` comparisons | `--filter status!=success` |
+| `startedAt`, `completedAt`, `duration` | Support `<` and `>` comparisons with time values | `--filter duration>30s` |
You can combine multiple filters by repeating the `--filter` flag:
@@ -70,7 +74,7 @@ docker buildx history ls --no-trunc
### Format output (--format)
-**JSON output**
+#### JSON output
```console
$ docker buildx history ls --format json
@@ -92,7 +96,7 @@ $ docker buildx history ls --format json
]
```
-**Go template output**
+#### Go template output
```console
$ docker buildx history ls --format '{{.Name}} - {{.Duration}}'
diff --git a/docs/reference/buildx_history_open.md b/docs/reference/buildx_history_open.md
index e0817b419555..0dc19702dad9 100644
--- a/docs/reference/buildx_history_open.md
+++ b/docs/reference/buildx_history_open.md
@@ -1,7 +1,11 @@
# docker buildx history open
+```text
+docker buildx history open [OPTIONS] [REF]
+```
+
-Open a build in Docker Desktop
+Open a build record in Docker Desktop
### Options
diff --git a/docs/reference/buildx_history_rm.md b/docs/reference/buildx_history_rm.md
index dedf1a0ca68b..deb922f99e52 100644
--- a/docs/reference/buildx_history_rm.md
+++ b/docs/reference/buildx_history_rm.md
@@ -1,5 +1,9 @@
# docker buildx history rm
+```text
+docker buildx history rm [OPTIONS] [REF...]
+```
+
Remove build records
@@ -7,7 +11,7 @@ Remove build records
| Name | Type | Default | Description |
|:----------------|:---------|:--------|:-----------------------------------------|
-| `--all` | `bool` | | Remove all build records |
+| [`--all`](#all) | `bool` | | Remove all build records |
| `--builder` | `string` | | Override the configured builder instance |
| `-D`, `--debug` | `bool` | | Enable debug logging |
@@ -42,7 +46,7 @@ docker buildx history rm qu2gsuo8ejqrwdfii23xkkckt qsiifiuf1ad9pa9qvppc0z1l3
docker buildx history rm ^1 ^2
```
-### Remove all build records from the current builder
+### Remove all build records from the current builder (--all)
```console
docker buildx history rm --all
diff --git a/docs/reference/buildx_history_trace.md b/docs/reference/buildx_history_trace.md
index 2b44814542b5..4b7f4dac4130 100644
--- a/docs/reference/buildx_history_trace.md
+++ b/docs/reference/buildx_history_trace.md
@@ -1,5 +1,9 @@
# docker buildx history trace
+```text
+docker buildx history trace [OPTIONS] [REF]
+```
+
Show the OpenTelemetry trace of a build record
@@ -9,7 +13,7 @@ Show the OpenTelemetry trace of a build record
|:------------------------|:---------|:--------------|:-----------------------------------------|
| [`--addr`](#addr) | `string` | `127.0.0.1:0` | Address to bind the UI server |
| `--builder` | `string` | | Override the configured builder instance |
-| [`--compare`](#compare) | `string` | | Compare with another build reference |
+| [`--compare`](#compare) | `string` | | Compare with another build record |
| `-D`, `--debug` | `bool` | | Enable debug logging |
diff --git a/docs/reference/buildx_imagetools_create.md b/docs/reference/buildx_imagetools_create.md
index d937d5d7c475..4e74b03a6fcd 100644
--- a/docs/reference/buildx_imagetools_create.md
+++ b/docs/reference/buildx_imagetools_create.md
@@ -1,7 +1,7 @@
# buildx imagetools create
```text
-docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]
+docker buildx imagetools create [OPTIONS] [SOURCE...]
```
diff --git a/docs/reference/buildx_ls.md b/docs/reference/buildx_ls.md
index 63f442f211ca..1b0d89a0e9cc 100644
--- a/docs/reference/buildx_ls.md
+++ b/docs/reference/buildx_ls.md
@@ -1,7 +1,7 @@
# buildx ls
```text
-docker buildx ls
+docker buildx ls [OPTIONS]
```
diff --git a/docs/reference/buildx_prune.md b/docs/reference/buildx_prune.md
index e86b3021538f..f23385abd969 100644
--- a/docs/reference/buildx_prune.md
+++ b/docs/reference/buildx_prune.md
@@ -1,7 +1,7 @@
# buildx prune
```text
-docker buildx prune
+docker buildx prune [OPTIONS]
```
diff --git a/docs/reference/buildx_rm.md b/docs/reference/buildx_rm.md
index bcb856e7bdf3..996bacd57daf 100644
--- a/docs/reference/buildx_rm.md
+++ b/docs/reference/buildx_rm.md
@@ -1,7 +1,7 @@
# buildx rm
```text
-docker buildx rm [OPTIONS] [NAME] [NAME...]
+docker buildx rm [OPTIONS] [NAME...]
```
diff --git a/docs/reference/buildx_stop.md b/docs/reference/buildx_stop.md
index dcf0430a9f3e..6493f8551629 100644
--- a/docs/reference/buildx_stop.md
+++ b/docs/reference/buildx_stop.md
@@ -1,6 +1,6 @@
# buildx stop
-```
+```text
docker buildx stop [NAME]
```
diff --git a/docs/reference/buildx_use.md b/docs/reference/buildx_use.md
index 6cd1652f7049..bf8bb97fdb37 100644
--- a/docs/reference/buildx_use.md
+++ b/docs/reference/buildx_use.md
@@ -1,6 +1,6 @@
# buildx use
-```
+```text
docker buildx use [OPTIONS] NAME
```