feat(cmd): Add missing examples and slightly reword

Signed-off-by: Cezar Craciunoiu <[email protected]>

Author: craciunoiuc

internal/cmd/build.go

@@ -38,7 +38,7 @@ func (BuildCmd) Examples() []kingkong.Example {
 			},
 		},
 		{
-			Description: "Build and publish an image from a Kraftfile",
+			Description: "Build and publish an image to a registry",
 			Commands: []string{
 				"unikraft build . --output my-org/my-app:latest",
 			},
@@ -49,6 +49,12 @@ func (BuildCmd) Examples() []kingkong.Example {
 				"unikraft build ./app --build-arg VERSION=1.2.3 --build-arg COMMIT=abc123",
 			},
 		},
+		{
+			Description: "Build without using cache",
+			Commands: []string{
+				"unikraft build . --no-cache",
+			},
+		},
 		{
 			Description: "Build with secret and SSH access",
 			Commands: []string{

internal/cmd/certificates.go

@@ -278,30 +278,36 @@ func (Certificate) Examples() map[cmd.CmdType][]kingkong.Example {
 	return map[cmd.CmdType][]kingkong.Example{
 		cmd.CmdTypeGet: {
 			{
-				Description: "Get a certificate by name or UUID",
+				Description: "Inspect a certificate by name or UUID",
 				Commands:    []string{"unikraft certificate get demo-cert"},
 			},
+			{
+				Description: "Inspect a certificate in a specific metro",
+				Commands:    []string{"unikraft certificate get fra/demo-cert"},
+			},
+			{
+				Description: "Show certificate details in JSON format",
+				Commands:    []string{"unikraft certificate get demo-cert -o json"},
+			},
 		},
 		cmd.CmdTypeList: {
 			{
-				Description: "List all certificates",
+				Description: "List all certificates across metros",
 				Commands:    []string{"unikraft certificate list"},
 			},
+			{
+				Description: "List certificates and watch for changes",
+				Commands:    []string{"unikraft certificate list -w"},
+			},
 		},
 		cmd.CmdTypeCreate: {
 			{
-				Description: "Create a new certificate",
+				Description: "Create a self-signed certificate and upload it",
 				Commands: []string{
 					`openssl req -x509 -newkey rsa:2048 -sha256 -days 365 -nodes \
   -subj "/CN=demo.unikraft.dev" \
   -keyout cert.key \
   -out cert.pem`,
-					// `unikraft certificate create \
-					//   --set name=demo-cert \
-					//   --set cn=demo.unikraft.dev. \
-					//   --set-file chain=cert.pem \
-					//   --set-file pkey=cert.key \
-					//   --set metro=fra`,
 					`unikraft certificate create \
 	  --name demo-cert \
 	  --cn demo.unikraft.dev. \
@@ -310,12 +316,27 @@ func (Certificate) Examples() map[cmd.CmdType][]kingkong.Example {
 	  --metro fra`,
 				},
 			},
+			{
+				Description: "Preview certificate creation without applying",
+				Commands: []string{
+					`unikraft certificate create \
+	  --cn example.com. \
+	  --chain cert.pem \
+	  --pkey cert.key \
+	  --metro sfo \
+	  --dry-run`,
+				},
+			},
 		},
 		cmd.CmdTypeDelete: {
 			{
-				Description: "Delete a certificate by name or UUID",
+				Description: "Delete a certificate by name",
 				Commands:    []string{"unikraft certificate delete demo-cert"},
 			},
+			{
+				Description: "Delete all certificates (with confirmation prompt)",
+				Commands:    []string{"unikraft certificate delete --all"},
+			},
 		},
 	}
 }

internal/cmd/config.go

@@ -83,6 +83,14 @@ func (Config) Examples() map[cmd.CmdType][]kingkong.Example {
 				Description: "Show the current configuration",
 				Commands:    []string{"unikraft config get"},
 			},
+			{
+				Description: "Show config from a specific file",
+				Commands:    []string{"unikraft config get /path/to/config.yaml"},
+			},
+			{
+				Description: "Show a specific field in JSON format",
+				Commands:    []string{"unikraft config get -f profiles -o json"},
+			},
 		},
 	}
 }

internal/cmd/images.go

