Merge pull request #105 from benthecarman/bash-completion

Add support for bash completions

Author: tnull

Cargo.lock

@@ -51,6 +51,22 @@ cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
 
 Interact with the node using CLI:
 ```
-./target/debug/ldk-server-cli -b localhost:3002 --api-key your-secret-api-key onchain-receive # To generate onchain-receive address.
-./target/debug/ldk-server-cli -b localhost:3002 --api-key your-secret-api-key help # To print help/available commands.
+ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
+ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
+```
+
+### Shell Completions
+
+The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
+
+Add completions to your shell config:
+```bash
+# Bash (add to ~/.bashrc)
+eval "$(ldk-server-cli completions bash)"
+
+# Zsh (add to ~/.zshrc)
+eval "$(ldk-server-cli completions zsh)"
+
+# Fish (add to ~/.config/fish/config.fish)
+ldk-server-cli completions fish | source
 ```

README.md

@@ -6,6 +6,7 @@ edition = "2021"
 [dependencies]
 ldk-server-client = { path = "../ldk-server-client", features = ["serde"] }
 clap = { version = "4.0.5", default-features = false, features = ["derive", "std", "error-context", "suggestions", "help"] }
+clap_complete = { version = "4.0", default-features = false }
 hex-conservative = { version = "0.2", default-features = false, features = ["std"] }
 tokio = { version = "1.38.0", default-features = false, features = ["rt-multi-thread", "macros"] }
 serde = "1.0"

ldk-server-cli/Cargo.toml

@@ -9,7 +9,8 @@
 
 use std::path::PathBuf;
 
-use clap::{Parser, Subcommand};
+use clap::{CommandFactory, Parser, Subcommand};
+use clap_complete::{generate, Shell};
 use config::{
 	get_default_api_key_path, get_default_cert_path, get_default_config_path, load_config,
 };
@@ -335,12 +336,26 @@ enum Commands {
 		)]
 		cltv_expiry_delta: Option<u32>,
 	},
+	#[command(about = "Generate shell completions for the CLI")]
+	Completions {
+		#[arg(
+			value_enum,
+			help = "The shell to generate completions for (bash, zsh, fish, powershell, elvish)"
+		)]
+		shell: Shell,
+	},
 }
 
 #[tokio::main]
 async fn main() {
 	let cli = Cli::parse();
 
+	// short-circuit if generating completions
+	if let Commands::Completions { shell } = cli.command {
+		generate(shell, &mut Cli::command(), "ldk-server-cli", &mut std::io::stdout());
+		return;
+	}
+
 	let config_path = cli.config.map(PathBuf::from).or_else(get_default_config_path);
 	let config = config_path.as_ref().and_then(|p| load_config(p).ok());
 
@@ -658,6 +673,7 @@ async fn main() {
 					.await,
 			);
 		},
+		Commands::Completions { .. } => unreachable!("Handled above"),
 	}
 }