docs: add section for command namespaces (scaleway#4620)

remyleone · Laure-di · web-flow · commit 9672d59dda8f · 2025-03-31T09:53:46.000Z
Co-authored-by: Laure-di &lt;62625835+Laure-di@users.noreply.github.com&gt;
diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden
@@ -3,54 +3,79 @@
 USAGE:
   scw <command>
 
-AVAILABLE COMMANDS:
-  account       This API allows you to manage your Scaleway Projects
+AI COMMANDS:
+  inference     This API allows you to manage your Inference services
+
+BAREMETAL COMMANDS:
   apple-silicon Apple silicon API
-  audit-trail   This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
-  autocomplete  Autocomplete related commands
   baremetal     Elastic Metal API
-  billing       This API allows you to manage and query your Scaleway billing and consumption
-  block         This API allows you to manage your Block Storage volumes
-  cockpit       This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs
-  container     This API allows you to manage your Serverless Containers
-  dns           This API allows you to manage your domains, DNS zones and records
-  document-db   This API allows you to manage your Document Databases
-  edge-services Edge Services API
   fip           This API allows you to manage your Elastic Metal servers' flexible public IP addresses
-  function      Function as a Service API
-  help          Get help about how the CLI works
-  iam           This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources
-  inference     This API allows you to manage your Inference services
+
+COMPUTE COMMANDS:
   instance      This API allows you to manage your Instances
-  interlink     This API allows you to manage your InterLink services
-  iot           This API allows you to manage your IoT hubs and devices
-  ipam          This API allows you to manage your Scaleway IP addresses with our IP Address Management tool
-  jobs          This API allows you to manage your Serverless Jobs
-  k8s           This API allows you to manage Kubernetes Kapsule and Kosmos clusters
-  keymanager    Key Manager API
-  lb            This API allows you to manage your Scaleway Load Balancer services
   marketplace   This API allows you to find available images for use when launching a Scaleway Instance
-  mnq           These APIs allow you to manage your Messaging and Queuing NATS, Queues and Topics and Events services
+
+CONFIGURATION COMMANDS:
+  alias         Alias related commands
+  config        Config file management
+  info          Get info about current settings
+  init          Initialize the config
+  login         Login to scaleway
+
+CONTAINER COMMANDS:
+  k8s           This API allows you to manage Kubernetes Kapsule and Kosmos clusters
+  registry      This API allows you to manage your Container Registry resources
+
+COST COMMANDS:
+  billing       This API allows you to manage and query your Scaleway billing and consumption
+
+DATABASE COMMANDS:
+  document-db   This API allows you to manage your Document Databases
   mongodb       This API allows you to manage your Managed Databases for MongoDB®
-  object        Object-storage utils
   rdb           This API allows you to manage your Managed Databases for PostgreSQL and MySQL
   redis         This API allows you to manage your Managed Databases for Redis™
-  registry      This API allows you to manage your Container Registry resources
   sdb-sql       This API allows you to manage your Serverless SQL Databases
-  secret        Secret Manager API
+
+DOMAIN & WEBHOSTING COMMANDS:
+  dns           This API allows you to manage your domains, DNS zones and records
   tem           This API allows you to manage your Transactional Email services
+  webhosting    This API allows you to manage your Web Hosting services
+
+INTEGRATION COMMANDS:
+  iot           This API allows you to manage your IoT hubs and devices
+  mnq           These APIs allow you to manage your Messaging and Queuing NATS, Queues and Topics and Events services
+
+MONITORING COMMANDS:
+  audit-trail   This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
+  cockpit       This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs
+
+NETWORK COMMANDS:
+  edge-services Edge Services API
+  interlink     This API allows you to manage your InterLink services
+  ipam          This API allows you to manage your Scaleway IP addresses with our IP Address Management tool
+  lb            This API allows you to manage your Scaleway Load Balancer services
   vpc           This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks
   vpc-gw        This API allows you to manage your Public Gateways
-  webhosting    This API allows you to manage your Web Hosting services
 
-CONFIGURATION COMMANDS:
-  alias         Alias related commands
-  config        Config file management
-  info          Get info about current settings
-  init          Initialize the config
-  login         Login to scaleway
+SECURITY COMMANDS:
+  account       This API allows you to manage your Scaleway Projects
+  audit-trail   This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.
+  iam           This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources
+  keymanager    Key Manager API
+  secret        Secret Manager API
+
+SERVERLESS COMMANDS:
+  container     This API allows you to manage your Serverless Containers
+  function      Function as a Service API
+  jobs          This API allows you to manage your Serverless Jobs
+
+STORAGE COMMANDS:
+  block         This API allows you to manage your Block Storage volumes
+  object        Object-storage utils
+  registry      This API allows you to manage your Container Registry resources
 
 UTILITY COMMANDS:
+  autocomplete  Autocomplete related commands
   feedback      Send feedback to the Scaleway CLI Team!
   help          Get help about how the CLI works
   shell         Start shell mode
diff --git a/internal/namespaces/account/v3/custom.go b/internal/namespaces/account/v3/custom.go
@@ -7,5 +7,7 @@ import (
 func GetCommands() *core.Commands {
 	commands := GetGeneratedCommands()
 
+	commands.MustFind("account").Groups = []string{"security"}
+
 	return commands
 }
diff --git a/internal/namespaces/applesilicon/v1alpha1/custom.go b/internal/namespaces/applesilicon/v1alpha1/custom.go
@@ -14,6 +14,8 @@ func GetCommands() *core.Commands {
 		serverWaitCommand(),
 	))
 
+	cmds.MustFind("apple-silicon").Groups = []string{"baremetal"}
+
 	human.RegisterMarshalerFunc(applesilicon.ServerTypeCPU{}, cpuMarshalerFunc)
 	human.RegisterMarshalerFunc(applesilicon.ServerTypeDisk{}, diskMarshalerFunc)
 	human.RegisterMarshalerFunc(applesilicon.ServerTypeMemory{}, memoryMarshalerFunc)
diff --git a/internal/namespaces/audit_trail/v1alpha1/custom.go b/internal/namespaces/audit_trail/v1alpha1/custom.go
@@ -7,6 +7,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("audit-trail").Groups = []string{"security", "monitoring"}
+
 	cmds.MustFind("audit-trail", "event", "list").Override(eventListBuilder)
 
 	return cmds
diff --git a/internal/namespaces/autocomplete/autocomplete.go b/internal/namespaces/autocomplete/autocomplete.go
@@ -41,6 +41,7 @@ func autocompleteRootCommand() *core.Command {
 		Short:     `Autocomplete related commands`,
 		Long:      ``,
 		Namespace: "autocomplete",
+		Groups:    []string{"utility"},
 	}
 }
 
