Crate metadata¶

Facts about the package itself rather than its API. Everything here is read from Cargo.toml, rust-toolchain.toml, deny.toml and the justfile at version 0.6.3.

Package identity and how to depend on it¶

[dependencies]
rtb-tui = "0.6"

The crate is pre-1.0, so a minor bump may change the public API. Pin to a minor version rather than a major one if you want a quiet upgrade path.

Cargo features¶

There are none. Cargo.toml declares no [features] table, so:

• default-features = false changes nothing;
• there is no way to compile out the wizard, the render helpers or the spinner independently;
• there is no way to drop miette, serde_json or tabled from the graph while still using the parts that do not need them.

Taking the crate takes all three components and all eight dependencies. If that matters for your binary size, depend on inquire, tabled or console directly instead.

Dependencies¶

Eight runtime dependencies, all pinned to a caret requirement:

tokio appears only as a dev-dependency, for the async tests. The crate does not start or require any particular runtime — Wizard::run is a plain async fn and you drive it with whatever executor your binary already has.

miette's fancy feature is the heaviest item in that list: it pulls in the graphical report renderer and its terminal-handling stack. It is on unconditionally.

Banned dependencies¶

deny.toml refuses these outright, so a change that reintroduces one fails the audit job rather than being caught in review:

cargo deny also enforces a license allowlist — MIT, MIT-0, Apache-2.0 (with and without the LLVM exception), BSD-2-Clause, BSD-3-Clause, ISC, Unicode-DFS-2016, Unicode-3.0, Zlib, CC0-1.0, MPL-2.0 and 0BSD — and denies yanked crates, wildcard version requirements, and any source other than crates.io.

One advisory is waived: RUSTSEC-2026-0173 for proc-macro-error2, reached through tabled_derive. The waiver comment records the condition for lifting it — tabled dropping proc-macro-error2, or this crate moving to a different table library.

Lint policy¶

unsafe_code is deny rather than forbid at the package level specifically so an individual test file can #![allow(...)] when it genuinely needs to; the library itself carries #![forbid(unsafe_code)], and that is the guarantee that ships.

Four clippy lints are switched off: module_name_repetitions, missing_errors_doc, missing_panics_doc and multiple_crate_versions.

CI runs cargo clippy --all-targets -- -D warnings, so every one of those warn levels is an error in the pipeline.

Toolchain and MSRV¶

rust-toolchain.toml pins an exact stable release — 1.97.1 — with rustfmt, clippy and rust-src. The pin is exact rather than the floating stable channel so that a new stable release cannot change compiler output underneath CI without a reviewable commit.

Note that this is not the MSRV. Cargo.toml declares rust-version = "1.82", but the pinned toolchain and therefore every CI job builds on 1.97.1. Nothing in this repository compiles the crate on 1.82, so the declared MSRV is a statement of intent rather than a tested guarantee. Treat "works on 1.82" as unverified until you have built it yourself on that toolchain.

Running the checks locally¶

just targets, from the justfile:

just ci is the local mirror of the merge-request gate. The docs site build is not part of it: the site is built and deployed from main by a separate pipeline job, so a docs change is not gated on the site compiling. Run just site-build yourself before raising a docs merge request.

All tests run headless. None of them need a TTY, and none of them talk to the network.

Releases¶

Releases are cut by release-plz from Conventional Commits. Pushing to main opens or updates a release merge request; merging that MR creates the tag and the release. Tags are named rtb-tui-v<version> even though this is a single-crate repository, for consistency with the other phpboyscout/rust repos and with the tags the monorepo already carries.

Do not tag manually, and do not run cargo update as part of a release — release-plz is configured with dependencies_update = false so that dependency churn goes through CI as its own change.

Known documentation defects¶

The generated rustdoc on docs.rs contains claims that the code does not support. They are listed here so a reader who hits one knows which source to believe. In every case below, the code is right and the comment is wrong.