[PM-3029] Add support for shell completion

crates/bws/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support for shell autocompletion with the `bws completions` command (#103)
+
 ## [0.3.0] - 2023-07-26
 
 ### Deprecated

crates/bws/Cargo.toml

@@ -22,7 +22,8 @@ chrono = { version = "0.4.26", features = [
     "clock",
     "std",
 ], default-features = false }
-clap = { version = "4.3.0", features = ["derive", "env"] }
+clap = { version = "4.3.0", features = ["derive", "env", "string"] }
+clap_complete = "4.3.2"
 color-eyre = "0.6"
 comfy-table = "^7.0.1"
 directories = "5.0.1"

crates/bws/README.md

@@ -18,5 +18,29 @@ Or download a pre-built binary from the [Releases](https://github.com/bitwarden/
 bws --help
 ```
 
+## How to enable shell autocompletions
+
+### Zsh
+
+If completion is not enabled already, you need to enable it first:
+
+```zsh
+echo "autoload -U compinit; compinit" >> ~/.zshrc
+```
+
+Enable autocompletions for the current user:
+
+```zsh
+echo 'source <(/path/to/bws completions zsh)' >> ~/.zshrc
+```
+
+### Bash
+
+Enable autocompletions for the current user:
+
+```zsh
+echo 'source <(/path/to/bws completions bash)' >> ~/.bashrc
+```
+
 For more detailed documentation, please refer to the
 [Secrets Manager CLI help article](https://bitwarden.com/help/secrets-manager-cli/).

crates/bws/src/main.rs

@@ -15,6 +15,7 @@ use bitwarden::{
     },
 };
 use clap::{ArgGroup, CommandFactory, Parser, Subcommand};
+use clap_complete::Shell;
 use color_eyre::eyre::{bail, Result};
 use log::error;
 
@@ -26,16 +27,16 @@ use render::{serialize_response, Color, Output};
 use uuid::Uuid;
 
 #[derive(Parser, Debug)]
-#[command(name = "Bitwarden Secrets CLI", version, about = "Bitwarden Secrets CLI", long_about = None)]
+#[command(name = "bws", version, about = "Bitwarden Secrets CLI", long_about = None)]
 struct Cli {
     // Optional as a workaround for https://github.com/clap-rs/clap/issues/3572
     #[command(subcommand)]
     command: Option<Commands>,
 
-    #[arg(short = 'o', long, global = true, value_enum, default_value_t = Output::JSON)]
+    #[arg(short = 'o', long, global = true, value_enum, default_value_t = Output::JSON, help="Select the output format for the commands", hide = true)]
     output: Output,
 
-    #[arg(short = 'c', long, global = true, value_enum, default_value_t = Color::Auto)]
+    #[arg(short = 'c', long, global = true, value_enum, default_value_t = Color::Auto, help="Enable or disable the use of colors in the output")]
     color: Color,
 
     #[arg(short = 't', long, global = true, env = ACCESS_TOKEN_KEY_VAR_NAME, hide_env_values = true, help="Specify access token for the service account")]
@@ -66,6 +67,10 @@ enum Commands {
         #[arg(short = 'd', long)]
         delete: bool,
     },
+
+    #[command(long_about = "Generate shell completion files")]
+    Completions { shell: Option<Shell> },
+
     #[command(long_about = "Commands available on Projects")]
     Project {
         #[command(subcommand)]
@@ -245,6 +250,18 @@ async fn process_commands() -> Result<()> {
         return Ok(());
     };
 
+    if let Commands::Completions { shell } = command {
+        let Some(shell) = shell.or_else(Shell::from_env) else {
+            eprintln!("Couldn't autodetect a valid shell. Run `bws completions --help` for more info.");
+            std::process::exit(1);
+        };
+
+        let mut cmd = Cli::command();
+        let name = cmd.get_name().to_string();
+        clap_complete::generate(shell, &mut cmd, name, &mut std::io::stdout());
+        return Ok(());
+    }
+
     // Modify profile commands
     if let Commands::Config {
         name,
@@ -577,7 +594,7 @@ async fn process_commands() -> Result<()> {
             }
         }
 
-        Commands::Config { .. } => {
+        Commands::Config { .. } | Commands::Completions { .. } => {
             unreachable!()
         }
     }