diff --git a/internal/namespaces/baremetal/v1/custom.go b/internal/namespaces/baremetal/v1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("baremetal").Groups = []string{"baremetal"}
+
 	cmds.Merge(core.NewCommands(
 		serverWaitCommand(),
 		serverAddFlexibleIP(),
diff --git a/internal/namespaces/billing/v2beta1/custom.go b/internal/namespaces/billing/v2beta1/custom.go
@@ -14,6 +14,8 @@ var invoiceTypeMarshalSpecs = human.EnumMarshalSpecs{
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("billing").Groups = []string{"cost"}
+
 	human.RegisterMarshalerFunc(billing.DownloadInvoiceRequestFileType("pdf"), human.EnumMarshalFunc(invoiceTypeMarshalSpecs))
 	cmds.MustFind("billing", "invoice", "download").Override(invoiceDownloadBuilder)
 	cmds.MustFind("billing", "invoice", "export").Override(invoiceExportBuilder)
diff --git a/internal/namespaces/block/v1alpha1/custom.go b/internal/namespaces/block/v1alpha1/custom.go
@@ -45,6 +45,8 @@ var (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("block").Groups = []string{"storage"}
+
 	cmds.Add(volumeWaitCommand())
 	cmds.Add(snapshotWaitCommand())
 
diff --git a/internal/namespaces/cockpit/v1/custom.go b/internal/namespaces/cockpit/v1/custom.go
@@ -7,6 +7,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("cockpit").Groups = []string{"monitoring"}
+
 	cmds.MustFind("cockpit", "token", "get").Override(cockpitTokenGetBuilder)
 
 	return cmds
diff --git a/internal/namespaces/container/v1beta1/custom.go b/internal/namespaces/container/v1beta1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("container").Groups = []string{"serverless"}
+
 	human.RegisterMarshalerFunc(container.NamespaceStatus(""), human.EnumMarshalFunc(namespaceStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(container.ContainerStatus(""), human.EnumMarshalFunc(containerStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(container.CronStatus(""), human.EnumMarshalFunc(cronStatusMarshalSpecs))
diff --git a/internal/namespaces/dedibox/v1/custom.go b/internal/namespaces/dedibox/v1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("dedibox").Groups = []string{"baremetal"}
+
 	for _, commandPath := range [][]string{
 		{"dedibox", "server", "list"},
 		{"dedibox", "service", "list"},
diff --git a/internal/namespaces/documentdb/v1beta1/custom.go b/internal/namespaces/documentdb/v1beta1/custom.go
@@ -26,6 +26,8 @@ var instanceStatusMarshalSpecs = human.EnumMarshalSpecs{
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("document-db").Groups = []string{"database"}
+
 	human.RegisterMarshalerFunc(documentdb.InstanceStatus(""), human.EnumMarshalFunc(instanceStatusMarshalSpecs))
 
 	cmds.MustFind("document-db", "engine", "list").Override(engineListBuilder)
diff --git a/internal/namespaces/domain/v2beta1/custom.go b/internal/namespaces/domain/v2beta1/custom.go
@@ -19,6 +19,8 @@ const defaultTTL = "3600"
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("dns").Groups = []string{"Domain & WebHosting"}
+
 	cmds.Merge(core.NewCommands(
 		dnsRecordAddCommand(),
 		dnsRecordSetCommand(),
diff --git a/internal/namespaces/edge_services/v1alpha1/custom.go b/internal/namespaces/edge_services/v1alpha1/custom.go
@@ -5,5 +5,7 @@ import "github.com/scaleway/scaleway-cli/v2/core"
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("edge-services").Groups = []string{"network"}
+
 	return cmds
 }
diff --git a/internal/namespaces/flexibleip/v1alpha1/custom.go b/internal/namespaces/flexibleip/v1alpha1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("fip").Groups = []string{"baremetal"}
+
 	human.RegisterMarshalerFunc(fip.FlexibleIPStatus(""), human.EnumMarshalFunc(ipStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(fip.MACAddressStatus(""), human.EnumMarshalFunc(macAddressStatusMarshalSpecs))
 
diff --git a/internal/namespaces/function/v1beta1/custom.go b/internal/namespaces/function/v1beta1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("function").Groups = []string{"serverless"}
+
 	human.RegisterMarshalerFunc(function.NamespaceStatus(""), human.EnumMarshalFunc(namespaceStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(function.FunctionStatus(""), human.EnumMarshalFunc(functionStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(function.CronStatus(""), human.EnumMarshalFunc(cronStatusMarshalSpecs))
diff --git a/internal/namespaces/help/custom.go b/internal/namespaces/help/custom.go
@@ -20,6 +20,7 @@ func helpRoot() *core.Command {
 		Short:                "Get help about how the CLI works",
 		Namespace:            "help",
 		AllowAnonymousClient: true,
+		Groups:               []string{"utility"},
 	}
 }
 
diff --git a/internal/namespaces/iam/v1alpha1/custom.go b/internal/namespaces/iam/v1alpha1/custom.go
@@ -26,6 +26,8 @@ var logActionMarshalSpecs = human.EnumMarshalSpecs{
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("iam").Groups = []string{"security"}
+
 	human.RegisterMarshalerFunc(iam.LogAction(""), human.EnumMarshalFunc(logActionMarshalSpecs))
 
 	cmds.Merge(core.NewCommands(
diff --git a/internal/namespaces/inference/v1beta1/custom.go b/internal/namespaces/inference/v1beta1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("inference").Groups = []string{"ai"}
+
 	human.RegisterMarshalerFunc(inference.DeploymentStatus(""), human.EnumMarshalFunc(deployementStateMarshalSpecs))
 
 	human.RegisterMarshalerFunc(inference.Deployment{}, DeploymentMarshalerFunc)
diff --git a/internal/namespaces/instance/v1/custom.go b/internal/namespaces/instance/v1/custom.go
@@ -44,6 +44,8 @@ func GetCommands() *core.Commands {
 	human.RegisterMarshalerFunc([]*instance.Server{}, serversMarshalerFunc)
 	human.RegisterMarshalerFunc(instance.Bootscript{}, bootscriptMarshalerFunc)
 
+	cmds.MustFind("instance").Groups = []string{"compute"}
+
 	cmds.MustFind("instance", "server", "list").Override(serverListBuilder)
 	cmds.MustFind("instance", "server", "update").Override(serverUpdateBuilder)
 	cmds.MustFind("instance", "server", "get").Override(serverGetBuilder)
diff --git a/internal/namespaces/interlink/v1beta1/custom.go b/internal/namespaces/interlink/v1beta1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("interlink").Groups = []string{"network"}
+
 	human.RegisterMarshalerFunc(interlink.BgpStatus(""), human.EnumMarshalFunc(bgpStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(interlink.LinkStatus(""), human.EnumMarshalFunc(linkStatusMarshalSpecs))
 
diff --git a/internal/namespaces/iot/v1/custom.go b/internal/namespaces/iot/v1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("iot").Groups = []string{"integration"}
+
 	human.RegisterMarshalerFunc(iot.HubStatus(""), human.EnumMarshalFunc(hubStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(iot.DeviceMessageFiltersRulePolicy(""), human.EnumMarshalFunc(deviceMessageFiltersRulePolicyMarshalSpecs))
 	human.RegisterMarshalerFunc(iot.DeviceStatus(""), human.EnumMarshalFunc(deviceStatusMarshalSpecs))
diff --git a/internal/namespaces/ipam/v1/custom.go b/internal/namespaces/ipam/v1/custom.go
@@ -5,5 +5,7 @@ import "github.com/scaleway/scaleway-cli/v2/core"
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("ipam").Groups = []string{"network"}
+
 	return cmds
 }
diff --git a/internal/namespaces/jobs/v1alpha1/custom.go b/internal/namespaces/jobs/v1alpha1/custom.go
@@ -20,6 +20,8 @@ var jobRunStateMarshalSpecs = human.EnumMarshalSpecs{
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("jobs").Groups = []string{"serverless"}
+
 	human.RegisterMarshalerFunc(jobs.JobRunState(""), human.EnumMarshalFunc(jobRunStateMarshalSpecs))
 
 	cmds.Merge(core.NewCommands(
diff --git a/internal/namespaces/k8s/v1/custom.go b/internal/namespaces/k8s/v1/custom.go
@@ -14,6 +14,9 @@ import (
 // - Apply handwritten overrides (of Command.Run)
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
+
+	cmds.MustFind("k8s").Groups = []string{"container"}
+
 	cmds.Merge(core.NewCommands(
 		k8sExecCredentialCommand(),
 		k8sKubeconfigCommand(),
diff --git a/internal/namespaces/key_manager/v1alpha1/custom.go b/internal/namespaces/key_manager/v1alpha1/custom.go
@@ -11,6 +11,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("keymanager").Groups = []string{"security"}
+
 	cmds.MustFind("keymanager", "key", "decrypt").Override(cipherDecrypt)
 	cmds.MustFind("keymanager", "key", "encrypt").Override(plaintextEncrypt)
 
diff --git a/internal/namespaces/lb/v1/custom.go b/internal/namespaces/lb/v1/custom.go
@@ -33,6 +33,8 @@ func GetCommands() *core.Commands {
 
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("lb").Groups = []string{"network"}
+
 	cmds.Add(
 		lbWaitCommand(),
 	)
diff --git a/internal/namespaces/marketplace/v2/custom.go b/internal/namespaces/marketplace/v2/custom.go
@@ -16,5 +16,7 @@ func GetCommands() *core.Commands {
 	// Update commands with custom implementation of fields
 	updateCommands(marketplaceCommands)
 
+	marketplaceCommands.MustFind("marketplace").Groups = []string{"compute"}
+
 	return marketplaceCommands
 }
diff --git a/internal/namespaces/mnq/v1beta1/custom.go b/internal/namespaces/mnq/v1beta1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("mnq").Groups = []string{"integration"}
+
 	human.RegisterMarshalerFunc(mnq.SnsInfoStatus(""), human.EnumMarshalFunc(mnqSqsInfoStatusMarshalSpecs))
 
 	cmds.MustFind("mnq", "nats", "get-account").Override(mnqNatsGetAccountBuilder)
diff --git a/internal/namespaces/mongodb/v1alpha1/custom.go b/internal/namespaces/mongodb/v1alpha1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("mongodb").Groups = []string{"database"}
+
 	human.RegisterMarshalerFunc(mongodb.SnapshotStatus(""), human.EnumMarshalFunc(snapshotStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(mongodb.InstanceStatus(""), human.EnumMarshalFunc(instanceStatusMarshalSpecs))
 	human.RegisterMarshalerFunc(mongodb.NodeTypeStock(""), human.EnumMarshalFunc(nodeTypeStockMarshalSpecs))
diff --git a/internal/namespaces/object/v1/custom_command.go b/internal/namespaces/object/v1/custom_command.go
@@ -8,6 +8,7 @@ func objectRoot() *core.Command {
 	return &core.Command{
 		Short:     `Object-storage utils`,
 		Namespace: "object",
+		Groups:    []string{"storage"},
 	}
 }
 
diff --git a/internal/namespaces/rdb/v1/custom.go b/internal/namespaces/rdb/v1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("rdb").Groups = []string{"database"}
+
 	human.RegisterMarshalerFunc(rdb.Instance{}, instanceMarshalerFunc)
 	human.RegisterMarshalerFunc(rdb.BackupSchedule{}, backupScheduleMarshalerFunc)
 	human.RegisterMarshalerFunc(backupDownloadResult{}, backupResultMarshallerFunc)
diff --git a/internal/namespaces/redis/v1/custom.go b/internal/namespaces/redis/v1/custom.go
@@ -9,6 +9,8 @@ import (
 func GetCommands() *core.Commands {
 	cmds := GetGeneratedCommands()
 
+	cmds.MustFind("redis").Groups = []string{"database"}
+
 	human.RegisterMarshalerFunc(redis.Cluster{}, redisClusterGetMarshalerFunc)
 
 	cmds.Merge(core.NewCommands(clusterWaitCommand()))
diff --git a/internal/namespaces/registry/v1/custom.go b/internal/namespaces/registry/v1/custom.go
diff --git a/internal/namespaces/secret/v1beta1/custom.go b/internal/namespaces/secret/v1beta1/custom.go
diff --git a/internal/namespaces/serverless_sqldb/v1alpha1/custom.go b/internal/namespaces/serverless_sqldb/v1alpha1/custom.go
diff --git a/internal/namespaces/tem/v1alpha1/custom.go b/internal/namespaces/tem/v1alpha1/custom.go
diff --git a/internal/namespaces/vpc/v2/custom.go b/internal/namespaces/vpc/v2/custom.go
diff --git a/internal/namespaces/vpcgw/v1/custom.go b/internal/namespaces/vpcgw/v1/custom.go
diff --git a/internal/namespaces/vpcgw/v2/custom.go b/internal/namespaces/vpcgw/v2/custom.go
diff --git a/internal/namespaces/webhosting/v1/custom.go b/internal/namespaces/webhosting/v1/custom.go

Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,7 @@ import (`
`7`	`7`	`func GetCommands() *core.Commands {`
`8`	`8`	`commands := GetGeneratedCommands()`
`9`	`9`
	`10`	`+ commands.MustFind("account").Groups = []string{"security"}`
	`11`	`+`
`10`	`12`	`return commands`
`11`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@ func autocompleteRootCommand() *core.Command {`
`41`	`41`	Short: `Autocomplete related commands`,
`42`	`42`	Long: ``,
`43`	`43`	`Namespace: "autocomplete",`
	`44`	`+ Groups: []string{"utility"},`
`44`	`45`	`}`
`45`	`46`	`}`
`46`	`47`