No description
Find a file
2021-12-08 22:50:18 -08:00
.github chore(ci): Stop using all features 2021-12-08 20:37:53 -06:00
assets docs: Add back in logo 2021-12-07 17:45:57 -06:00
benches fix: Be consistent on hide/hidden 2021-11-29 10:58:00 -06:00
clap_derive docs(derive): Note using fully-qualified path 2021-12-08 19:58:41 -06:00
clap_generate chore: Release 2021-12-08 12:41:59 -06:00
clap_generate_fig fix(fig): Reduce keywords 2021-12-08 12:44:11 -06:00
docs docs(faq): Modernize it 2021-12-06 20:55:34 -06:00
examples docs: Fix reference to feature flags 2021-12-08 19:25:48 -06:00
src fix: Fix typo 2021-12-08 22:50:18 -08:00
tests Merge pull request #3104 from epage/unstable 2021-12-08 21:21:12 -06:00
.clippy.toml chore: Limit local clippy to MSRV like CI 2021-12-07 17:45:57 -06:00
.gitignore chore: Align on boilerplate 2021-11-17 15:24:50 -06:00
.pre-commit-config.yaml chore: Align on boilerplate 2021-11-17 15:24:50 -06:00
Cargo.toml docs: Auto-tag feature flags 2021-12-08 20:37:53 -06:00
CHANGELOG.md docs(change): Update link 2021-12-08 21:03:27 -06:00
clap.schema.json feat(doc): Fix many typos in docs, comments and codes found by typos-cli 2021-10-19 10:38:22 +09:00
committed.toml chore: Align on boilerplate 2021-11-17 15:24:50 -06:00
CONTRIBUTING.md docs(contrib): Point out to other contribs 2021-12-07 20:52:27 -06:00
LICENSE-APACHE chore: relicense under MIT and APACHE 2.0 2018-07-23 14:25:18 -04:00
LICENSE-MIT chore: updates additional files for 2x release 2016-01-28 11:46:12 -05:00
Makefile chore(ci): Stop using all features 2021-12-08 20:37:53 -06:00
README.md chore: Release 2021-12-08 12:41:59 -06:00
release.toml chore: Configure release process 2021-12-07 21:36:00 -06:00
typos.toml docs: Fix typos 2021-11-17 15:21:58 -06:00

clap

Command Line Argument Parser for Rust

Crates.io Crates.io License License Build Status Coverage Status Contributors

Dual-licensed under Apache 2.0 or MIT.

  1. About
  2. Tutorial: Builder API, Derive API
  3. Examples
  4. API Reference
  5. CHANGELOG
  6. FAQ
  7. Questions & Discussions
  8. Contributing
  9. Sponsors

About

Create your command-line parser, with all of the bells and whistles, declaratively or procedurally.

Example

use clap::Parser;

/// Simple program to greet a person
#[derive(Parser, Debug)]
#[clap(about, version, author)]
struct Args {
    /// Name of the person to greet
    #[clap(short, long)]
    name: String,

    /// Number of times to greet
    #[clap(short, long, default_value_t = 1)]
    count: u8,
}

fn main() {
    let args = Args::parse();

    for _ in 0..args.count {
        println!("Hello {}!", args.name)
    }
}

(note: requires feature derive)

$ demo --help
clap [..]

A simple to use, efficient, and full-featured Command Line Argument Parser

USAGE:
    demo[EXE] [OPTIONS] --name <NAME>

OPTIONS:
    -c, --count <COUNT>    Number of times to greet [default: 1]
    -h, --help             Print help information
    -n, --name <NAME>      Name of the person to greet
    -V, --version          Print version information

(version number and .exe extension on windows replaced by placeholders)

Aspirations

  • Out of the box, users get a polished CLI experience
    • Including common argument behavior, help generation, suggested fixes for users, colored output, shell completions, etc
  • Flexible enough to port your existing CLI interface
    • However, we won't necessarily streamline support for each use case
  • Reasonable parse performance
  • Resilient maintainership, including
    • Willing to break compatibility rather than batching up breaking changes in large releases
    • Leverage feature flags to keep to one active branch
    • Being under WG-CLI to increase the bus factor
  • We follow semver and will wait about 6-9 months between major breaking changes
  • We will support the last two minor Rust releases (MSRV, currently 1.54.0)

While these aspirations can be at odds with fast build times and low binary size, we will still strive to keep these reasonable for the flexibility you get. Check out the argparse-benchmarks for CLI parsers optimized for other use cases.

Feature Flags

Default Features

  • std: Not Currently Used. Placeholder for supporting no_std environments in a backwards compatible manner.
  • color: Turns on colored error messages.
  • suggestions: Turns on the Did you mean '--myoption'? feature for when users make typos.

Optional features

  • derive: Enables the custom derive (i.e. #[derive(Parser)]). Without this you must use one of the other methods of creating a clap CLI listed above.
  • cargo: Turns on macros that read values from CARGO_* environment variables.
  • env: Turns on the usage of environment variables during parsing.
  • regex: Enables regex validators.
  • unicode: Turns on support for unicode characters (including emoji) in arguments and help messages.
  • wrap_help: Turns on the help text wrapping feature, based on the terminal size.

Experimental features

Warning: These may contain breaking changes between minor releases.

Sponsors

Gold

Silver

Bronze

Backer