lvqr-cli 1.1.0

LVQR single binary entry point
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

# lvqr-cli

Single-binary composition root for LVQR.

`lvqr-cli` is the crate that ties the 24 other workspace crates
together. It exposes the `lvqr serve` binary (entry point of
`cargo install lvqr-cli`) and a re-usable library target
(`lvqr_cli::start`) that `lvqr-test-utils::TestServer` drives
to spin up a full-stack instance on ephemeral ports for
integration tests. Everything `lvqr serve` does in production
is exercised by the same composition root in tests.

## Binary usage

```bash
lvqr serve                            # zero-config: RTMP + MoQ + LL-HLS + admin
lvqr serve --dash-port 8889           # add DASH egress
lvqr serve --whip-port 8443           # add WHIP ingest
lvqr serve --srt-port 8890            # add SRT ingest
lvqr serve --rtsp-port 8554           # add RTSP ingest
lvqr serve --cluster-listen ...       # multi-node with chitchat gossip
```

Every protocol beyond the four always-on surfaces
(RTMP 1935, MoQ 4443/udp, LL-HLS 8888, admin 8080) is gated
on a non-zero port.

Full flag + env-var reference in the top-level
[`README.md`](../../README.md) and
[`docs/quickstart.md`](../../docs/quickstart.md).

## Library usage

```rust
use lvqr_cli::{ServeConfig, start};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let config = ServeConfig::loopback_ephemeral();  // for tests
    let handle = start(config).await?;
    // use handle.rtmp_addr() / hls_addr() / dash_addr() ...
    handle.shutdown().await?;
    Ok(())
}
```

Every listener binds before `start` returns, so callers that
pass `port: 0` can read the bound address back off
`ServerHandle`. Tests never have to poll or sleep.

## Features

- `default = ["rtmp", "quinn-transport", "cluster"]`
- `rtmp` -- RTMP ingest
- `quinn-transport` -- QUIC/MoQ relay via quinn
- `cluster` -- chitchat cluster plane and
  `--cluster-*` CLI flags

## Install

```bash
cargo install lvqr-cli
```

## License

AGPL-3.0-or-later for open-source use; commercial license
available for proprietary / SaaS deployments. See the top-
level [`COMMERCIAL-LICENSE.md`](../../COMMERCIAL-LICENSE.md)
for the process.