Nils Andreas Svee
9bb3fd63d8
Rust CI / cargo fmt (push) Successful in 17s
Rust CI / cargo clippy (push) Successful in 29s
Rust CI / cargo check (x86_64-unknown-linux-gnu) (push) Successful in 26s
Rust CI / cargo check (x86_64-unknown-linux-musl) (push) Failing after 11s
Rust CI / cargo test (x86_64-unknown-linux-musl) (push) Failing after 6s
Rust CI / cargo doc (push) Successful in 27s
Rust CI / cargo test (x86_64-unknown-linux-gnu) (push) Successful in 1m6s
Netem Interop / netem interop (push) Failing after 17s
Supply chain / cargo-deny advisories (push) Failing after 3s
Fuzz Smoke / cargo fuzz smoke (push) Failing after 31s
Supply chain / cargo-deny bans licenses sources (push) Failing after 4s
Supply chain / actionlint (push) Successful in 4s
Build binaries / Build (arm-musleabi) (push) Successful in 4m31s
Build binaries / Build (aarch64-musl) (push) Successful in 4m41s
Build binaries / Build (arm-musleabihf) (push) Successful in 4m7s
Build binaries / Build (armv7-musleabi) (push) Successful in 4m2s
Build binaries / Build (armv7-musleabihf) (push) Successful in 4m26s
Build binaries / Build (i686-musl) (push) Successful in 4m20s
Build binaries / Build (mips-musl) (push) Successful in 4m18s
Build binaries / Build (mips64-muslabi64) (push) Successful in 4m19s
Build binaries / Build (mips64el-muslabi64) (push) Successful in 4m8s
Build binaries / Build (mipsel-musl) (push) Successful in 4m7s
Build binaries / Build (riscv64gc-musl) (push) Successful in 4m11s
Build binaries / Build (x86_64-musl) (push) Successful in 4m17s
Decouple statistics collection into a dedicated feature to enable lighter client-only builds.
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# irtt-rs
|
|
|
|
The IRTT-compatible client, TUI, and server applications, packaged as Cargo
|
|
package `irtt-rs`.
|
|
|
|
Installing this crate builds:
|
|
|
|
- `irtt-rs` — a multicall dispatcher binary that runs the client, TUI, or
|
|
server applet by subcommand.
|
|
- `irtt-client` — the dedicated client binary (feature `client`).
|
|
- `irtt-tui` — the interactive terminal UI (feature `tui`).
|
|
- `irtt-server` — the dedicated server binary (feature `server`).
|
|
|
|
The `client`, `server`, `tui`, and `stats` features are enabled by default, so a
|
|
plain `cargo install irtt-rs` installs everything. The TUI requires statistics
|
|
and enables `stats` automatically.
|
|
|
|
For a client without statistics, use
|
|
`cargo install irtt-rs --locked --no-default-features --features client --bin irtt-client`.
|
|
Use `--features client,stats` for a client-only build with statistics.
|
|
|
|
## This is an application, not a library
|
|
|
|
This package's library target is undocumented (`doc = false`) and exists only
|
|
to share code between its binaries. If you're looking for the client/session
|
|
or server API to embed in your own Rust program, use
|
|
[`irtt-client`](https://crates.io/crates/irtt-client) or
|
|
[`irtt-server`](https://crates.io/crates/irtt-server) instead.
|
|
|
|
## Usage
|
|
|
|
See the [project repository](https://github.com/Lochnair/irtt-rs) for
|
|
installation instructions, command-line usage, and configuration.
|
|
|
|
## Project
|
|
|
|
Part of [irtt-rs](https://github.com/Lochnair/irtt-rs), an independent Rust
|
|
implementation of an IRTT-compatible protocol stack.
|