| // 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. |
| |
| //! > **Command Line Argument Parser for Rust** |
| //! |
| //! Quick Links: |
| //! - Derive [tutorial][_derive::_tutorial::chapter_0] and [reference][_derive] |
| //! - Builder [tutorial][_tutorial::chapter_0] and [reference](index.html) |
| //! - [Cookbook][_cookbook] |
| //! - [FAQ][_faq] |
| //! - [Discussions](https://github.com/clap-rs/clap/discussions) |
| //! - [CHANGELOG](https://github.com/clap-rs/clap/blob/v4.5.18/CHANGELOG.md) (includes major version migration |
| //! guides) |
| //! |
| //! ## 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](https://github.com/clap-rs/clap/tree/master/clap_complete), 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](https://github.com/rust-cli/team/) 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.74) |
| //! |
| //! 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](https://github.com/rust-cli/argparse-benchmarks-rs) for |
| //! CLI parsers optimized for other use cases. |
| //! |
| //! ## Example |
| //! |
| //! Run |
| //! ```console |
| //! $ cargo add clap --features derive |
| //! ``` |
| //! *(See also [feature flag reference][_features])* |
| //! |
| //! Then define your CLI in `main.rs`: |
| //! ```rust |
| //! # #[cfg(feature = "derive")] { |
| #![doc = include_str!("../examples/demo.rs")] |
| //! # } |
| //! ``` |
| //! |
| //! And try it out: |
| #![doc = include_str!("../examples/demo.md")] |
| //! |
| //! See also the derive [tutorial][_derive::_tutorial] and [reference][_derive] |
| //! |
| //! ### Related Projects |
| //! |
| //! Augment clap: |
| //! - [wild](https://crates.io/crates/wild) for supporting wildcards (`*`) on Windows like you do Linux |
| //! - [argfile](https://crates.io/crates/argfile) for loading additional arguments from a file (aka response files) |
| //! - [shadow-rs](https://crates.io/crates/shadow-rs) for generating `Command::long_version` |
| //! - [clap_mangen](https://crates.io/crates/clap_mangen) for generating man page source (roff) |
| //! - [clap_complete](https://crates.io/crates/clap_complete) for shell completion support |
| //! |
| //! CLI Helpers |
| //! - [clio](https://crates.io/crates/clio) for reading/writing to files specified as arguments |
| //! - [clap-verbosity-flag](https://crates.io/crates/clap-verbosity-flag) |
| //! - [clap-cargo](https://crates.io/crates/clap-cargo) |
| //! - [concolor-clap](https://crates.io/crates/concolor-clap) |
| //! |
| //! Testing |
| //! - [`trycmd`](https://crates.io/crates/trycmd): Bulk snapshot testing |
| //! - [`snapbox`](https://crates.io/crates/snapbox): Specialized snapshot testing |
| //! - [`assert_cmd`](https://crates.io/crates/assert_cmd) and [`assert_fs`](https://crates.io/crates/assert_fs): Customized testing |
| //! |
| //! Documentation: |
| //! - [Command-line Apps for Rust](https://rust-cli.github.io/book/index.html) book |
| //! |
| |
| #![doc(html_logo_url = "https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png")] |
| #![cfg_attr(docsrs, feature(doc_auto_cfg))] |
| #![forbid(unsafe_code)] |
| #![warn(missing_docs)] |
| #![warn(clippy::print_stderr)] |
| #![warn(clippy::print_stdout)] |
| |
| pub use clap_builder::*; |
| #[cfg(feature = "derive")] |
| #[doc(hidden)] |
| pub use clap_derive::{self, Args, Parser, Subcommand, ValueEnum}; |
| |
| #[cfg(feature = "unstable-doc")] |
| pub mod _cookbook; |
| #[cfg(feature = "unstable-doc")] |
| pub mod _derive; |
| #[cfg(feature = "unstable-doc")] |
| pub mod _faq; |
| #[cfg(feature = "unstable-doc")] |
| pub mod _features; |
| #[cfg(feature = "unstable-doc")] |
| pub mod _tutorial; |
