feat(cli): add shell completion script generation subcommand

Cargo.toml

@@ -22,6 +22,7 @@ bytes = "1.8.0"
 cbc = "0.1.2"
 chrono = "0.4.38"
 clap = "4.5.21"
+clap_complete = "4.5.45"
 colored = "3.0.0"
 colored_json = "4"
 cookie = "0.18.1"

README.md

@@ -187,6 +187,23 @@ You can view and edit it at: https://edgee.cloud/~/registry/{organization}/{comp
 
 Learn more about [running the Edgee proxy locally](./README-proxy.md).
 
+## `edgee generate-shell-completion`
+
+This command allows you to generate a script for your shell adding auto-completion for the `edgee` command.
+
+```shell
+$ edgee generate-shell-completion [SHELL]
+# supported value: bash, elvish, fish, powershell, zsh
+```
+
+You can use it by adding the following to your shell init file:
+
+```shell
+# ~/.bashrc | ~/.zshrc
+$ eval $(edgee generate-shell-completion)
+# ~/.config/fish/completions/edgee.fish
+$ edgee generate-shell-completion | source
+```
 
 ## Contributing
 If you're interested in contributing to Edgee, read our [contribution guidelines](./CONTRIBUTING.md)

crates/cli/Cargo.toml

@@ -12,6 +12,7 @@ edition.workspace = true
 [dependencies]
 anyhow.workspace = true
 clap = { workspace = true, features = ["derive", "env"] }
+clap_complete.workspace = true
 colored.workspace = true
 colored_json.workspace = true
 http.workspace = true

crates/cli/src/commands/completion.rs

@@ -0,0 +1,19 @@
+use clap_complete::Shell;
+
+setup_command! {
+    #[arg(value_enum)]
+    shell: Option<Shell>,
+}
+
+pub async fn run(opts: Options) -> anyhow::Result<()> {
+    let Some(shell) = opts.shell.or_else(Shell::from_env) else {
+        anyhow::bail!("No valid $SHELL found, you need to specify it in the command");
+    };
+
+    let mut cli = <crate::Options as clap::CommandFactory>::command();
+    let name = cli.get_name().to_owned();
+
+    clap_complete::generate(shell, &mut cli, name, &mut std::io::stdout());
+
+    Ok(())
+}

crates/cli/src/commands/mod.rs

@@ -13,4 +13,6 @@ setup_commands! {
     [cfg(not(feature = "no-self-update"))]
     /// Update the Edgee executable
     SelfUpdate(update),
+    /// Print auto-completion script for your shell init file
+    GenerateShellCompletion(completion),
 }