Enum Shell

#[non_exhaustive]
pub enum Shell {
    Bash,
    Carapace,
    Elvish,
    Fig,
    Fish,
    Nu,
    PowerShell,
    Zsh,
}

A clap::ValueEnum for available shell completions.

Examples

Derive

use clap::{Parser, Subcommand};

#[derive(Parser)]
struct Cli {
    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand)]
enum Commands {
    Completions {
        #[arg(value_enum)]
        shell: clap_complete_command::Shell,
    },
}

Builder

use clap::{Arg, Command};

fn build_cli() -> Command {
    Command::new(env!("CARGO_PKG_NAME"))
        .subcommand_required(true)
        .subcommand(
            Command::new("completions")
                .about("Generate shell completions")
                .arg(
                    Arg::new("shell")
                        .value_name("SHELL")
                        .help("The shell to generate the completions for")
                        .required(true)
                        .value_parser(
                            clap::builder::EnumValueParser::<clap_complete_command::Shell>::new(),
                        ),
                ),
        )
}

let matches = build_cli().get_matches();

match matches.subcommand() {
    Some(("completions", sub_matches)) => {
        if let Some(shell) = sub_matches.get_one::<clap_complete_command::Shell>("shell") {
            // ...
        }
    }
    _ => {
        unreachable!("Exhausted list of subcommands and `subcommand_required` prevents `None`")
    }
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bash

Bourne Again SHell (bash)

Carapace

Available on crate feature carapace only.

Carapace spec

Elvish

Elvish shell

Fig

Available on crate feature fig only.

Fig

Fish

Friendly Interactive SHell (fish)

Nu

Available on crate feature nushell only.

NUshell (nu)

PowerShell

PowerShell

Zsh

Z SHell (zsh)

Implementations

impl Shell

pub fn generate(self, command: &mut Command, buffer: &mut dyn Write)

See clap_complete::generate().

The command’s bin name is used as the completion’s bin name. If the command’s bin name is not set, it will be set to the command’s name.

pub fn generate_to<S>( self, command: &mut Command, out_dir: S, ) -> Result<PathBuf, Error>

where S: Into<OsString>,

See clap_complete::generate_to().

The command’s bin name is used as the completion’s bin name. If the command’s bin name is not set, it will be set to the command’s name.

Trait Implementations

impl Clone for Shell

fn clone(&self) -> Shell

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Shell

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Generator for Shell

fn file_name(&self, name: &str) -> String

Returns the file name that is created when this generator is called during compile time.

fn generate(&self, cmd: &Command, buf: &mut dyn Write)

Generates output out of clap::Command.

fn try_generate(&self, cmd: &Command, buf: &mut dyn Write) -> Result<(), Error>

Fallible version to generate output out of clap::Command.

impl ValueEnum for Shell

fn value_variants<'a>() -> &'a [Self]

All possible argument values, in display order.

fn to_possible_value(&self) -> Option<PossibleValue>

The canonical argument value.

fn from_str(input: &str, ignore_case: bool) -> Result<Self, String>

Parse an argument into Self.

impl Copy for Shell