Crate clap_complete

source ·

Expand description

clap_complete

Shell completion generation for clap

Dual-licensed under Apache 2.0 or MIT.

About

clap_complete_fig for fig shell completion support

Quick Start

For generating at compile-time, see generate_to
For generating at runtime, see generate

Shell is a convenience enum for an argument value type that implements Generator for each natively-supported shell type.

Example

use clap::{Command, Arg, ValueHint, value_parser};
use clap_complete::{generate, Generator, Shell};
use std::io;

fn build_cli() -> Command<'static> {
    Command::new("example")
         .arg(Arg::new("file")
             .help("some input file")
                .value_hint(ValueHint::AnyPath),
        )
       .arg(
           Arg::new("generator")
               .long("generate")
               .takes_value(true)
               .value_parser(value_parser!(Shell)),
       )
}

fn print_completions<G: Generator>(gen: G, cmd: &mut Command) {
    generate(gen, cmd, cmd.get_name().to_string(), &mut io::stdout());
}

fn main() {
    let matches = build_cli().get_matches();

    if let Some(generator) = matches.get_one::<Shell>("generator").copied() {
        let mut cmd = build_cli();
        eprintln!("Generating completion file for {}...", generator);
        print_completions(generator, &mut cmd);
    }
}

Re-exports

pub use generator::generate;

pub use generator::generate_to;

pub use generator::Generator;

Modules

generator

Shell completion machinery

shells

Shell-specific generators

Enums

Shell

Shell with auto-generated completion script available.