Add help text to cli commands

Signed-off-by: Guvenc Gulce <[email protected]>

Author: guvenc

cli/src/host_commands.rs

@@ -25,10 +25,15 @@ pub struct HostArgs {
 
 #[derive(Subcommand, Debug)]
 pub enum HostCommand {
+    /// Get the host machine's hostname
     Hostname,
+    /// Display detailed memory information from /proc/meminfo
     Memory,
+    /// Display CPU information from /proc/cpuinfo
     CpuInfo,
+    /// Display network interface statistics
     NetworkInfo,
+    /// Upgrade the FeOS binary from a remote URL
     Upgrade {
         #[arg(long, required = true, help = "URL to fetch the new FeOS binary from")]
         url: String,

cli/src/image_commands.rs

@@ -27,17 +27,24 @@ pub struct ImageArgs {
 
 #[derive(Subcommand, Debug)]
 pub enum ImageCommand {
+    /// Pull a container image from a registry
     Pull {
-        #[arg(required = true)]
+        #[arg(
+            required = true,
+            help = "Container image reference to pull (e.g., docker.io/library/ubuntu:latest)"
+        )]
         image_ref: String,
     },
+    /// List all local container images
     List,
+    /// Watch the status of an image pull operation
     Watch {
-        #[arg(required = true)]
+        #[arg(required = true, help = "UUID of the image to watch")]
         image_uuid: String,
     },
+    /// Delete a local container image
     Delete {
-        #[arg(required = true)]
+        #[arg(required = true, help = "UUID of the image to delete")]
         image_uuid: String,
     },
 }

cli/src/vm_commands.rs

@@ -33,17 +33,22 @@ pub struct VmArgs {
 
 #[derive(Subcommand, Debug)]
 pub enum VmCommand {
+    /// Create a new virtual machine with specified configuration
     Create {
-        #[arg(long, required = true)]
+        #[arg(
+            long,
+            required = true,
+            help = "Container image reference to use for the VM"
+        )]
         image_ref: String,
 
-        #[arg(long, default_value_t = 1)]
+        #[arg(long, default_value_t = 1, help = "Number of virtual CPUs to allocate")]
         vcpus: u32,
 
-        #[arg(long, default_value_t = 1024)]
+        #[arg(long, default_value_t = 1024, help = "Memory size in MiB")]
         memory: u64,
 
-        #[arg(long)]
+        #[arg(long, help = "Optional custom VM identifier")]
         vm_id: Option<String>,
 
         #[arg(
@@ -52,56 +57,75 @@ pub enum VmCommand {
         )]
         pci_device: Vec<String>,
 
-        #[arg(long)]
+        #[arg(long, help = "Enable hugepages for memory allocation")]
         hugepages: bool,
     },
+    /// Start an existing virtual machine
     Start {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Get detailed information about a virtual machine
     Info {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// List all virtual machines
     List,
+    /// Ping a virtual machine's VMM to check status
     Ping {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Gracefully shutdown a virtual machine
     Shutdown {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Pause a running virtual machine
     Pause {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Resume a paused virtual machine
     Resume {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Delete a virtual machine
     Delete {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Watch virtual machine state change events
     Events {
-        #[arg(long)]
+        #[arg(
+            long,
+            help = "VM identifier (optional, if not provided watches all VMs)"
+        )]
         vm_id: Option<String>,
     },
+    /// Connect to a virtual machine's console
     Console {
-        #[arg(required = true)]
+        #[arg(required = true, help = "VM identifier")]
         vm_id: String,
     },
+    /// Attach a disk to a running virtual machine
     AttachDisk {
-        #[arg(long, required = true)]
+        #[arg(long, required = true, help = "VM identifier")]
         vm_id: String,
-        #[arg(long, required = true)]
+        #[arg(long, required = true, help = "Path to the disk image file")]
         path: String,
     },
+    /// Remove a disk from a virtual machine
     RemoveDisk {
-        #[arg(long, required = true)]
+        #[arg(long, required = true, help = "VM identifier")]
         vm_id: String,
-        #[arg(long, required = true)]
+        #[arg(
+            long,
+            required = true,
+            help = "Device identifier of the disk to remove"
+        )]
         device_id: String,
     },
 }