Function render_clap_completion 

pub fn render_clap_completion<T: CommandFactory>(
    shell: impl Into<Shell>,
    bin_name: &str,
) -> Result<Vec<u8>>

Available on crate feature clap only.

Renders a completion script from a clap::CommandFactory implementation.

This helper is intentionally optional so the core crate does not require clap. It only renders script bytes; installation and activation are still handled by install. The shell argument accepts either crate::Shell or crate::clap_complete::Shell. If you need to tweak or prune the command tree before rendering, use render_clap_completion_from_command instead.

Errors

Returns crate::Error::UnsupportedShell for Shell::Other(_).

Examples

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

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

let generator_shell = shellcomp::clap_complete::Shell::Bash;
let script = render_clap_completion::<Cli>(generator_shell, "demo")?;
let report = install(InstallRequest {
    shell: generator_shell.into(),
    program_name: "demo",
    script: &script,
    path_override: None,
})?;

assert!(!script.is_empty());
assert_eq!(report.shell, shellcomp::Shell::Bash);

Examples found in repository

examples/clap_integration.rs (line 14)

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(())
}