@@ -224,6 +224,14 @@ func (Image) Examples() map[cmd.CmdType][]kingkong.Example {
 				Description: "Inspect an image by tag",
 				Commands:    []string{"unikraft image get nginx:latest"},
 			},
+			{
+				Description: "Show image details in JSON format",
+				Commands:    []string{"unikraft image get nginx:latest -o json"},
+			},
+			{
+				Description: "Show all image fields including kernel and initrd info",
+				Commands:    []string{"unikraft image get my-app:v1.0 -f +kernel,+initrd"},
+			},
 		},
 		cmd.CmdTypeList: {
 			{
@@ -234,6 +242,10 @@ func (Image) Examples() map[cmd.CmdType][]kingkong.Example {
 				Description: "Filter images by reference",
 				Commands:    []string{`unikraft image list --filter 'ref~="/nginx"'`},
 			},
+			{
+				Description: "List images in table format",
+				Commands:    []string{"unikraft image list -o table"},
+			},
 		},
 		cmd.CmdTypeDelete: {
 			{
@@ -648,23 +660,29 @@ type ImagesCopyCmd struct {
 func (cmd ImagesCopyCmd) Examples() []kingkong.Example {
 	return []kingkong.Example{
 		{
-			Description: "Create a copy of an image",
+			Description: "Copy an official image to your namespace",
 			Commands: []string{
-				"unikraft image copy unikraft.io/official/nginx:latest unikraft.io/my-user/my-nginx",
+				"unikraft image copy unikraft.io/official/nginx:latest unikraft.io/my-user/my-nginx:latest",
 			},
 		},
 		{
-			Description: "Upload a local image to a remote registry",
+			Description: "Upload a local OCI archive to a remote registry",
 			Commands: []string{
 				"unikraft image copy ./my-local-image.tar unikraft.io/my-user/my-image:1.0.0",
 			},
 		},
 		{
-			Description: "Download an image from a remote registry",
+			Description: "Download an image to a local archive",
 			Commands: []string{
 				"unikraft image copy unikraft.io/official/redis:latest ./my-redis-image.tar",
 			},
 		},
+		{
+			Description: "Tag an image with a new version",
+			Commands: []string{
+				"unikraft image copy unikraft.io/my-user/my-app:latest unikraft.io/my-user/my-app:v2.0",
+			},
+		},
 	}
 }
 

internal/cmd/instance_templates.go

@@ -412,27 +412,45 @@ func (InstanceTemplate) Examples() map[cmd.CmdType][]kingkong.Example {
 	return map[cmd.CmdType][]kingkong.Example{
 		cmd.CmdTypeGet: {
 			{
-				Description: "Inspect an instance template by name or UUID",
+				Description: "Inspect an instance template by name",
 				Commands:    []string{"unikraft instance template get demo-template"},
 			},
+			{
+				Description: "Show template details in JSON format",
+				Commands:    []string{"unikraft instance template get demo-template -o json"},
+			},
 		},
 		cmd.CmdTypeList: {
 			{
 				Description: "List instance templates across metros",
 				Commands:    []string{"unikraft instance template list"},
 			},
+			{
+				Description: "List templates in table format",
+				Commands:    []string{"unikraft instance template list -o table"},
+			},
 		},
 		cmd.CmdTypeCreate: {
 			{
 				Description: "Convert a stopped instance into a template",
 				Commands:    []string{"unikraft instance template create demo-instance"},
 			},
+			{
+				Description: "Convert multiple instances into templates",
+				Commands:    []string{"unikraft instance template create instance-1 instance-2"},
+			},
 		},
 		cmd.CmdTypeEdit: {
 			{
 				Description: "Update template tags",
 				Commands: []string{
-					"unikraft instance template edit demo-template --set tags=env-dev",
+					"unikraft instance template edit demo-template --tags env-prod,team-platform",
+				},
+			},
+			{
+				Description: "Lock a template to prevent deletion",
+				Commands: []string{
+					"unikraft instance template edit demo-template --delete-lock",
 				},
 			},
 		},
@@ -441,6 +459,10 @@ func (InstanceTemplate) Examples() map[cmd.CmdType][]kingkong.Example {
 				Description: "Delete an instance template",
 				Commands:    []string{"unikraft instance template delete demo-template"},
 			},
+			{
+				Description: "Delete all instance templates (with confirmation)",
+				Commands:    []string{"unikraft instance template delete --all"},
+			},
 		},
 	}
 }