Skip to main content

Crate cli_battery_pack

Crate cli_battery_pack 

Source
Expand description

§cli-battery-pack

A battery pack for building CLI applications in Rust.

§What’s Included

CrateWhat it does
anstreamAuto-detecting stream for terminal color support
anstyleANSI text styling
anstyle-hyperlinkANSI hyperlink support
supports-hyperlinksDetect terminal hyperlink support
anyhowErgonomic error handling for applications
clapCommand-line argument parsing with derive macros
colorchoice-clapClap argument for controlling color output
wildGlob argument expansion (for Windows compatibility)
dialoguerInteractive prompts and user input
human-panicHuman-friendly panic messages

§Dev dependencies

CrateWhat it does
snapboxSnapshot testing for CLI commands

§Optional features

  • indicators: indicatif for progress bars, console for terminal styling
  • search: regex for pattern matching, ignore for gitignore-aware file walking
  • config: etcetera for platform-native configuration directories

§Quick Start

cargo bp add cli

Want progress bars too?

cargo bp add cli -F indicators

§License

Licensed under either of:

at your option.

CrateVersionDescription
anstream1.0.0IO stream adapters for writing colored text that will gracefully degrade according to your terminal’s capabilities.
anstyle1.0.14ANSI text styling
anstyle-hyperlink1.0.2ANSI escape code hyperlinks (OSC 8)
anyhow1Flexible concrete Error type built on std::error::Error
clap4A simple to use, efficient, and full-featured Command Line Argument Parser
colorchoice-clap1.0.8Clap mixin to override console colors
console0.15A terminal and console abstraction for Rust
dialoguer0.11A command line prompting library.
etcetera0.11.0
human-panic2.0.8Panic messages for humans
ignore0.4
indicatif0.17
regex1
snapbox1.2.1Snapshot testing toolbox
supports-hyperlinks3.2.0Detects whether a terminal supports rendering hyperlinks.
wild2.2.1Glob (wildcard) expanded command-line arguments on Windows

Functions§

validate
Validate that the consumer’s dependencies match this battery pack’s specs.