mark command as experimental

crazy-max · crazy-max · commit 51cf3d4e5de4 · 2025-05-16T11:46:59.000+02:00
Signed-off-by: CrazyMax &lt;1951866+crazy-max@users.noreply.github.com&gt;
diff --git a/commands/root.go b/commands/root.go
@@ -83,6 +83,8 @@ func NewRootCmd(cli *command.DockerCli) *cobra.Command {
 		TraverseChildren: plugin.RunningStandalone(),
 	}
 
+	markCommandExperimental(rootCmd)
+
 	// Initialize client options and register their flags if running in
 	// standalone mode.
 	if plugin.RunningStandalone() {
@@ -109,3 +111,16 @@ func NewRootCmd(cli *command.DockerCli) *cobra.Command {
 	)
 	return rootCmd
 }
+
+const annotationExperimentalCLI = "experimentalCLI"
+
+func markCommandExperimental(c *cobra.Command) {
+	if _, ok := c.Annotations[annotationExperimentalCLI]; ok {
+		return
+	}
+	if c.Annotations == nil {
+		c.Annotations = make(map[string]string)
+	}
+	c.Annotations[annotationExperimentalCLI] = ""
+	c.Short += " (EXPERIMENTAL)"
+}
diff --git a/docs/reference/docker_model.yaml b/docs/reference/docker_model.yaml
@@ -138,7 +138,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_compose.yaml b/docs/reference/docker_model_compose.yaml
@@ -20,7 +20,7 @@ options:
 deprecated: false
 hidden: true
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_compose_down.yaml b/docs/reference/docker_model_compose_down.yaml
@@ -26,7 +26,7 @@ inherited_options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_compose_up.yaml b/docs/reference/docker_model_compose_up.yaml
@@ -26,7 +26,7 @@ inherited_options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_inspect.yaml b/docs/reference/docker_model_inspect.yaml
@@ -18,7 +18,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_install-runner.yaml b/docs/reference/docker_model_install-runner.yaml
@@ -28,7 +28,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_list.yaml b/docs/reference/docker_model_list.yaml
@@ -40,7 +40,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_logs.yaml b/docs/reference/docker_model_logs.yaml
@@ -29,7 +29,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_package.yaml b/docs/reference/docker_model_package.yaml
@@ -38,7 +38,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_pull.yaml b/docs/reference/docker_model_pull.yaml
@@ -7,7 +7,7 @@ plink: docker_model.yaml
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_push.yaml b/docs/reference/docker_model_push.yaml
@@ -7,7 +7,7 @@ plink: docker_model.yaml
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_rm.yaml b/docs/reference/docker_model_rm.yaml
@@ -19,7 +19,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_run.yaml b/docs/reference/docker_model_run.yaml
@@ -18,7 +18,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_status.yaml b/docs/reference/docker_model_status.yaml
@@ -7,7 +7,7 @@ plink: docker_model.yaml
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_tag.yaml b/docs/reference/docker_model_tag.yaml
@@ -7,7 +7,7 @@ plink: docker_model.yaml
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_uninstall-runner.yaml b/docs/reference/docker_model_uninstall-runner.yaml
@@ -28,7 +28,7 @@ options:
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/docker_model_version.yaml b/docs/reference/docker_model_version.yaml
@@ -7,7 +7,7 @@ plink: docker_model.yaml
 deprecated: false
 hidden: false
 experimental: false
-experimentalcli: false
+experimentalcli: true
 kubernetes: false
 swarm: false
 
diff --git a/docs/reference/model.md b/docs/reference/model.md
@@ -1,7 +1,7 @@
 # docker model
 
 <!---MARKER_GEN_START-->
-Docker Model Runner
+Docker Model Runner (EXPERIMENTAL)
 
 ### Subcommands
 
