shellcomp 0.1.12

Shell completion installation and activation helpers for Rust CLI tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

use std::env;

use clap::Parser;
use shellcomp::{InstallRequest, install, render_clap_completion};

#[derive(Parser)]
struct Cli {
    #[arg(long)]
    verbose: bool,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let generator_shell = shellcomp::clap_complete::Shell::Bash;
    let script = render_clap_completion::<Cli>(generator_shell, "example-cli")?;
    let demo_path = env::temp_dir().join(format!("example-cli-{}.bash", std::process::id()));
    let report = install(InstallRequest {
        shell: generator_shell.into(),
        program_name: "example-cli",
        script: &script,
        path_override: Some(demo_path.clone()),
    })?;

    println!("Rendered completion from clap and installed it to a temporary path.");
    println!("Path: {}", demo_path.display());
    println!("{report:#?}");
    Ok(())
}