Add shell completion instructions for vm command in README.md

Author: subpop

README.md

@@ -126,6 +126,69 @@ This boots a Fedora Cloud rescue system with the target VM's disk attached as `/
 
 On first run, a rescue image is downloaded and set up (~500MB download). The `rescue` use is logged in automatically, however both the `rescue` and `root` user have their passwords set to `rescue`.
 
+## Shell completion
+
+`vm` supports tab-completion for subcommands, options, and VM names. Generate a completion script for your shell and source it (or install it in your shell’s completion directory).
+
+### Generate the script
+
+```bash
+# Auto-detect shell
+vm --generate-completion-script
+
+# Or specify the shell explicitly
+vm --generate-completion-script bash
+vm --generate-completion-script zsh
+vm --generate-completion-script fish
+```
+
+### Bash
+
+Append the generated script to your `~/.bashrc` or load it once:
+
+```bash
+vm --generate-completion-script bash >> ~/.bashrc
+# then start a new shell, or:
+source ~/.bashrc
+```
+
+Or install to a completions directory (e.g. on macOS with Homebrew bash):
+
+```bash
+vm --generate-completion-script bash > $(brew --prefix)/etc/bash_completion.d/vm
+```
+
+### Zsh
+
+Load the script from your `.zshrc`:
+
+```bash
+# Add to ~/.zshrc
+source <(vm --generate-completion-script zsh)
+```
+
+Or install for all users (e.g. into a site-functions directory):
+
+```bash
+vm --generate-completion-script zsh > /usr/local/share/zsh/site-functions/_vm
+```
+
+With oh-my-zsh, put the script in your completions folder:
+
+```bash
+vm --generate-completion-script zsh > ~/.oh-my-zsh/completions/_vm
+```
+
+### Fish
+
+Save the script to Fish’s completions directory:
+
+```bash
+vm --generate-completion-script fish > ~/.config/fish/completions/vm.fish
+```
+
+Start a new shell or run `fish_update_completions` so Fish picks it up.
+
 ## VM Storage
 
 VMs are stored in `~/.vm/` with each VM in its own directory:

Sources/VM/Commands/Attach.swift

@@ -16,7 +16,7 @@ struct Attach: AsyncParsableCommand {
         aliases: ["console"]
     )
 
-    @Argument(help: "Name of the virtual machine to attach to")
+    @Argument(help: "Name of the virtual machine to attach to", completion: VMNameCompletion.kind)
     var name: String
 
     @MainActor

Sources/VM/Commands/Delete.swift

@@ -18,7 +18,7 @@ struct Delete: AsyncParsableCommand {
             """
     )
 
-    @Argument(help: "Name of the virtual machine to delete")
+    @Argument(help: "Name of the virtual machine to delete", completion: VMNameCompletion.kind)
     var name: String
 
     @Flag(name: .shortAndLong, help: "Skip confirmation prompt")

Sources/VM/Commands/Edit.swift

@@ -16,7 +16,7 @@ struct Edit: AsyncParsableCommand {
             """
     )
 
-    @Argument(help: "Name of the virtual machine")
+    @Argument(help: "Name of the virtual machine", completion: VMNameCompletion.kind)
     var name: String
 
     @Option(name: .long, help: "Number of CPU cores")

Sources/VM/Commands/IP.swift

@@ -19,7 +19,7 @@ struct IP: AsyncParsableCommand {
         shouldDisplay: false
     )
 
-    @Argument(help: "Name of the virtual machine")
+    @Argument(help: "Name of the virtual machine", completion: VMNameCompletion.kind)
     var name: String
 
     mutating func run() async throws {

Sources/VM/Commands/Info.swift

@@ -70,7 +70,7 @@ struct Info: AsyncParsableCommand {
             """
     )
 
-    @Argument(help: "Name of the virtual machine")
+    @Argument(help: "Name of the virtual machine", completion: VMNameCompletion.kind)
     var name: String
 
     @Option(help: "Output format")

Sources/VM/Commands/RegenCloudInitISO.swift

@@ -19,7 +19,7 @@ struct RegenCloudInitISO: AsyncParsableCommand {
         shouldDisplay: false
     )
 
-    @Argument(help: "Name of the virtual machine")
+    @Argument(help: "Name of the virtual machine", completion: VMNameCompletion.kind)
     var name: String
 
     @MainActor

Sources/VM/Commands/Rescue.swift

@@ -93,7 +93,7 @@ struct Rescue: AsyncParsableCommand {
             """
     )
 
-    @Argument(help: "Name of the virtual machine to rescue")
+    @Argument(help: "Name of the virtual machine to rescue", completion: VMNameCompletion.kind)
     var name: String
 
     @Flag(name: .long, help: "Force re-download and setup of rescue VM")

Sources/VM/Commands/Resize.swift

@@ -17,7 +17,7 @@ struct Resize: AsyncParsableCommand {
             """
     )
 
-    @Argument(help: "Name of the virtual machine")
+    @Argument(help: "Name of the virtual machine", completion: VMNameCompletion.kind)
     var name: String
 
     @Option(name: .long, help: "New disk size (e.g., 128G, 256G, 512G)")

Sources/VM/Commands/RunDaemon.swift

@@ -12,7 +12,7 @@ struct RunDaemon: AsyncParsableCommand {
         shouldDisplay: false  // Hidden from help
     )
 
-    @Argument(help: "Name of the virtual machine to run")
+    @Argument(help: "Name of the virtual machine to run", completion: VMNameCompletion.kind)
     var name: String
 
     @Flag(name: .long, help: "Boot from ISO image (for installation)")