From 7c145734965c330c538ec59abcf99bcef95ddb2b Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Fri, 29 Aug 2025 15:32:15 +0900 Subject: [PATCH] install/uninstall: unhide The install/uninstall commands were introduced in PR 34 (Apr 2019) as hidden commands. These commands should no longer be hidden, as they have been explicitly documented since docker/docs PR 21641 (Dec 2024). https://docs.docker.com/build/builders/#difference-between-docker-build-and-docker-buildx-build Signed-off-by: Akihiro Suda --- commands/install.go | 1 - commands/uninstall.go | 1 - docs/reference/buildx.md | 2 ++ docs/reference/buildx_install.md | 14 ++++++++++++++ docs/reference/buildx_uninstall.md | 14 ++++++++++++++ 5 files changed, 30 insertions(+), 2 deletions(-) create mode 100644 docs/reference/buildx_install.md create mode 100644 docs/reference/buildx_uninstall.md diff --git a/commands/install.go b/commands/install.go index fbfe543822db..ef321a644654 100644 --- a/commands/install.go +++ b/commands/install.go @@ -47,7 +47,6 @@ func installCmd(dockerCli command.Cli) *cobra.Command { RunE: func(cmd *cobra.Command, args []string) error { return runInstall(dockerCli, options) }, - Hidden: true, ValidArgsFunction: completion.Disable, DisableFlagsInUseLine: true, } diff --git a/commands/uninstall.go b/commands/uninstall.go index b401dc7244aa..b61190428b0a 100644 --- a/commands/uninstall.go +++ b/commands/uninstall.go @@ -53,7 +53,6 @@ func uninstallCmd(dockerCli command.Cli) *cobra.Command { RunE: func(cmd *cobra.Command, args []string) error { return runUninstall(dockerCli, options) }, - Hidden: true, ValidArgsFunction: completion.Disable, DisableFlagsInUseLine: true, } diff --git a/docs/reference/buildx.md b/docs/reference/buildx.md index 39d2e7e6693f..8d91a8aa9c21 100644 --- a/docs/reference/buildx.md +++ b/docs/reference/buildx.md @@ -21,10 +21,12 @@ Extended build capabilities with BuildKit | [`history`](buildx_history.md) | Commands to work on build records | | [`imagetools`](buildx_imagetools.md) | Commands to work on images in registry | | [`inspect`](buildx_inspect.md) | Inspect current builder instance | +| [`install`](buildx_install.md) | Install buildx as a 'docker builder' alias | | [`ls`](buildx_ls.md) | List builder instances | | [`prune`](buildx_prune.md) | Remove build cache | | [`rm`](buildx_rm.md) | Remove one or more builder instances | | [`stop`](buildx_stop.md) | Stop builder instance | +| [`uninstall`](buildx_uninstall.md) | Uninstall the 'docker builder' alias | | [`use`](buildx_use.md) | Set the current builder instance | | [`version`](buildx_version.md) | Show buildx version information | diff --git a/docs/reference/buildx_install.md b/docs/reference/buildx_install.md new file mode 100644 index 000000000000..85f1206eff90 --- /dev/null +++ b/docs/reference/buildx_install.md @@ -0,0 +1,14 @@ +# docker buildx install + + +Install buildx as a 'docker builder' alias + +### Options + +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:---------------------| +| `-D`, `--debug` | `bool` | | Enable debug logging | + + + + diff --git a/docs/reference/buildx_uninstall.md b/docs/reference/buildx_uninstall.md new file mode 100644 index 000000000000..3d057aa2ea30 --- /dev/null +++ b/docs/reference/buildx_uninstall.md @@ -0,0 +1,14 @@ +# docker buildx uninstall + + +Uninstall the 'docker builder' alias + +### Options + +| Name | Type | Default | Description | +|:----------------|:-------|:--------|:---------------------| +| `-D`, `--debug` | `bool` | | Enable debug logging | + + + +