click-rs

A Rust port of Python's Click library for creating beautiful command-line interfaces in a composable, declarative way.

click-rs lets you build CLIs from commands, groups, options and arguments, with automatic help generation, prompts, colored output, shell completion, and a testing harness, using either a derive macro or a builder API.

Attribution. click-rs is a derivative work: a Rust port of the excellent Click library by the Pallets team. All credit for the original design and API goes to them. This project aims to bring that ergonomics to the Rust ecosystem.

Compatibility

Works on Linux, macOS, and Windows.

Minimum Supported Rust Version: 1.70+

Installing

The crate is published as click-rs, but its library is imported as click:

[dependencies]
click-rs = "1.0"

use click::Command;

The derive feature is enabled by default. Disable it with default-features = false to use the builder API only.

Quick Start (derive)

use click::Command;

#[derive(Command)]
#[command(name = "greet")]
/// A friendly greeter
struct Greet {
    /// Name to greet
    #[argument]
    name: String,

    /// Number of times to greet
    #[option(short, long, default = 1)]
    count: i32,
}

impl Greet {
    fn run(&self) {
        for _ in 0..self.count {
            println!("Hello, {}!", self.name);
        }
    }
}

fn main() {
    Greet::main_with(std::env::args().skip(1).collect(), |greet, _ctx| {
        greet.run();
        Ok(())
    }).unwrap();
}

Features

• Commands & groups: compose nested subcommands with shared context
• Options & arguments: typed parameters with defaults, flags, multiple values
• Automatic help: generated usage and --help output
• Prompts & I/O: interactive prompts, confirmation, and piped input/output
• Colored output: styled terminal text
• Shell completion: generate completion scripts
• Validation: custom parameter validation and error reporting
• Testing: a CliRunner harness for invoking commands in tests

Examples

The examples/ directory mirrors classic Click examples:

Run one with:

cargo run --example naval -- --help

License

Licensed under the MIT License.