diff --git a/docs/reference/compose.md b/docs/reference/compose.md index 0c7e14c39..fa07fd921 100644 --- a/docs/reference/compose.md +++ b/docs/reference/compose.md @@ -7,7 +7,6 @@ Define and run multi-container applications with Docker. | Name | Description | |:--------------------------------|:------------------------------------------------------------------------| -| [`alpha`](compose_alpha.md) | Experimental commands | | [`build`](compose_build.md) | Build or rebuild services | | [`config`](compose_config.md) | Parse, resolve and render compose file in canonical format | | [`cp`](compose_cp.md) | Copy files/folders between a service container and the local filesystem | diff --git a/docs/reference/docker_compose.yaml b/docs/reference/docker_compose.yaml index 984d56888..4f7416676 100644 --- a/docs/reference/docker_compose.yaml +++ b/docs/reference/docker_compose.yaml @@ -347,6 +347,7 @@ options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_alpha.yaml b/docs/reference/docker_compose_alpha.yaml index 5921d9436..2598c0e88 100644 --- a/docs/reference/docker_compose_alpha.yaml +++ b/docs/reference/docker_compose_alpha.yaml @@ -21,6 +21,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: true experimental: false experimentalcli: true kubernetes: false diff --git a/docs/reference/docker_compose_alpha_viz.yaml b/docs/reference/docker_compose_alpha_viz.yaml index 6f4a7f4ca..b179d648e 100644 --- a/docs/reference/docker_compose_alpha_viz.yaml +++ b/docs/reference/docker_compose_alpha_viz.yaml @@ -69,6 +69,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: true kubernetes: false diff --git a/docs/reference/docker_compose_alpha_watch.yaml b/docs/reference/docker_compose_alpha_watch.yaml index 7a98477e4..6a3f5d52e 100644 --- a/docs/reference/docker_compose_alpha_watch.yaml +++ b/docs/reference/docker_compose_alpha_watch.yaml @@ -29,6 +29,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: true kubernetes: false diff --git a/docs/reference/docker_compose_build.yaml b/docs/reference/docker_compose_build.yaml index 88a487494..af758d4fb 100644 --- a/docs/reference/docker_compose_build.yaml +++ b/docs/reference/docker_compose_build.yaml @@ -159,6 +159,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_config.yaml b/docs/reference/docker_compose_config.yaml index 53078ee77..d19a786c6 100644 --- a/docs/reference/docker_compose_config.yaml +++ b/docs/reference/docker_compose_config.yaml @@ -152,6 +152,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_cp.yaml b/docs/reference/docker_compose_cp.yaml index 8ff6be355..4551c13c6 100644 --- a/docs/reference/docker_compose_cp.yaml +++ b/docs/reference/docker_compose_cp.yaml @@ -61,6 +61,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_create.yaml b/docs/reference/docker_compose_create.yaml index 030b72d3b..0e3e77d6e 100644 --- a/docs/reference/docker_compose_create.yaml +++ b/docs/reference/docker_compose_create.yaml @@ -90,6 +90,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_down.yaml b/docs/reference/docker_compose_down.yaml index 69b802f0f..8d6388129 100644 --- a/docs/reference/docker_compose_down.yaml +++ b/docs/reference/docker_compose_down.yaml @@ -73,6 +73,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_events.yaml b/docs/reference/docker_compose_events.yaml index 99e226e93..ce7af72cc 100644 --- a/docs/reference/docker_compose_events.yaml +++ b/docs/reference/docker_compose_events.yaml @@ -46,6 +46,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_exec.yaml b/docs/reference/docker_compose_exec.yaml index 9b1c37cd8..ce6faeda6 100644 --- a/docs/reference/docker_compose_exec.yaml +++ b/docs/reference/docker_compose_exec.yaml @@ -117,6 +117,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_images.yaml b/docs/reference/docker_compose_images.yaml index 7afa355d2..4719590af 100644 --- a/docs/reference/docker_compose_images.yaml +++ b/docs/reference/docker_compose_images.yaml @@ -38,6 +38,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_kill.yaml b/docs/reference/docker_compose_kill.yaml index 61360c526..213422764 100644 --- a/docs/reference/docker_compose_kill.yaml +++ b/docs/reference/docker_compose_kill.yaml @@ -43,6 +43,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_logs.yaml b/docs/reference/docker_compose_logs.yaml index f1b7bad31..3a13cb293 100644 --- a/docs/reference/docker_compose_logs.yaml +++ b/docs/reference/docker_compose_logs.yaml @@ -91,6 +91,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_ls.yaml b/docs/reference/docker_compose_ls.yaml index 68d5f1fcb..c4b6d5f7c 100644 --- a/docs/reference/docker_compose_ls.yaml +++ b/docs/reference/docker_compose_ls.yaml @@ -58,6 +58,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_pause.yaml b/docs/reference/docker_compose_pause.yaml index 24da45fda..2ae1c4027 100644 --- a/docs/reference/docker_compose_pause.yaml +++ b/docs/reference/docker_compose_pause.yaml @@ -17,6 +17,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_port.yaml b/docs/reference/docker_compose_port.yaml index d206bcbca..7c8dee90c 100644 --- a/docs/reference/docker_compose_port.yaml +++ b/docs/reference/docker_compose_port.yaml @@ -37,6 +37,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_ps.yaml b/docs/reference/docker_compose_ps.yaml index f7e8f5279..a8c76c3ca 100644 --- a/docs/reference/docker_compose_ps.yaml +++ b/docs/reference/docker_compose_ps.yaml @@ -180,6 +180,7 @@ examples: |- The `docker compose ps` command currently only supports the `--filter status=` option, but additional filter options may be added in the future. deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_pull.yaml b/docs/reference/docker_compose_pull.yaml index d7f475dd6..757f31be6 100644 --- a/docs/reference/docker_compose_pull.yaml +++ b/docs/reference/docker_compose_pull.yaml @@ -124,6 +124,7 @@ examples: |- `docker compose pull` will try to pull image for services with a build section. If pull fails, it will let user know this service image MUST be built. You can skip this by setting `--ignore-buildable` flag deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_push.yaml b/docs/reference/docker_compose_push.yaml index 82a9435c3..be7c11606 100644 --- a/docs/reference/docker_compose_push.yaml +++ b/docs/reference/docker_compose_push.yaml @@ -66,6 +66,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_restart.yaml b/docs/reference/docker_compose_restart.yaml index 055daedd1..bc907aacc 100644 --- a/docs/reference/docker_compose_restart.yaml +++ b/docs/reference/docker_compose_restart.yaml @@ -48,6 +48,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_rm.yaml b/docs/reference/docker_compose_rm.yaml index 7d8828b6a..7ddafae48 100644 --- a/docs/reference/docker_compose_rm.yaml +++ b/docs/reference/docker_compose_rm.yaml @@ -76,6 +76,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_run.yaml b/docs/reference/docker_compose_run.yaml index 2cf41ad99..d827dc339 100644 --- a/docs/reference/docker_compose_run.yaml +++ b/docs/reference/docker_compose_run.yaml @@ -286,6 +286,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_start.yaml b/docs/reference/docker_compose_start.yaml index 5f3d601a5..9a7fa379b 100644 --- a/docs/reference/docker_compose_start.yaml +++ b/docs/reference/docker_compose_start.yaml @@ -16,6 +16,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_stop.yaml b/docs/reference/docker_compose_stop.yaml index f7870be4f..f2ec34ccb 100644 --- a/docs/reference/docker_compose_stop.yaml +++ b/docs/reference/docker_compose_stop.yaml @@ -29,6 +29,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_top.yaml b/docs/reference/docker_compose_top.yaml index 67beeb8bb..7d87f7cca 100644 --- a/docs/reference/docker_compose_top.yaml +++ b/docs/reference/docker_compose_top.yaml @@ -23,6 +23,7 @@ examples: |- root 142353 142331 2 15:33 ? 00:00:00 ping localhost -c 5 ``` deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_unpause.yaml b/docs/reference/docker_compose_unpause.yaml index 522959848..2679f53f6 100644 --- a/docs/reference/docker_compose_unpause.yaml +++ b/docs/reference/docker_compose_unpause.yaml @@ -16,6 +16,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_up.yaml b/docs/reference/docker_compose_up.yaml index b59af8496..042e2b491 100644 --- a/docs/reference/docker_compose_up.yaml +++ b/docs/reference/docker_compose_up.yaml @@ -285,6 +285,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_version.yaml b/docs/reference/docker_compose_version.yaml index 2b11da2ed..b06c4b150 100644 --- a/docs/reference/docker_compose_version.yaml +++ b/docs/reference/docker_compose_version.yaml @@ -37,6 +37,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/docs/reference/docker_compose_wait.yaml b/docs/reference/docker_compose_wait.yaml index 8e5ff7eb4..87f69059c 100644 --- a/docs/reference/docker_compose_wait.yaml +++ b/docs/reference/docker_compose_wait.yaml @@ -27,6 +27,7 @@ inherited_options: kubernetes: false swarm: false deprecated: false +hidden: false experimental: false experimentalcli: false kubernetes: false diff --git a/go.mod b/go.mod index eb2364d99..6337e8446 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/distribution/distribution/v3 v3.0.0-20230601133803-97b1d649c493 github.com/docker/buildx v0.11.0 github.com/docker/cli v24.0.2+incompatible - github.com/docker/cli-docs-tool v0.5.1 + github.com/docker/cli-docs-tool v0.6.0 github.com/docker/docker v24.0.2+incompatible github.com/docker/go-connections v0.4.0 github.com/docker/go-units v0.5.0 diff --git a/go.sum b/go.sum index 7a8148dab..34c6c54b1 100644 --- a/go.sum +++ b/go.sum @@ -171,8 +171,8 @@ github.com/docker/buildx v0.11.0 h1:DNCOIYT/7J0sPBlU/ozEhFd4MtbnbFByn45yeTMHXVU= github.com/docker/buildx v0.11.0/go.mod h1:Yq7ZNjrwXKzW0uSFMk46dl5Gl903k5+bp6U4apsM5rs= github.com/docker/cli v24.0.2+incompatible h1:QdqR7znue1mtkXIJ+ruQMGQhpw2JzMJLRXp6zpzF6tM= github.com/docker/cli v24.0.2+incompatible/go.mod h1:JLrzqnKDaYBop7H2jaqPtU4hHvMKP+vjCwu2uszcLI8= -github.com/docker/cli-docs-tool v0.5.1 h1:jIk/cCZurZERhALPVKhqlNxTQGxn2kcI+56gE57PQXg= -github.com/docker/cli-docs-tool v0.5.1/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= +github.com/docker/cli-docs-tool v0.6.0 h1:Z9x10SaZgFaB6jHgz3OWooynhSa40CsWkpe5hEnG/qA= +github.com/docker/cli-docs-tool v0.6.0/go.mod h1:zMjqTFCU361PRh8apiXzeAZ1Q/xupbIwTusYpzCXS/o= github.com/docker/distribution v2.7.1+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w= github.com/docker/distribution v2.8.2+incompatible h1:T3de5rq0dB1j30rp0sA2rER+m322EBzniBPB6ZIzuh8= github.com/docker/distribution v2.8.2+incompatible/go.mod h1:J2gT2udsDAN96Uj4KfcMRqY0/ypR+oyYUYmja8H+y+w=