open-standards/wai/examples/README.md
Transaction Science 5559bc5198 wai: the README's quickstart, the changelog, the examples' index, and a clean-machine run of the quickstart
wai/quickstart/test/clean-machine.sh runs the quickstart from the archive
alone in a fresh HOME and directory, with the system's PATH: the archive
checked against its SHA-256 and unpacked, wai hello, wai verify, wai create,
wai dev --check, and, with --browser, the room joined in two pages. It times
each step and fails naming the step that failed. The encoder-ingest example
takes clippy's is_multiple_of.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-26 22:58:54 -04:00

2.1 KiB

WAI examples

Small projects that each do one thing with WAI, and each run on your own machine with the open reference software alone. Every one is a template of wai create:

wai create my-room --template video-room
cd my-room
wai dev
Template What it shows Runs with
video-room Your own page with a live room in it: camera, microphone, every object checked against its receipt wai dev, a browser
watch-together Everyone in a room watching one file in sync: play, pause and seek at one instant for all wai dev, a browser
messaging An end-to-end encrypted conversation, and a call placed, rung and answered wai dev, a browser
encoder-ingest An SRT encoder's stream published into a room, each group signed at the first hop and checked at the relay and the subscriber cargo
package-and-deliver A title packed by policy, its package verified, its standard floor played in a page wai-pack, wai dev, a browser
verify-receipts The receipts beside an object checked offline by the reference implementation (Rust) and by a second one (Python, standard library only) wai hello, cargo, python3
apple-app The native sink in a SwiftUI app, and a recorded playback session replayed through it Xcode, the wai-sink-swift package
android-app The native sink's Kotlin API, the one an Android app's player session calls a JDK 17, the wai-sink-android project
remote-desktop One machine's screen shared into a room, with control handed over and every input signed wai dev, wai-remote-host, a browser

Each example's test/ directory holds the check that it works; it is not part of the project wai create writes. bash ../quickstart/test/run-examples.sh portable|browser|apple|android runs them, as .github/workflows/wai-examples.yml does.