Add shell completion subcommand

fclones/Cargo.toml

@@ -24,6 +24,7 @@ bytesize = "1.1"
 byte-unit = "4.0"
 chrono = { version = "0.4", default-features = false, features = ["serde", "clock", "std"] }
 clap = { version = "4.4", features = ["derive", "cargo", "wrap_help"] }
+clap_complete = { version = "4.5.36" }
 console = "0.15"
 crossbeam-channel = "0.5"
 crossbeam-utils = "0.8"

fclones/README.md

@@ -163,6 +163,20 @@ are also attached directly to [Releases](https://github.com/pkolaczk/fclones/rel
 
 The build will write the binary to `.cargo/bin/fclones`. 
 
+### Shell completions
+
+`fclones` supports shell completions but you have to set it up manually at the moment,
+which can be done by adding the script printed by the `fclones complete` subcommand to your shell configuration.
+All shells supported by [clap_complete](https://docs.rs/clap_complete/latest/clap_complete/aot/enum.Shell.html) are supported.
+At the time of writing this includes:
+
+- Bash: Add `eval "$(fclones complete bash)"` to your `~/.bashrc`
+- Zsh: Add `source <(fclones complete zsh)` to your `~/.zshrc`
+- Fish: Add `fclones complete fish | source` to your `~/.config/fish/config.fish`
+- Elvish
+- Powershell
+
+
 ## Usage
 
 `fclones` offers separate commands for finding and removing files. This way, you can inspect

fclones/src/config.rs

@@ -729,6 +729,12 @@ pub enum Command {
         #[arg()]
         target: PathBuf,
     },
+
+    /// Print shell completion script to stdout.
+    Complete {
+        /// Shell for which the completion script is generated.
+        shell: clap_complete::Shell,
+    },
 }
 
 impl Command {
@@ -801,4 +807,10 @@ mod test {
             config.command,
             Command::Move { target, .. } if target == PathBuf::from("target"));
     }
+
+    #[test]
+    fn test_complete_command() {
+        let config: Config = Config::try_parse_from(vec!["fclones", "complete", "zsh"]).unwrap();
+        assert_matches!(config.command, Command::Complete { shell } if shell == clap_complete::Shell::Zsh);
+    }
 }