CLI Batteries
Opinionated batteries-included command line interface runtime utilities.
To use it, add it to your Cargo.toml
[dependencies]
cli-batteries = "0.1"
[build-dependencies]
cli-batteries = "0.1"
and call the [build_rs] function in your build.rs
fn main() {
cli_batteries::build_rs()
}
Then in your src/main.rs you define app specific command line arguments using [StructOpt][structopt] and run the app as follows
use cli_batteries::{version, StructOpt};
use std::{path::PathBuf, io::Result};
use tokio::fs::File;
#[derive(StructOpt)]
struct Options {
/// File to read
#[structopt(long, env, default_value = "Readme.md")]
file: PathBuf,
}
async fn app(options: Options) -> Result<()> {
let mut file = File::open(options.file).await?;
Ok(())
}
fn main() {
cli_batteries::run(version!(), app);
}
You can see this working in the example project.
Features
mimalloc: Use the mimalloc allocator with security hardening features enabled.rand: Log and configure random seeds.rayon: Log and configure number of threads.prometheus: Start a Prometheus metrics server.metered_allocator: Collect metric on memory allocation, enablesprometheus.tokio_console: Start a Tokio console server.
Building and testing
Format, lint, build and test everything (I recommend creating a shell alias for this):
cargo fmt &&\
cargo clippy --all-features --all-targets &&\
cargo test --workspace --all-features --doc -- --nocapture &&\
cargo test --workspace --all-features --all-targets -- --nocapture &&\
cargo doc --workspace --all-features --no-deps
Check documentation coverage
RUSTDOCFLAGS="-Z unstable-options --show-coverage" cargo doc --workspace --all-features --no-deps
To do
Goals:
Maybe:
12 Nov 5, 2022
2 Jan 8, 2022
326 Dec 21, 2022
5 Aug 20, 2022
5 Jul 8, 2023
9.3k Jan 4, 2023
205 Dec 29, 2022
4 Jan 10, 2023
3 Feb 25, 2024
3 Jan 3, 2023
3 Nov 2, 2023
4 Dec 4, 2022
10.4k Jan 10, 2023
743 Jan 1, 2023
2.6k Jan 5, 2023
3.2k Dec 30, 2022
47 Nov 25, 2022
36 Jan 1, 2023
24 Dec 29, 2022