Add shell completion

CHANGELOG.md

@@ -6,6 +6,9 @@ most recent changes however.
 
 ## May
 
+- Rye's `self` command now includes a `completion` subcommand to generate
+  a completion script for your shell.
+
 - The downloaded Python distributions are now validated against the
   SHA-256 hashes.
 

rye/Cargo.toml

@@ -9,6 +9,7 @@ license = "MIT"
 [dependencies]
 anyhow = { version = "1.0.70", features = ["backtrace"] }
 clap = { version = "4.2.2", default-features = false, features = ["derive", "usage", "wrap_help", "std"] }
+clap_complete = "4.2.1"
 console = "0.15.5"
 curl = { version = "0.4.44", features = ["ssl", "static-curl", "static-ssl"] }
 decompress = { version = "0.6.0", default-features = false, features = ["tarzst", "targz"] }

rye/src/cli/rye.rs

@@ -1,7 +1,8 @@
 use std::process::Command;
 
 use anyhow::{bail, Context, Error};
-use clap::Parser;
+use clap::{CommandFactory, Parser};
+use clap_complete::Shell;
 
 /// Rye self management
 #[derive(Parser, Debug)]
@@ -10,6 +11,14 @@ pub struct Args {
     command: SubCommand,
 }
 
+/// Generates a completion script for a shell.
+#[derive(Parser, Debug)]
+pub struct CompletionCommand {
+    /// The shell to generate a completion script for (defaults to 'bash').
+    #[arg(short, long)]
+    shell: Option<Shell>,
+}
+
 /// Performs an update of rye.
 ///
 /// This currently just is an alias to running cargo install again with the
@@ -29,15 +38,28 @@ pub struct UpdateCommand {
 
 #[derive(Parser, Debug)]
 enum SubCommand {
+    Completion(CompletionCommand),
     Update(UpdateCommand),
 }
 
 pub fn execute(cmd: Args) -> Result<(), Error> {
     match cmd.command {
+        SubCommand::Completion(args) => completion(args),
         SubCommand::Update(args) => update(args),
     }
 }
 
+fn completion(args: CompletionCommand) -> Result<(), Error> {
+    clap_complete::generate(
+        args.shell.unwrap_or(Shell::Bash),
+        &mut super::Args::command(),
+        "rye",
+        &mut std::io::stdout(),
+    );
+
+    Ok(())
+}
+
 fn update(args: UpdateCommand) -> Result<(), Error> {
     let mut helper = rename_helper::RenameHelper::new()?;
     let mut cmd = Command::new("cargo");