mirror of
https://github.com/clap-rs/clap
synced 2024-11-10 14:54:15 +00:00
Merge #1715
1715: Update README for beta release r=kbknapp a=pksunkara Co-authored-by: Pavan Kumar Sunkara <pavan.sss1991@gmail.com>
This commit is contained in:
bors[bot]
GitHub
commit
8f98a329da
4 changed files with 265 additions and 744 deletions
|
|
@ -32,6 +32,9 @@ jobs:
|
|||
- rust: beta
|
||||
- rust: nightly
|
||||
cache: false
|
||||
script:
|
||||
- cargo test --no-default-features --features "std cargo" -p clap:3.0.0-beta.1
|
||||
- cargo test --features "yaml unstable doc"
|
||||
- name: Linting (fmt + clippy)
|
||||
before_script:
|
||||
- rustup component add clippy
|
||||
|
|
|
|||
90
FAQ.md
Normal file
90
FAQ.md
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
1. [Comparisons](#comparisons)
|
||||
1. [How does `clap` compare to structopt?](#how-does-clap-compare-to-structopt)
|
||||
2. [How does `clap` compare to getopts?](#how-does-clap-compare-to-getopts)
|
||||
3. [How does `clap` compare to docopt.rs?](#how-does-clap-compare-to-docoptrs)
|
||||
4. [What are some reasons to use `clap`? (The Pitch)](#what-are-some-reasons-to-use-clap-the-pitch)
|
||||
5. [What are some reasons *not* to use `clap`? (The Anti Pitch)](#what-are-some-reasons-not-to-use-clap-the-anti-pitch)
|
||||
6. [Reasons to use `clap`](#reasons-to-use-clap)
|
||||
7. [Reasons to `docopt`](#reasons-to-docopt)
|
||||
8. [Reasons to use `getopts`](#reasons-to-use-getopts)
|
||||
2. [How many methods are there to create an App/Arg?](#how-many-methods-are-there-to-create-an-apparg)
|
||||
3. [Why is there a default subcommand of help?](#why-is-there-a-default-subcommand-of-help)
|
||||
|
||||
### Comparisons
|
||||
|
||||
First, let me say that these comparisons are highly subjective, and not meant in a critical or harsh manner. All the argument parsing libraries out there (to include `clap`) have their own strengths and weaknesses. Sometimes it just comes down to personal taste when all other factors are equal. When in doubt, try them all and pick one that you enjoy :) There's plenty of room in the Rust community for multiple implementations!
|
||||
|
||||
#### How does `clap` compare to [structopt](https://github.com/TeXitoi/structopt)?
|
||||
|
||||
Simple! `clap` *is* `structopt`. With the 3.0 release, `clap` imported the `structopt` code into it's own codebase as the [`clap_derive`](https://github.com/clap-rs/clap/tree/master/clap_derive) crate. Since `structopt` already used `clap` under the hood, the transition was nearly painless, and is 100% feature compatible.
|
||||
|
||||
If you were using `structopt` before, you have to change the attributes from `#[structopt(...)]` to `#[clap(...)]`.
|
||||
|
||||
Also the derive statements changed from `#[derive(Structopt)]` to `#[derive(Clap)]`. There is also some additional functionality and breaking changes that's been added to the `clap_derive` crate. See the documentation for that crate, for more details.
|
||||
|
||||
#### How does `clap` compare to [getopts](https://github.com/rust-lang-nursery/getopts)?
|
||||
|
||||
`getopts` is a very basic, fairly minimalist argument parsing library. This isn't a bad thing, sometimes you don't need tons of features, you just want to parse some simple arguments, and have some help text generated for you based on valid arguments you specify. The downside to this approach is that you must manually implement most of the common features (such as checking to display help messages, usage strings, etc.). If you want a highly custom argument parser, and don't mind writing the majority of the functionality yourself, `getopts` is an excellent base.
|
||||
|
||||
`getopts` also doesn't allocate much, or at all. This gives it a very small performance boost. Although, as you start implementing additional features, that boost quickly disappears.
|
||||
|
||||
Personally, I find many, many uses of `getopts` are manually implementing features that `clap` provides by default. Using `clap` simplifies your codebase allowing you to focus on your application, and not argument parsing.
|
||||
|
||||
#### How does `clap` compare to [docopt.rs](https://github.com/docopt/docopt.rs)?
|
||||
|
||||
I first want to say I'm a big a fan of BurntSushi's work, the creator of `Docopt.rs`. I aspire to produce the quality of libraries that this man does! When it comes to comparing these two libraries they are very different. `docopt` tasks you with writing a help message, and then it parses that message for you to determine all valid arguments and their use. Some people LOVE this approach, others do not. If you're willing to write a detailed help message, it's nice that you can stick that in your program and have `docopt` do the rest. On the downside, it's far less flexible.
|
||||
|
||||
`docopt` is also excellent at translating arguments into Rust types automatically. There is even a syntax extension which will do all this for you, if you're willing to use a nightly compiler (use of a stable compiler requires you to somewhat manually translate from arguments to Rust types). To use BurntSushi's words, `docopt` is also a sort of black box. You get what you get, and it's hard to tweak implementation or customize the experience for your use case.
|
||||
|
||||
Because `docopt` is doing a ton of work to parse your help messages and determine what you were trying to communicate as valid arguments, it's also one of the more heavy weight parsers performance-wise. For most applications this isn't a concern and this isn't to say `docopt` is slow, in fact far from it. This is just something to keep in mind while comparing.
|
||||
|
||||
#### What are some reasons to use `clap`? (The Pitch)
|
||||
|
||||
`clap` is as fast, and as lightweight as possible while still giving all the features you'd expect from a modern argument parser. In fact, for the amount and type of features `clap` offers it remains about as fast as `getopts`. If you use `clap` when just need some simple arguments parsed, you'll find it's a walk in the park. `clap` also makes it possible to represent extremely complex, and advanced requirements, without too much thought. `clap` aims to be intuitive, easy to use, and fully capable for wide variety use cases and needs.
|
||||
|
||||
#### What are some reasons *not* to use `clap`? (The Anti Pitch)
|
||||
|
||||
Depending on the style in which you choose to define the valid arguments, `clap` can be very verbose. `clap` also offers so many finetuning knobs and dials, that learning everything can seem overwhelming. I strive to keep the simple cases simple, but when turning all those custom dials it can get complex. `clap` is also opinionated about parsing. Even though so much can be tweaked and tuned with `clap` (and I'm adding more all the time), there are still certain features which `clap` implements in specific ways which may be contrary to some users use-cases.
|
||||
|
||||
#### Reasons to use `clap`
|
||||
|
||||
* You want all the nice CLI features your users may expect, yet you don't want to implement them all yourself. You'd like to focus your application, not argument parsing.
|
||||
* In addition to the point above; you don't want to sacrifice performance to get all those nice features
|
||||
* You have complex requirements/conflicts between your various valid args.
|
||||
* You want to use subcommands (although other libraries also support subcommands, they are not nearly as feature rich as those provided by `clap`)
|
||||
* You want some sort of custom validation built into the argument parsing process, instead of as part of your application (which allows for earlier failures, better error messages, more cohesive experience, etc.)
|
||||
* You need more performance than `docopt` provides
|
||||
|
||||
#### Reasons to `docopt`
|
||||
|
||||
* You want *automatic* serialization of your arguments into Rust types (Although `clap` can do this, docopt is better at it)
|
||||
* You are on nightly Rust and want the library to automatically generate an "arguments struct" from the matched args
|
||||
* You are porting an application which uses docopt and already have the usage string already defined
|
||||
|
||||
#### Reasons to use `getopts`
|
||||
|
||||
* You need absolutely as few allocations as possible and don't mind implementing nearly everything yourself
|
||||
* You want a portion of the arg parsing process to be very custom (again, implementing the details yourself)
|
||||
|
||||
|
||||
### How many methods are there to create an App/Arg?
|
||||
|
||||
To build an `App` there are three:
|
||||
|
||||
* Derive Macros
|
||||
* Builder Pattern
|
||||
* Yaml
|
||||
|
||||
To build an `Arg` there are four:
|
||||
|
||||
* Derive Macros
|
||||
* Builder Pattern
|
||||
* Usage Strings
|
||||
* Yaml
|
||||
|
||||
### Why is there a default subcommand of help?
|
||||
|
||||
There is only a default subcommand of `help` when other subcommands have been defined manually. So it's opt-in(ish), being that you only get a `help` subcommand if you're actually using subcommands.
|
||||
|
||||
Also, if the user defined a `help` subcommand themselves, the auto-generated one wouldn't be added (meaning it's only generated if the user hasn't defined one themselves).
|
||||
|
||||
483
README.md
483
README.md
|
|
@ -1,61 +1,49 @@
|
|||
clap
|
||||
====
|
||||
<!-- omit in TOC -->
|
||||
# clap
|
||||
|
||||
[](https://crates.io/crates/clap) [](https://crates.io/crates/clap) [](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE) [](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT) [](https://coveralls.io/github/clap-rs/clap?branch=master)
|
||||
|
||||
Linux: [](https://travis-ci.org/clap-rs/clap)
|
||||
Windows: [](https://dev.azure.com/clap-rs/clap/_build/latest?definitionId=1&branchName=master)
|
||||
[](https://crates.io/crates/clap)
|
||||
[](https://crates.io/crates/clap)
|
||||
[](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE)
|
||||
[](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT)
|
||||
[](https://coveralls.io/github/clap-rs/clap?branch=master)
|
||||
[](https://travis-ci.org/clap-rs/clap)
|
||||
[](https://dev.azure.com/clap-rs/clap/_build/latest?definitionId=1&branchName=master)
|
||||
|
||||
Command Line Argument Parser for Rust
|
||||
|
||||
It is a simple-to-use, efficient, and full-featured library for parsing command line arguments and subcommands when writing console/terminal applications.
|
||||
It is a simple-to-use, efficient, and full-featured library for parsing command line arguments and subcommands when writing command line, console or terminal applications.
|
||||
|
||||
* [Documentation](https://docs.rs/clap/)
|
||||
* [Documentation][docs]
|
||||
* [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
|
||||
* [Website](https://clap.rs/)
|
||||
* [Video tutorials](https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U)
|
||||
|
||||
> **IMPORTANT!**
|
||||
> This readme describes `clap v3.0.0` which is still under development and will be published soon-ish.
|
||||
> It was not published on crates.io yet, and if you want to use this preview anyway, use
|
||||
> ```toml,no_sync
|
||||
> clap = { git = "https://github.com/clap-rs/clap/" }
|
||||
> ```
|
||||
>
|
||||
> If you're looking for the readme for `clap v2.33` - find it on [github](https://github.com/clap-rs/clap/tree/v2.33.0), [crates.io](https://crates.io/crates/clap/2.33.0), [docs.rs](https://docs.rs/clap/2.33.0/clap/).
|
||||
We are currently hard at work trying to release `3.0`. We have a `3.0.0-beta.1` prerelease out but we do not give any guarantees that it's API is stable. We do not have a changelog yet which will be written down after we are sure about the API stability. We recommend users to not update to the prerelease version yet and to wait for the official `3.0`.
|
||||
|
||||
> If you're looking for the readme & examples for `clap v2.33` - find it on [github](https://github.com/clap-rs/clap/tree/v2.33.0), [crates.io](https://crates.io/crates/clap/2.33.0), [docs.rs](https://docs.rs/clap/2.33.0/clap/).
|
||||
|
||||
Table of Contents
|
||||
=================
|
||||
|
||||
* [What's New](#whats-new)
|
||||
* [About](#about)
|
||||
* [FAQ](#faq)
|
||||
* [Features](#features)
|
||||
* [Quick Example](#quick-example)
|
||||
* [Try it!](#try-it)
|
||||
* [Pre-Built Test](#pre-built-test)
|
||||
* [BYOB (Build Your Own Binary)](#byob-build-your-own-binary)
|
||||
* [Usage](#usage)
|
||||
* [Optional Dependencies / Features](#optional-dependencies--features)
|
||||
* [Dependencies Tree](#dependencies-tree)
|
||||
* [More Information](#more-information)
|
||||
* [Video Tutorials](#video-tutorials)
|
||||
* [How to Contribute](#how-to-contribute)
|
||||
* [Compatibility Policy](#compatibility-policy)
|
||||
* [Minimum Version of Rust](#minimum-version-of-rust)
|
||||
* [Related Crates](#related-crates)
|
||||
* [License](#license)
|
||||
* [Recent Breaking Changes](#recent-breaking-changes)
|
||||
* [Deprecations](#deprecations)
|
||||
|
||||
Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
|
||||
|
||||
## What's New
|
||||
|
||||
Here's whats new in 3.0.0-alpha.1:
|
||||
|
||||
For full details, see [CHANGELOG.md](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md)
|
||||
1. [About](#about)
|
||||
2. [FAQ](#faq)
|
||||
3. [Features](#features)
|
||||
4. [Quick Example](#quick-example)
|
||||
1. [Using Derive Macros](#using-derive-macros)
|
||||
2. [Using Builder Pattern](#using-builder-pattern)
|
||||
3. [Using YAML](#using-yaml)
|
||||
4. [Using Macros](#using-macros)
|
||||
5. [Running it](#running-it)
|
||||
5. [Try it!](#try-it)
|
||||
1. [Pre-Built Test](#pre-built-test)
|
||||
2. [Build Your Own Binary](#build-your-own-binary)
|
||||
6. [Usage](#usage)
|
||||
1. [Optional Dependencies / Features](#optional-dependencies--features)
|
||||
1. [Features enabled by default](#features-enabled-by-default)
|
||||
2. [Opt-in features](#opt-in-features)
|
||||
2. [More Information](#more-information)
|
||||
7. [Contributing](#contributing)
|
||||
1. [Compatibility Policy](#compatibility-policy)
|
||||
1. [Minimum Supported Version of Rust (MSRV)](#minimum-supported-version-of-rust-msrv)
|
||||
2. [Breaking Changes](#breaking-changes)
|
||||
8. [License](#license)
|
||||
9. [Related Crates](#related-crates)
|
||||
|
||||
## About
|
||||
|
||||
|
|
@ -67,47 +55,11 @@ Once `clap` parses the user provided string of arguments, it returns the matches
|
|||
|
||||
## FAQ
|
||||
|
||||
For a full FAQ and more in depth details, see [the wiki page](https://github.com/clap-rs/clap/wiki/FAQ)
|
||||
|
||||
### Comparisons
|
||||
|
||||
First, let me say that these comparisons are highly subjective, and not meant in a critical or harsh manner. All the argument parsing libraries out there (to include `clap`) have their own strengths and weaknesses. Sometimes it just comes down to personal taste when all other factors are equal. When in doubt, try them all and pick one that you enjoy :) There's plenty of room in the Rust community for multiple implementations!
|
||||
|
||||
#### How does `clap` compare to [structopt](https://github.com/TeXitoi/structopt)?
|
||||
|
||||
Simple! `clap` *is* `structopt`. With the 3.0 release, `clap` imported the `structopt` code into it's own codebase as the [`clap_derive`](https://github.com/clap-rs/clap_derive) crate. Since `structopt` already used `clap` under the hood, the transition was nearly painless, and is 100% feature compatible.
|
||||
|
||||
If you were using `structopt` before, the only thing you should have to do is change the attributes from `#[structopt(...)]` to `#[clap(...)]`.
|
||||
|
||||
Also the derive statements changed from `#[derive(Structopt)]` to `#[derive(Clap)]`. There is also some additional functionality that's been added to the `clap_derive` crate. See the documentation for that crate, for more details.
|
||||
|
||||
#### How does `clap` compare to [getopts](https://github.com/rust-lang-nursery/getopts)?
|
||||
|
||||
`getopts` is a very basic, fairly minimalist argument parsing library. This isn't a bad thing, sometimes you don't need tons of features, you just want to parse some simple arguments, and have some help text generated for you based on valid arguments you specify. The downside to this approach is that you must manually implement most of the common features (such as checking to display help messages, usage strings, etc.). If you want a highly custom argument parser, and don't mind writing the majority of the functionality yourself, `getopts` is an excellent base.
|
||||
|
||||
`getopts` also doesn't allocate much, or at all. This gives it a very small performance boost. Although, as you start implementing additional features, that boost quickly disappears.
|
||||
|
||||
Personally, I find many, many uses of `getopts` are manually implementing features that `clap` provides by default. Using `clap` simplifies your codebase allowing you to focus on your application, and not argument parsing.
|
||||
|
||||
#### How does `clap` compare to [docopt.rs](https://github.com/docopt/docopt.rs)?
|
||||
|
||||
I first want to say I'm a big a fan of BurntSushi's work, the creator of `Docopt.rs`. I aspire to produce the quality of libraries that this man does! When it comes to comparing these two libraries they are very different. `docopt` tasks you with writing a help message, and then it parses that message for you to determine all valid arguments and their use. Some people LOVE this approach, others do not. If you're willing to write a detailed help message, it's nice that you can stick that in your program and have `docopt` do the rest. On the downside, it's far less flexible.
|
||||
|
||||
`docopt` is also excellent at translating arguments into Rust types automatically. There is even a syntax extension which will do all this for you, if you're willing to use a nightly compiler (use of a stable compiler requires you to somewhat manually translate from arguments to Rust types). To use BurntSushi's words, `docopt` is also a sort of black box. You get what you get, and it's hard to tweak implementation or customize the experience for your use case.
|
||||
|
||||
Because `docopt` is doing a ton of work to parse your help messages and determine what you were trying to communicate as valid arguments, it's also one of the more heavy weight parsers performance-wise. For most applications this isn't a concern and this isn't to say `docopt` is slow, in fact far from it. This is just something to keep in mind while comparing.
|
||||
|
||||
#### All else being equal, what are some reasons to use `clap`? (The Pitch)
|
||||
|
||||
`clap` is as fast, and as lightweight as possible while still giving all the features you'd expect from a modern argument parser. In fact, for the amount and type of features `clap` offers it remains about as fast as `getopts`. If you use `clap` when just need some simple arguments parsed, you'll find it's a walk in the park. `clap` also makes it possible to represent extremely complex, and advanced requirements, without too much thought. `clap` aims to be intuitive, easy to use, and fully capable for wide variety use cases and needs.
|
||||
|
||||
#### All else being equal, what are some reasons *not* to use `clap`? (The Anti Pitch)
|
||||
|
||||
Depending on the style in which you choose to define the valid arguments, `clap` can be very verbose. `clap` also offers so many finetuning knobs and dials, that learning everything can seem overwhelming. I strive to keep the simple cases simple, but when turning all those custom dials it can get complex. `clap` is also opinionated about parsing. Even though so much can be tweaked and tuned with `clap` (and I'm adding more all the time), there are still certain features which `clap` implements in specific ways which may be contrary to some users use-cases. Finally, `clap` is "stringly typed" when referring to arguments which can cause typos in code. This particular paper-cut is being actively worked on, and should be gone in v3.x.
|
||||
For a full FAQ, see [this](FAQ.md)
|
||||
|
||||
## Features
|
||||
|
||||
Below are a few of the features which `clap` supports, full descriptions and usage can be found in the [documentation](https://docs.rs/clap/) and [examples/](examples) directory
|
||||
Below are a few of the features which `clap` supports, full descriptions and usage can be found in the [documentation][docs] and [examples][examples] directory
|
||||
|
||||
* Generate a CLI simply by defining a struct!
|
||||
* **Auto-generated Help, Version, and Usage information**
|
||||
|
|
@ -162,13 +114,22 @@ Below are a few of the features which `clap` supports, full descriptions and usa
|
|||
|
||||
## Quick Example
|
||||
|
||||
The following examples show a quick example of some of the very basic functionality of `clap`. For more advanced usage, such as requirements, conflicts, groups, multiple values and occurrences see the [documentation](https://docs.rs/clap/), [examples/](examples) directory of this repository or the [video tutorials](https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U).
|
||||
The following examples show a quick example of some of the very basic functionality of `clap`. For more advanced usage, such as requirements, conflicts, groups, multiple values and occurrences see the [documentation][docs], [examples][examples] directory of this repository.
|
||||
|
||||
**NOTE:** All of these examples are functionally the same, but show different styles in which to use `clap`. These different styles are purely a matter of personal preference.
|
||||
|
||||
Add `clap` to your `Cargo.toml`
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
clap = "3.0.0-beta.1"
|
||||
```
|
||||
|
||||
#### Using Derive Macros
|
||||
|
||||
The first example shows the simplest way to use `clap`, by defining a struct. If you're familiar with the `structopt` crate you're in luck, it's the same! (In fact it's the exact same code running under the covers!)
|
||||
|
||||
```rust
|
||||
```rust,no_run
|
||||
// (Full example with detailed comments in examples/01d_quick_example.rs)
|
||||
//
|
||||
// This example demonstrates clap's full 'custom derive' style of creating arguments which is the
|
||||
|
|
@ -178,15 +139,15 @@ use clap::Clap;
|
|||
/// This doc string acts as a help message when the user runs '--help'
|
||||
/// as do all doc strings on fields
|
||||
#[derive(Clap)]
|
||||
#[clap(version = "1.0", author = "Kevin K.")]
|
||||
#[clap(version = "1.0", author = "Kevin K. <kbknapp@gmail.com>")]
|
||||
struct Opts {
|
||||
/// Sets a custom config file. Could have been an Option<T> with no default too
|
||||
#[clap(short = "c", long = "config", default_value = "default.conf")]
|
||||
#[clap(short, long, default_value = "default.conf")]
|
||||
config: String,
|
||||
/// Some input. Because this isn't an Option<T> it's required to be used
|
||||
input: String,
|
||||
/// A level of verbosity, and can be used multiple times
|
||||
#[clap(short = "v", long = "verbose", parse(from_occurrences))]
|
||||
#[clap(short, long, parse(from_occurrences))]
|
||||
verbose: i32,
|
||||
#[clap(subcommand)]
|
||||
subcmd: SubCommand,
|
||||
|
|
@ -194,8 +155,7 @@ struct Opts {
|
|||
|
||||
#[derive(Clap)]
|
||||
enum SubCommand {
|
||||
/// A help message for the Test subcommand
|
||||
#[clap(name = "test", version = "1.3", author = "Someone Else")]
|
||||
#[clap(version = "1.3", author = "Someone E. <someone_else@other.com>")]
|
||||
Test(Test),
|
||||
}
|
||||
|
||||
|
|
@ -203,7 +163,7 @@ enum SubCommand {
|
|||
#[derive(Clap)]
|
||||
struct Test {
|
||||
/// Print debug info
|
||||
#[clap(short = "d")]
|
||||
#[clap(short)]
|
||||
debug: bool
|
||||
}
|
||||
|
||||
|
|
@ -239,42 +199,44 @@ fn main() {
|
|||
}
|
||||
```
|
||||
|
||||
#### Using Builder Pattern
|
||||
|
||||
This second method shows a method using the 'Builder Pattern' which allows more advanced configuration options (not shown in this small example), or even dynamically generating arguments when desired. The downside is it's more verbose.
|
||||
|
||||
```rust
|
||||
```rust,no_run
|
||||
// (Full example with detailed comments in examples/01a_quick_example.rs)
|
||||
//
|
||||
// This example demonstrates clap's "builder pattern" method of creating arguments
|
||||
// which the most flexible, but also most verbose.
|
||||
use clap::{Arg, App, SubCommand};
|
||||
use clap::{Arg, App};
|
||||
|
||||
fn main() {
|
||||
let matches = App::new("My Super Program")
|
||||
.version("1.0")
|
||||
.author("Kevin K. <kbknapp@gmail.com>")
|
||||
.about("Does awesome things")
|
||||
.arg(Arg::with_name("config")
|
||||
.short('c')
|
||||
.long("config")
|
||||
.value_name("FILE")
|
||||
.help("Sets a custom config file")
|
||||
.takes_value(true))
|
||||
.arg(Arg::with_name("INPUT")
|
||||
.help("Sets the input file to use")
|
||||
.required(true)
|
||||
.index(1))
|
||||
.arg(Arg::with_name("v")
|
||||
.short('v')
|
||||
.multiple(true)
|
||||
.help("Sets the level of verbosity"))
|
||||
.subcommand(SubCommand::with_name("test")
|
||||
.about("controls testing features")
|
||||
.version("1.3")
|
||||
.author("Someone E. <someone_else@other.com>")
|
||||
.arg(Arg::with_name("debug")
|
||||
.short('d')
|
||||
.help("print debug information verbosely")))
|
||||
.get_matches();
|
||||
.version("1.0")
|
||||
.author("Kevin K. <kbknapp@gmail.com>")
|
||||
.about("Does awesome things")
|
||||
.arg(Arg::with_name("config")
|
||||
.short('c')
|
||||
.long("config")
|
||||
.value_name("FILE")
|
||||
.about("Sets a custom config file")
|
||||
.takes_value(true))
|
||||
.arg(Arg::with_name("INPUT")
|
||||
.about("Sets the input file to use")
|
||||
.required(true)
|
||||
.index(1))
|
||||
.arg(Arg::with_name("v")
|
||||
.short('v')
|
||||
.multiple(true)
|
||||
.about("Sets the level of verbosity"))
|
||||
.subcommand(App::new("test")
|
||||
.about("controls testing features")
|
||||
.version("1.3")
|
||||
.author("Someone E. <someone_else@other.com>")
|
||||
.arg(Arg::with_name("debug")
|
||||
.short('d')
|
||||
.about("print debug information verbosely")))
|
||||
.get_matches();
|
||||
|
||||
// Same as above examples...
|
||||
}
|
||||
|
|
@ -282,33 +244,34 @@ fn main() {
|
|||
|
||||
The next example shows a far less verbose method, but sacrifices some of the advanced configuration options (not shown in this small example). This method also takes a *very* minor runtime penalty.
|
||||
|
||||
```rust
|
||||
```rust,no_run
|
||||
// (Full example with detailed comments in examples/01a_quick_example.rs)
|
||||
//
|
||||
// This example demonstrates clap's "usage strings" method of creating arguments
|
||||
// which is less verbose
|
||||
use clap::{Arg, App, SubCommand};
|
||||
use clap::{Arg, App};
|
||||
|
||||
fn main() {
|
||||
let matches = App::new("myapp")
|
||||
.version("1.0")
|
||||
.author("Kevin K. <kbknapp@gmail.com>")
|
||||
.about("Does awesome things")
|
||||
.args_from_usage(
|
||||
"-c, --config=[FILE] 'Sets a custom config file'
|
||||
<INPUT> 'Sets the input file to use'
|
||||
-v... 'Sets the level of verbosity'")
|
||||
.subcommand(SubCommand::with_name("test")
|
||||
.about("controls testing features")
|
||||
.version("1.3")
|
||||
.author("Someone E. <someone_else@other.com>")
|
||||
.arg("-d, --debug 'Print debug information'"))
|
||||
.get_matches();
|
||||
.version("1.0")
|
||||
.author("Kevin K. <kbknapp@gmail.com>")
|
||||
.about("Does awesome things")
|
||||
.arg("-c, --config=[FILE] 'Sets a custom config file'")
|
||||
.arg("<INPUT> 'Sets the input file to use'")
|
||||
.arg("-v... 'Sets the level of verbosity'")
|
||||
.subcommand(App::new("test")
|
||||
.about("controls testing features")
|
||||
.version("1.3")
|
||||
.author("Someone E. <someone_else@other.com>")
|
||||
.arg("-d, --debug 'Print debug information'"))
|
||||
.get_matches();
|
||||
|
||||
// Same as previous example...
|
||||
}
|
||||
```
|
||||
|
||||
#### Using YAML
|
||||
|
||||
This third method shows how you can use a YAML file to build your CLI and keep your Rust source tidy
|
||||
or support multiple localized translations by having different YAML files for each localization.
|
||||
|
||||
|
|
@ -324,16 +287,16 @@ args:
|
|||
short: c
|
||||
long: config
|
||||
value_name: FILE
|
||||
help: Sets a custom config file
|
||||
about: Sets a custom config file
|
||||
takes_value: true
|
||||
- INPUT:
|
||||
help: Sets the input file to use
|
||||
about: Sets the input file to use
|
||||
required: true
|
||||
index: 1
|
||||
- verbose:
|
||||
short: v
|
||||
multiple: true
|
||||
help: Sets the level of verbosity
|
||||
about: Sets the level of verbosity
|
||||
subcommands:
|
||||
- test:
|
||||
about: controls testing features
|
||||
|
|
@ -342,16 +305,21 @@ subcommands:
|
|||
args:
|
||||
- debug:
|
||||
short: d
|
||||
help: print debug information
|
||||
about: print debug information
|
||||
```
|
||||
|
||||
Since this feature requires additional dependencies that not everyone may want, it is *not* compiled in by default and we need to enable a feature flag in Cargo.toml:
|
||||
|
||||
Simply change your `clap = "3.0.0-beta.1"` to `clap = {version = "3.0.0-beta.1", features = ["yaml"]}`.
|
||||
Simply add the `yaml` feature flag to your `Cargo.toml`.
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
clap = { version = "3.0.0-beta.1", features = ["yaml"] }
|
||||
```
|
||||
|
||||
Finally we create our `main.rs` file just like we would have with the previous two examples:
|
||||
|
||||
```rust
|
||||
```rust,ignore
|
||||
// (Full example with detailed comments in examples/17_yaml.rs)
|
||||
//
|
||||
// This example demonstrates clap's building from YAML style of creating arguments which is far
|
||||
|
|
@ -367,9 +335,39 @@ fn main() {
|
|||
}
|
||||
```
|
||||
|
||||
#### Using Macros
|
||||
|
||||
Finally there is a macro version, which is like a hybrid approach offering the speed of the
|
||||
builder pattern (the first example), but without all the verbosity.
|
||||
|
||||
```rust,no_run
|
||||
use clap::clap_app;
|
||||
|
||||
fn main() {
|
||||
let matches = clap_app!(myapp =>
|
||||
(version: "1.0")
|
||||
(author: "Kevin K. <kbknapp@gmail.com>")
|
||||
(about: "Does awesome things")
|
||||
(@arg CONFIG: -c --config +takes_value "Sets a custom config file")
|
||||
(@arg INPUT: +required "Sets the input file to use")
|
||||
(@arg debug: -d ... "Sets the level of debugging information")
|
||||
(@subcommand test =>
|
||||
(about: "controls testing features")
|
||||
(version: "1.3")
|
||||
(author: "Someone E. <someone_else@other.com>")
|
||||
(@arg verbose: -v --verbose "Print test information verbosely")
|
||||
)
|
||||
).get_matches();
|
||||
|
||||
// Same as previous examples...
|
||||
}
|
||||
```
|
||||
|
||||
#### Running it
|
||||
|
||||
If you were to compile any of the above programs and run them with the flag `--help` or `-h` (or `help` subcommand, since we defined `test` as a subcommand) the following would be output (except the first example where the help message sort of explains the Rust code).
|
||||
|
||||
```sh
|
||||
```bash
|
||||
$ myprog --help
|
||||
My Super Program 1.0
|
||||
Kevin K. <kbknapp@gmail.com>
|
||||
|
|
@ -400,7 +398,7 @@ SUBCOMMANDS:
|
|||
|
||||
### Pre-Built Test
|
||||
|
||||
To try out the pre-built examples, use the following steps:
|
||||
To try out the pre-built [examples][examples], use the following steps:
|
||||
|
||||
* Clone the repository `$ git clone https://github.com/clap-rs/clap && cd clap/`
|
||||
* Compile the example `$ cargo build --example <EXAMPLE>`
|
||||
|
|
@ -408,49 +406,24 @@ To try out the pre-built examples, use the following steps:
|
|||
* Play with the arguments!
|
||||
* You can also do a onetime run via `$ cargo run --example <EXAMPLE> -- [args to example]`
|
||||
|
||||
### BYOB (Build Your Own Binary)
|
||||
### Build Your Own Binary
|
||||
|
||||
To test out `clap`'s default auto-generated help/version follow these steps:
|
||||
* Create a new cargo project `$ cargo new fake --bin && cd fake`
|
||||
* Add `clap` to your `Cargo.toml`
|
||||
* Writer your program as described in the quick example section.
|
||||
* Build your program `$ cargo build --release`
|
||||
* Run with help or version `$ ./target/release/fake --help` or `$ ./target/release/fake --version`
|
||||
|
||||
## Usage
|
||||
|
||||
For full usage, add `clap` as a dependency in your `Cargo.toml` to use from crates.io:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
clap = "3.0.0-beta.1"
|
||||
```
|
||||
|
||||
* Add the following to your `src/main.rs`
|
||||
|
||||
```rust
|
||||
use clap::{App, Clap};
|
||||
|
||||
#[derive(Clap)]
|
||||
#[clap(version = "v1.0-beta")]
|
||||
/// My First clap CLI!
|
||||
struct Opts;
|
||||
|
||||
fn main() {
|
||||
Opts::parse();
|
||||
}
|
||||
```
|
||||
|
||||
* Build your program `$ cargo build --release`
|
||||
* Run with help or version `$ ./target/release/fake --help` or `$ ./target/release/fake --version`
|
||||
|
||||
## Usage
|
||||
|
||||
For full usage, add `clap` as a dependency in your `Cargo.toml` () to use from crates.io:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
clap = "~3.0.0-beta.1"
|
||||
```
|
||||
|
||||
(**note**: If you are concerned with supporting a minimum version of Rust that is *older* than the current stable Rust minus 2 stable releases, it's recommended to use the `~major.minor.patch` style versions in your `Cargo.toml` which will only update the patch version automatically. For more information see the [Compatibility Policy](#compatibility-policy))
|
||||
|
||||
Then add `extern crate clap;` to your crate root.
|
||||
|
||||
Define a list of valid arguments for your program (see the [documentation](https://docs.rs/clap/) or [examples/](examples) directory of this repo)
|
||||
Define a list of valid arguments for your program (see the [documentation][docs] or [examples][examples] directory of this repo)
|
||||
|
||||
Then run `cargo build` or `cargo update && cargo build` for your project.
|
||||
|
||||
|
|
@ -460,8 +433,7 @@ Then run `cargo build` or `cargo update && cargo build` for your project.
|
|||
|
||||
* **derive**: Enables the custom derive (i.e. `#[derive(Clap)]`). Without this you must use one of the other methods of creating a `clap` CLI listed above
|
||||
* **suggestions**: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
|
||||
* **color**: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term`)
|
||||
* **vec_map**: Use [`VecMap`](https://crates.io/crates/vec_map) internally instead of a [`BTreeMap`](https://doc.rust-lang.org/stable/std/collections/struct.BTreeMap.html). This feature provides a _slight_ performance improvement. (builds dependency `vec_map`)
|
||||
* **color**: Turns on colored error messages. (builds dependency `termcolor`)
|
||||
|
||||
To disable these, add this to your `Cargo.toml`:
|
||||
|
||||
|
|
@ -488,23 +460,13 @@ features = [ "suggestions", "color" ]
|
|||
* **"unstable"**: Enables unstable `clap` features that may change from release to release
|
||||
* **"wrap_help"**: Turns on the help text wrapping feature, based on the terminal size. (builds dependency `term-size`)
|
||||
|
||||
### Dependencies Tree
|
||||
|
||||
@TODO-v3-beta: update
|
||||
|
||||
### More Information
|
||||
|
||||
You can find complete documentation on the [docs.rs](https://docs.rs/clap/) for this project.
|
||||
You can find complete documentation on the [docs.rs][docs] for this project.
|
||||
|
||||
You can also find usage examples in the [examples/](examples) directory of this repo.
|
||||
You can also find usage examples in the [examples][examples] directory of this repo.
|
||||
|
||||
#### Video Tutorials
|
||||
|
||||
There's also the video tutorial series [Argument Parsing with Rust v2](https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U).
|
||||
|
||||
These videos slowly trickle out as I finish them and currently a work in progress.
|
||||
|
||||
## How to Contribute
|
||||
## Contributing
|
||||
|
||||
Details on how to contribute can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
|
||||
|
||||
|
|
@ -523,79 +485,24 @@ clap = "~3.0.0-beta.1"
|
|||
|
||||
This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore cannot break due to new features, or bumped minimum versions of Rust.
|
||||
|
||||
#### Warning about '~' Dependencies
|
||||
|
||||
Using `~` can cause issues in certain circumstances.
|
||||
|
||||
From @alexcrichton:
|
||||
|
||||
Right now Cargo's version resolution is pretty naive, it's just a brute-force search of the solution space, returning the first resolvable graph. This also means that it currently won't terminate until it proves there is not possible resolvable graph. This leads to situations where workspaces with multiple binaries, for example, have two different dependencies such as:
|
||||
|
||||
```toml,no_sync
|
||||
|
||||
# In one Cargo.toml
|
||||
[dependencies]
|
||||
clap = "~3.0.0-beta.1"
|
||||
|
||||
# In another Cargo.toml
|
||||
[dependencies]
|
||||
clap = "3.0.0-beta.1"
|
||||
```
|
||||
|
||||
This is inherently an unresolvable crate graph in Cargo right now. Cargo requires there's only one major version of a crate, and being in the same workspace these two crates must share a version. This is impossible in this location, though, as these version constraints cannot be met.
|
||||
|
||||
#### Minimum Supported Version of Rust (MSRV)
|
||||
|
||||
`clap` will officially support current stable Rust, minus two releases, but may work with prior releases as well. For example, current stable Rust at the time of this writing is 1.38.0, meaning `clap` is guaranteed to compile with 1.36.0 and beyond.
|
||||
|
||||
At the 1.39.0 stable release, `clap` will be guaranteed to compile with 1.37.0 and beyond, etc.
|
||||
|
||||
Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be clearly annotated in the `CHANGELOG.md`
|
||||
The following is a list of the minimum required version of Rust to compile `clap` by our `MAJOR.MINOR` version number:
|
||||
|
||||
The following is a list of the minimum required version of Rust to compile `clap` by our `MAJOR.MINOR` version number (generated by [`cargo-msrv-table`](https://github.com/kbknapp/cargo-msrv-table)):
|
||||
|
||||
|clap| MSRV |
|
||||
|---| --- |
|
||||
|2.33| 1.24.1|
|
||||
|2.32| 1.24.1|
|
||||
|2.31| 1.24.1|
|
||||
|2.30| 1.24.1|
|
||||
|2.29| 1.24.1|
|
||||
|2.28| 1.24.1|
|
||||
|2.27| 1.24.1|
|
||||
|2.26| 1.24.1|
|
||||
|2.25| 1.24.1|
|
||||
|2.24| 1.24.1|
|
||||
|2.23| 1.24.1|
|
||||
|2.22| 1.24.1|
|
||||
|2.21| 1.24.1|
|
||||
|2.20| 1.21.0|
|
||||
|2.19| 1.12.1|
|
||||
|2.18| 1.12.1|
|
||||
|2.17| 1.12.1|
|
||||
|2.16| 1.12.1|
|
||||
|2.15| 1.12.1|
|
||||
|2.14| 1.12.1|
|
||||
|2.13| 1.12.1|
|
||||
|2.12| 1.12.1|
|
||||
|2.11| 1.12.1|
|
||||
|2.10| 1.12.1|
|
||||
|2.9| 1.12.1|
|
||||
|2.8| 1.12.1|
|
||||
|2.7| 1.12.1|
|
||||
|2.6| 1.12.1|
|
||||
|2.5| 1.12.1|
|
||||
|2.4| 1.12.1|
|
||||
|2.3| 1.12.1|
|
||||
|2.2| 1.12.1|
|
||||
|2.1| 1.6.0|
|
||||
|2.0| 1.4.0|
|
||||
|1.5| 1.4.0|
|
||||
|1.4| 1.2.0|
|
||||
|1.3| 1.1.0|
|
||||
|1.2| 1.1.0|
|
||||
|1.1| 1.0.0|
|
||||
|1.0| 1.0.0|
|
||||
| clap | MSRV |
|
||||
| :----: | :----: |
|
||||
| >=3.0 | 1.40.0 |
|
||||
| >=2.21 | 1.24.0 |
|
||||
| >=2.2 | 1.12.0 |
|
||||
| >=2.1 | 1.6.0 |
|
||||
| >=1.5 | 1.4.0 |
|
||||
| >=1.4 | 1.2.0 |
|
||||
| >=1.2 | 1.1.0 |
|
||||
| >=1.0 | 1.0.0 |
|
||||
|
||||
#### Breaking Changes
|
||||
|
||||
|
|
@ -615,61 +522,7 @@ See the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files in
|
|||
|
||||
There are several excellent crates which can be used with `clap`, I recommend checking them all out! If you've got a crate that would be a good fit to be used with `clap` open an issue and let me know, I'd love to add it!
|
||||
|
||||
* [`structopt`](https://github.com/TeXitoi/structopt) - This crate allows you to define a struct, and build a CLI from it! No more "stringly typed" and it uses `clap` behind the scenes! (*Note*: There is work underway to pull this crate into mainline `clap`).
|
||||
* [`assert_cmd`](https://github.com/assert-rs/assert_cmd) - This crate allows you test your CLIs in a very intuitive and functional way!
|
||||
|
||||
## Recent Breaking Changes
|
||||
|
||||
`clap` follows semantic versioning, so breaking changes should only happen upon major version bumps. The only exception to this rule is breaking changes that happen due to implementation that was deemed to be a bug, security concerns, or it can be reasonably proved to affect no code. For the full details, see [CHANGELOG.md](./CHANGELOG.md).
|
||||
|
||||
As of 2.27.0:
|
||||
|
||||
* Argument values now take precedence over subcommand names. This only arises by using unrestrained multiple values and subcommands together where the subcommand name can coincide with one of the multiple values. Such as `$ prog <files>... <subcommand>`. The fix is to place restraints on number of values, or disallow the use of `$ prog <prog-args> <subcommand>` structure.
|
||||
|
||||
As of 2.0.0 (From 1.x)
|
||||
|
||||
* **Fewer lifetimes! Yay!**
|
||||
* `App<'a, 'b, 'c, 'd, 'e, 'f>` => `App<'a, 'b>`
|
||||
* `Arg<'a, 'b, 'c, 'd, 'e, 'f>` => `Arg<'a, 'b>`
|
||||
* `ArgMatches<'a, 'b>` => `ArgMatches<'a>`
|
||||
* **Simply Renamed**
|
||||
* `App::arg_group` => `App::group`
|
||||
* `App::arg_groups` => `App::groups`
|
||||
* `ArgGroup::add` => `ArgGroup::arg`
|
||||
* `ArgGroup::add_all` => `ArgGroup::args`
|
||||
* `ClapError` => `Error`
|
||||
* struct field `ClapError::error_type` => `Error::kind`
|
||||
* `ClapResult` => `Result`
|
||||
* `ClapErrorType` => `ErrorKind`
|
||||
* **Removed Deprecated Functions and Methods**
|
||||
* `App::subcommands_negate_reqs`
|
||||
* `App::subcommand_required`
|
||||
* `App::arg_required_else_help`
|
||||
* `App::global_version(bool)`
|
||||
* `App::versionless_subcommands`
|
||||
* `App::unified_help_messages`
|
||||
* `App::wait_on_error`
|
||||
* `App::subcommand_required_else_help`
|
||||
* `SubCommand::new`
|
||||
* `App::error_on_no_subcommand`
|
||||
* `Arg::new`
|
||||
* `Arg::mutually_excludes`
|
||||
* `Arg::mutually_excludes_all`
|
||||
* `Arg::mutually_overrides_with`
|
||||
* `simple_enum!`
|
||||
* **Renamed Error Variants**
|
||||
* `InvalidUnicode` => `InvalidUtf8`
|
||||
* `InvalidArgument` => `UnknownArgument`
|
||||
* **Usage Parser**
|
||||
* Value names can now be specified inline, i.e. `-o, --option <FILE> <FILE2> 'some option which takes two files'`
|
||||
* **There is now a priority of order to determine the name** - This is perhaps the biggest breaking change. See the documentation for full details. Prior to this change, the value name took precedence. **Ensure your args are using the proper names (i.e. typically the long or short and NOT the value name) throughout the code**
|
||||
* `ArgMatches::values_of` returns an `Values` now which implements `Iterator` (should not break any code)
|
||||
* `crate_version!` returns `&'static str` instead of `String`
|
||||
|
||||
### Deprecations
|
||||
|
||||
Old method names will be left around for several minor version bumps, or one major version bump.
|
||||
|
||||
As of 2.27.0:
|
||||
|
||||
* **AppSettings::PropagateGlobalValuesDown:** this setting deprecated and is no longer required to propagate values down or up
|
||||
[docs]: https://docs.rs/clap
|
||||
[examples]: examples
|
||||
|
|
|
|||
433
src/lib.rs
433
src/lib.rs
|
|
@ -1,436 +1,11 @@
|
|||
// Copyright ⓒ 2015-2016 Kevin B. Knapp and [`clap-rs` contributors](https://github.com/kbknapp/clap-rs/blob/master/CONTRIBUTORS.md).
|
||||
// Copyright ⓒ 2015-2016 Kevin B. Knapp and [`clap-rs` contributors](https://github.com/clap-rs/clap/graphs/contributors).
|
||||
// Licensed under the MIT license
|
||||
// (see LICENSE or <http://opensource.org/licenses/MIT>) All files in the project carrying such
|
||||
// notice may not be copied, modified, or distributed except according to those terms.
|
||||
|
||||
//! `clap` is a simple-to-use, efficient, and full-featured library for parsing command line
|
||||
//! arguments and subcommands when writing console/terminal applications.
|
||||
//!
|
||||
//! ## About
|
||||
//!
|
||||
//! `clap` is used to parse *and validate* the string of command line arguments provided by the user
|
||||
//! at runtime. You provide the list of valid possibilities, and `clap` handles the rest. This means
|
||||
//! you focus on your *applications* functionality, and less on the parsing and validating of
|
||||
//! arguments.
|
||||
//!
|
||||
//! `clap` also provides the traditional version and help switches (or flags) 'for free' meaning
|
||||
//! automatically with no configuration. It does this by checking the list of valid possibilities you
|
||||
//! supplied and adding only the ones you haven't already defined. If you are using subcommands,
|
||||
//! `clap` will also auto-generate a `help` subcommand for you in addition to the traditional flags.
|
||||
//!
|
||||
//! Once `clap` parses the user provided string of arguments, it returns the matches along with any
|
||||
//! applicable values. If the user made an error or typo, `clap` informs them of the mistake and
|
||||
//! exits gracefully (or returns a `Result` type and allows you to perform any clean up prior to
|
||||
//! exit). Because of this, you can make reasonable assumptions in your code about the validity of
|
||||
//! the arguments.
|
||||
//!
|
||||
//!
|
||||
//! ## Quick Example
|
||||
//!
|
||||
//! The following examples show a quick example of some of the very basic functionality of `clap`.
|
||||
//! For more advanced usage, such as requirements, conflicts, groups, multiple values and
|
||||
//! occurrences see the [documentation](https://docs.rs/clap/), [examples/] directory of
|
||||
//! this repository or the [video tutorials].
|
||||
//!
|
||||
//! **NOTE:** All of these examples are functionally the same, but show different styles in which to
|
||||
//! use `clap`
|
||||
//!
|
||||
//! The first example shows a method that allows more advanced configuration options (not shown in
|
||||
//! this small example), or even dynamically generating arguments when desired. The downside is it's
|
||||
//! more verbose.
|
||||
//!
|
||||
//! ```no_run
|
||||
//! // (Full example with detailed comments in examples/01b_quick_example.rs)
|
||||
//! //
|
||||
//! // This example demonstrates clap's full 'builder pattern' style of creating arguments which is
|
||||
//! // more verbose, but allows easier editing, and at times more advanced options, or the possibility
|
||||
//! // to generate arguments dynamically.
|
||||
//! use clap::{Arg, App, };
|
||||
//!
|
||||
//! fn main() {
|
||||
//! let matches = App::new("My Super Program")
|
||||
//! .version("1.0")
|
||||
//! .author("Kevin K. <kbknapp@gmail.com>")
|
||||
//! .about("Does awesome things")
|
||||
//! .arg(Arg::with_name("config")
|
||||
//! .short('c')
|
||||
//! .long("config")
|
||||
//! .value_name("FILE")
|
||||
//! .help("Sets a custom config file")
|
||||
//! .takes_value(true))
|
||||
//! .arg(Arg::with_name("INPUT")
|
||||
//! .help("Sets the input file to use")
|
||||
//! .required(true)
|
||||
//! .index(1))
|
||||
//! .arg(Arg::with_name("v")
|
||||
//! .short('v')
|
||||
//! .multiple(true)
|
||||
//! .help("Sets the level of verbosity"))
|
||||
//! .subcommand(App::new("test")
|
||||
//! .about("controls testing features")
|
||||
//! .version("1.3")
|
||||
//! .author("Someone E. <someone_else@other.com>")
|
||||
//! .arg(Arg::with_name("debug")
|
||||
//! .short('d')
|
||||
//! .help("print debug information verbosely")))
|
||||
//! .get_matches();
|
||||
//!
|
||||
//! // Gets a value for config if supplied by user, or defaults to "default.conf"
|
||||
//! let config = matches.value_of("config").unwrap_or("default.conf");
|
||||
//! println!("Value for config: {}", config);
|
||||
//!
|
||||
//! // Calling .unwrap() is safe here because "INPUT" is required (if "INPUT" wasn't
|
||||
//! // required we could have used an 'if let' to conditionally get the value)
|
||||
//! println!("Using input file: {}", matches.value_of("INPUT").unwrap());
|
||||
//!
|
||||
//! // Vary the output based on how many times the user used the "verbose" flag
|
||||
//! // (i.e. 'myprog -v -v -v' or 'myprog -vvv' vs 'myprog -v'
|
||||
//! match matches.occurrences_of("v") {
|
||||
//! 0 => println!("No verbose info"),
|
||||
//! 1 => println!("Some verbose info"),
|
||||
//! 2 => println!("Tons of verbose info"),
|
||||
//! 3 | _ => println!("Don't be crazy"),
|
||||
//! }
|
||||
//!
|
||||
//! // You can handle information about subcommands by requesting their matches by name
|
||||
//! // (as below), requesting just the name used, or both at the same time
|
||||
//! if let Some(matches) = matches.subcommand_matches("test") {
|
||||
//! if matches.is_present("debug") {
|
||||
//! println!("Printing debug info...");
|
||||
//! } else {
|
||||
//! println!("Printing normally...");
|
||||
//! }
|
||||
//! }
|
||||
//!
|
||||
//! // more program logic goes here...
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! The next example shows a far less verbose method, but sacrifices some of the advanced
|
||||
//! configuration options (not shown in this small example). This method also takes a *very* minor
|
||||
//! runtime penalty.
|
||||
//!
|
||||
//! ```no_run
|
||||
//! // (Full example with detailed comments in examples/01a_quick_example.rs)
|
||||
//! //
|
||||
//! // This example demonstrates clap's "usage strings" method of creating arguments
|
||||
//! // which is less verbose
|
||||
//! use clap::{Arg, App, };
|
||||
//!
|
||||
//! fn main() {
|
||||
//! let matches = App::new("myapp")
|
||||
//! .version("1.0")
|
||||
//! .author("Kevin K. <kbknapp@gmail.com>")
|
||||
//! .about("Does awesome things")
|
||||
//! .arg("-c, --config=[FILE] 'Sets a custom config file'")
|
||||
//! .arg("<INPUT> 'Sets the input file to use'")
|
||||
//! .arg("-v... 'Sets the level of verbosity'")
|
||||
//! .subcommand(App::new("test")
|
||||
//! .about("controls testing features")
|
||||
//! .version("1.3")
|
||||
//! .author("Someone E. <someone_else@other.com>")
|
||||
//! .arg("-d, --debug 'Print debug information'"))
|
||||
//! .get_matches();
|
||||
//!
|
||||
//! // Same as previous example...
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! This third method shows how you can use a YAML file to build your CLI and keep your Rust source
|
||||
//! tidy or support multiple localized translations by having different YAML files for each
|
||||
//! localization.
|
||||
//!
|
||||
//! First, create the `cli.yml` file to hold your CLI options, but it could be called anything we
|
||||
//! like:
|
||||
//!
|
||||
//! ```yaml
|
||||
//! name: myapp
|
||||
//! version: "1.0"
|
||||
//! author: Kevin K. <kbknapp@gmail.com>
|
||||
//! about: Does awesome things
|
||||
//! args:
|
||||
//! - config:
|
||||
//! short: c
|
||||
//! long: config
|
||||
//! value_name: FILE
|
||||
//! help: Sets a custom config file
|
||||
//! takes_value: true
|
||||
//! - INPUT:
|
||||
//! help: Sets the input file to use
|
||||
//! required: true
|
||||
//! index: 1
|
||||
//! - verbose:
|
||||
//! short: v
|
||||
//! multiple: true
|
||||
//! help: Sets the level of verbosity
|
||||
//! subcommands:
|
||||
//! - test:
|
||||
//! about: controls testing features
|
||||
//! version: "1.3"
|
||||
//! author: Someone E. <someone_else@other.com>
|
||||
//! args:
|
||||
//! - debug:
|
||||
//! short: d
|
||||
//! help: print debug information
|
||||
//! ```
|
||||
//!
|
||||
//! Since this feature requires additional dependencies that not everyone may want, it is *not*
|
||||
//! compiled in by default and we need to enable a feature flag in Cargo.toml:
|
||||
//!
|
||||
//! Simply change your `clap = "~2.27.0"` to `clap = {version = "~2.27.0", features = ["yaml"]}`.
|
||||
//!
|
||||
//! At last we create our `main.rs` file just like we would have with the previous two examples:
|
||||
//!
|
||||
//! ```ignore
|
||||
//! // (Full example with detailed comments in examples/17_yaml.rs)
|
||||
//! //
|
||||
//! // This example demonstrates clap's building from YAML style of creating arguments which is far
|
||||
//! // more clean, but takes a very small performance hit compared to the other two methods.
|
||||
//! use clap::App;
|
||||
//!
|
||||
//! fn main() {
|
||||
//! // The YAML file is found relative to the current file, similar to how modules are found
|
||||
//! let yaml = load_yaml!("cli.yml");
|
||||
//! let matches = App::from_yaml(yaml).get_matches();
|
||||
//!
|
||||
//! // Same as previous examples...
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Finally there is a macro version, which is like a hybrid approach offering the speed of the
|
||||
//! builder pattern (the first example), but without all the verbosity.
|
||||
//!
|
||||
//! ```no_run
|
||||
//! use clap::clap_app;
|
||||
//! fn main() {
|
||||
//! let matches = clap_app!(myapp =>
|
||||
//! (version: "1.0")
|
||||
//! (author: "Kevin K. <kbknapp@gmail.com>")
|
||||
//! (about: "Does awesome things")
|
||||
//! (@arg CONFIG: -c --config +takes_value "Sets a custom config file")
|
||||
//! (@arg INPUT: +required "Sets the input file to use")
|
||||
//! (@arg debug: -d ... "Sets the level of debugging information")
|
||||
//! (@subcommand test =>
|
||||
//! (about: "controls testing features")
|
||||
//! (version: "1.3")
|
||||
//! (author: "Someone E. <someone_else@other.com>")
|
||||
//! (@arg verbose: -v --verbose "Print test information verbosely")
|
||||
//! )
|
||||
//! ).get_matches();
|
||||
//!
|
||||
//! // Same as before...
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! If you were to compile any of the above programs and run them with the flag `--help` or `-h` (or
|
||||
//! `help` subcommand, since we defined `test` as a subcommand) the following would be output
|
||||
//!
|
||||
//! ```text
|
||||
//! $ myprog --help
|
||||
//! My Super Program 1.0
|
||||
//! Kevin K. <kbknapp@gmail.com>
|
||||
//! Does awesome things
|
||||
//!
|
||||
//! USAGE:
|
||||
//! MyApp [FLAGS] [OPTIONS] <INPUT> [SUBCOMMAND]
|
||||
//!
|
||||
//! FLAGS:
|
||||
//! -h, --help Prints this message
|
||||
//! -v Sets the level of verbosity
|
||||
//! -V, --version Prints version information
|
||||
//!
|
||||
//! OPTIONS:
|
||||
//! -c, --config <FILE> Sets a custom config file
|
||||
//!
|
||||
//! ARGS:
|
||||
//! INPUT The input file to use
|
||||
//!
|
||||
//! SUBCOMMANDS:
|
||||
//! help Prints this message
|
||||
//! test Controls testing features
|
||||
//! ```
|
||||
//!
|
||||
//! **NOTE:** You could also run `myapp test --help` to see similar output and options for the
|
||||
//! `test` subcommand.
|
||||
//!
|
||||
//! ## Try it!
|
||||
//!
|
||||
//! ### Pre-Built Test
|
||||
//!
|
||||
//! To try out the pre-built example, use the following steps:
|
||||
//!
|
||||
//! * Clone the repository `$ git clone https://github.com/kbknapp/clap-rs && cd clap-rs/tests`
|
||||
//! * Compile the example `$ cargo build --release`
|
||||
//! * Run the help info `$ ./target/release/claptests --help`
|
||||
//! * Play with the arguments!
|
||||
//!
|
||||
//! ### BYOB (Build Your Own Binary)
|
||||
//!
|
||||
//! To test out `clap`'s default auto-generated help/version follow these steps:
|
||||
//!
|
||||
//! * Create a new cargo project `$ cargo new fake --bin && cd fake`
|
||||
//! * Add `clap` to your `Cargo.toml`
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! clap = "2"
|
||||
//! ```
|
||||
//!
|
||||
//! * Add the following to your `src/main.rs`
|
||||
//!
|
||||
//! ```no_run
|
||||
//! use clap::App;
|
||||
//!
|
||||
//! fn main() {
|
||||
//! App::new("fake").version("v1.0-beta").get_matches();
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! * Build your program `$ cargo build --release`
|
||||
//! * Run with help or version `$ ./target/release/fake --help` or `$ ./target/release/fake
|
||||
//! --version`
|
||||
//!
|
||||
//! ## Usage
|
||||
//!
|
||||
//! For full usage, add `clap` as a dependency in your `Cargo.toml` (it is **highly** recommended to
|
||||
//! use the `~major.minor.patch` style versions in your `Cargo.toml`, for more information see
|
||||
//! [Compatibility Policy](#compatibility-policy)) to use from crates.io:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies]
|
||||
//! clap = "~2.27.0"
|
||||
//! ```
|
||||
//!
|
||||
//! Or get the latest changes from the master branch at github:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies.clap]
|
||||
//! git = "https://github.com/kbknapp/clap-rs.git"
|
||||
//! ```
|
||||
//!
|
||||
//! Define a list of valid arguments for your program (see the
|
||||
//! [documentation](https://docs.rs/clap/) or [examples/] directory of this repo)
|
||||
//!
|
||||
//! Then run `cargo build` or `cargo update && cargo build` for your project.
|
||||
//!
|
||||
//! ### Optional Dependencies / Features
|
||||
//!
|
||||
//! #### Features enabled by default
|
||||
//!
|
||||
//! * `derive`: Enables the custom derive (i.e. `#[derive(Clap)]`). Without this you must use one of the other methods of creating a `clap` CLI listed above
|
||||
//! * `suggestions`: Turns on the `Did you mean '--myoption'?` feature for when users make typos. (builds dependency `strsim`)
|
||||
//! * `color`: Turns on colored error messages. This feature only works on non-Windows OSs. (builds dependency `ansi-term`)
|
||||
//!
|
||||
//! To disable these, add this to your `Cargo.toml`:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies.clap]
|
||||
//! version = "~2.27.0"
|
||||
//! default-features = false
|
||||
//! ```
|
||||
//!
|
||||
//! You can also selectively enable only the features you'd like to include, by adding:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies.clap]
|
||||
//! version = "~2.27.0"
|
||||
//! default-features = false
|
||||
//!
|
||||
//! # Cherry-pick the features you'd like to use
|
||||
//! features = [ "suggestions", "color" ]
|
||||
//! ```
|
||||
//!
|
||||
//! #### Opt-in features
|
||||
//!
|
||||
//! * **"yaml"**: Enables building CLIs from YAML documents. (builds dependency `yaml-rust`)
|
||||
//! * **"unstable"**: Enables unstable `clap` features that may change from release to release
|
||||
//! * **"wrap_help"**: Turns on the help text wrapping feature, based on the terminal size. (builds dependency `term-size`)
|
||||
//!
|
||||
//! ### Dependencies Tree
|
||||
//!
|
||||
//! The following graphic depicts `clap`s dependency graph (generated using
|
||||
//! [cargo-graph](https://github.com/kbknapp/cargo-graph)).
|
||||
//!
|
||||
//! * **Dashed** Line: Optional dependency
|
||||
//! * **Red** Color: **NOT** included by default (must use cargo `features` to enable)
|
||||
//! * **Blue** Color: Dev dependency, only used while developing.
|
||||
//!
|
||||
//! 
|
||||
//!
|
||||
//! ### More Information
|
||||
//!
|
||||
//! You can find complete documentation on the [docs.rs](https://docs.rs/clap/) for this project.
|
||||
//!
|
||||
//! You can also find usage examples in the [examples/] directory of this repo.
|
||||
//!
|
||||
//! #### Video Tutorials
|
||||
//!
|
||||
//! There's also the video tutorial series [Argument Parsing with Rust v2][video tutorials].
|
||||
//!
|
||||
//! These videos slowly trickle out as I finish them and currently a work in progress.
|
||||
//!
|
||||
//! ## How to Contribute
|
||||
//!
|
||||
//! Please read [CONTRIBUTING.md](https://raw.githubusercontent.com/clap-rs/clap/master/.github/CONTRIBUTING.md) before you start contributing.
|
||||
//!
|
||||
//! ### Goals
|
||||
//!
|
||||
//! There are a few goals of `clap` that I'd like to maintain throughout contributions. If your
|
||||
//! proposed changes break, or go against any of these goals we'll discuss the changes further
|
||||
//! before merging (but will *not* be ignored, all contributes are welcome!). These are by no means
|
||||
//! hard-and-fast rules, as I'm no expert and break them myself from time to time (even if by
|
||||
//! mistake or ignorance).
|
||||
//!
|
||||
//! * Remain backwards compatible when possible
|
||||
//! - If backwards compatibility *must* be broken, use deprecation warnings if at all possible before
|
||||
//! removing legacy code - This does not apply for security concerns
|
||||
//! * Parse arguments quickly
|
||||
//! - Parsing of arguments shouldn't slow down usage of the main program - This is also true of
|
||||
//! generating help and usage information (although *slightly* less stringent, as the program is about
|
||||
//! to exit)
|
||||
//! * Try to be cognizant of memory usage
|
||||
//! - Once parsing is complete, the memory footprint of `clap` should be low since the main program
|
||||
//! is the star of the show
|
||||
//! * `panic!` on *developer* error, exit gracefully on *end-user* error
|
||||
//!
|
||||
//! ### Compatibility Policy
|
||||
//!
|
||||
//! Because `clap` takes `SemVer` and compatibility seriously, this is the official policy regarding
|
||||
//! breaking changes and previous versions of Rust.
|
||||
//!
|
||||
//! `clap` will pin the minimum required version of Rust to the CI builds. Bumping the minimum
|
||||
//! version of Rust is considered a minor breaking change, meaning *at a minimum* the minor version
|
||||
//! of `clap` will be bumped.
|
||||
//!
|
||||
//! In order to keep from being suprised of breaking changes, it is **highly** recommended to use
|
||||
//! the `~major.minor.patch` style in your `Cargo.toml`:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [dependencies] clap = "~2.27.0"
|
||||
//! ```
|
||||
//!
|
||||
//! This will cause *only* the patch version to be updated upon a `cargo update` call, and therefore
|
||||
//! cannot break due to new features, or bumped minimum versions of Rust.
|
||||
//!
|
||||
//! #### Minimum Version of Rust
|
||||
//!
|
||||
//! `clap` will officially support current stable Rust, minus two releases, but may work with prior
|
||||
//! releases as well. For example, current stable Rust at the time of this writing is 1.21.0,
|
||||
//! meaning `clap` is guaranteed to compile with 1.19.0 and beyond. At the 1.22.0 release, `clap`
|
||||
//! will be guaranteed to compile with 1.20.0 and beyond, etc.
|
||||
//!
|
||||
//! Upon bumping the minimum version of Rust (assuming it's within the stable-2 range), it *must* be
|
||||
//! clearly annotated in the `CHANGELOG.md`
|
||||
//!
|
||||
//! ## License
|
||||
//!
|
||||
//! `clap` is licensed under the MIT license. Please read the [LICENSE-MIT][license] file in
|
||||
//! this repository for more information.
|
||||
//!
|
||||
//! [examples/]: https://github.com/kbknapp/clap-rs/tree/master/examples
|
||||
//! [video tutorials]: https://www.youtube.com/playlist?list=PLza5oFLQGTl2Z5T8g1pRkIynR3E0_pc7U
|
||||
//! [license]: https://raw.githubusercontent.com/kbknapp/clap-rs/master/LICENSE-MIT
|
||||
|
||||
#![cfg_attr(feature = "doc", feature(external_doc))]
|
||||
#![cfg_attr(feature = "doc", doc(include = "../README.md"))]
|
||||
//! https://github.com/clap-rs/clap
|
||||
#![crate_type = "lib"]
|
||||
#![doc(html_root_url = "https://docs.rs/clap/3.0.0-beta.1")]
|
||||
#![deny(
|
||||
|
|
|
|||
Loading…
Reference in a new issue