|
| 1 | +# Runi |
| 2 | + |
| 3 | +A curated collection of small, composable Rust libraries for building |
| 4 | +reliable infrastructure and CLI tools. Each crate is scoped to a |
| 5 | +single concern and can be used on its own or combined with the rest |
| 6 | +of the set. |
| 7 | + |
| 8 | +## Crates |
| 9 | + |
| 10 | +| Crate | Role | |
| 11 | +| ------------ | ------------------------------------------------- | |
| 12 | +| `runi-core` | Foundation types (`Error`, `Result`, `Config`) + feature-gated bundle that re-exports the rest | |
| 13 | +| `runi-log` | Structured logging with a Uni-style terminal format | |
| 14 | +| `runi-cli` | CLI parser and terminal styling helpers | |
| 15 | +| `runi-test` | Test utilities (`rstest`, `pretty_assertions`, `proptest`) | |
| 16 | + |
| 17 | +## Quick start |
| 18 | + |
| 19 | +Most callers only need `runi-core` — it re-exports the others behind |
| 20 | +feature flags. Cargo's `package = "..."` alias lets you reach |
| 21 | +everything through the clean `runi::` namespace: |
| 22 | + |
| 23 | +```toml |
| 24 | +[dependencies] |
| 25 | +runi = { package = "runi-core", version = "0.1" } # + logging (default) |
| 26 | +runi = { package = "runi-core", version = "0.1", features = ["cli"] } # + CLI helpers |
| 27 | +runi = { package = "runi-core", version = "0.1", default-features = false } # foundation only |
| 28 | +``` |
| 29 | + |
| 30 | +```rust |
| 31 | +use runi::{Error, Result}; |
| 32 | +use runi::log; |
| 33 | +use runi::cli::Tint; |
| 34 | + |
| 35 | +fn main() -> Result<()> { |
| 36 | + log::init(); |
| 37 | + log::info!("hello from runi"); |
| 38 | + Ok(()) |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +Each sub-crate is also published standalone on crates.io if you |
| 43 | +prefer narrower dependencies. |
| 44 | + |
| 45 | +## Documentation |
| 46 | + |
| 47 | +- Book: <https://wvlet.github.io/runi> |
| 48 | +- API reference: [docs.rs/runi-core](https://docs.rs/runi-core), |
| 49 | + [docs.rs/runi-log](https://docs.rs/runi-log), |
| 50 | + [docs.rs/runi-cli](https://docs.rs/runi-cli), |
| 51 | + [docs.rs/runi-test](https://docs.rs/runi-test) |
| 52 | + |
| 53 | +## License |
| 54 | + |
| 55 | +Apache-2.0 |
0 commit comments