Clientele.rs

Clientele makes it easy to write superb command-line utilities in Rust that follow consistent best practices on all target platforms including Linux, macOS, and Windows. It packages and re-exports clap, camino, dotenvy, wild, argfile, and getenv into a single easy dependency.

✨ Features

Showcases how to structure a CLI program in Rust (see the examples).
Loads environment variables from .env files (using the dotenvy crate).
Provides convenience getters for common variables (using the getenv crate).
Expands wildcard arguments (globs) on Windows (using the wild crate).
Expands @argfiles similarly to javac or Python (using the argfile crate).
Defines a standard set of essential CLI options (using the clap crate).
Provides the Utf8Path and Utf8PathBuf types (using the camino crate).
Recommends use of the sysexits.h(3) exit codes (see sysexits.rs).
Supports opting out of any feature using comprehensive feature flags.
Adheres to the Rust API Guidelines in its naming conventions.
100% free and unencumbered public domain software.

🛠️ Prerequisites

Rust 1.81+

⬇️ Installation

Installation via Cargo

cargo add clientele

Installation in `Cargo.toml` (with all features enabled)

[dependencies]
clientele = "0.3"

Installation in `Cargo.toml` (with only specific features enabled)

[dependencies]
clientele = { version = "0.3", default-features = false, features = ["dotenv"] }

👉 Examples

See lib/clientele/examples/skeleton/main.rs for a complete example.

Importing the library

use clientele::*;

Running the example

cargo run --example skeleton

📚 Reference

Options

`StandardOptions`

Options:
      --color <COLOR>  Set the color output mode [default: auto] [possible values: auto, always, never]
  -d, --debug          Enable debugging output
      --license        Show license information
  -v, --verbose...     Enable verbose output (may be repeated for more verbosity)
  -V, --version        Print version information
  -h, --help           Print help

👨‍💻 Development

git clone https://github.com/dryrust/clientele.rs.git

clientele 0.3.1