LiteTraffic documentation

Repository home

LiteTraffic is a local CLI for running reviewed, stateful HTTP traffic and evaluating business assertions. These guides describe the implemented 0.1.0.dev0 preview.

Start here

1. Install LiteTraffic and k6: Python, operating systems, dependencies, and prerequisite checks.
2. Run the quickstart: a passing checkout, a deliberately broken checkout, and the other scenarios.
3. Read the output: verdicts, lifecycle, reports, repeat summaries, and baseline comparisons.
4. Adapt a scenario to your app: traffic profiles, request sequences, fixtures, identity, and evidence.
5. Run it in CI: a GitHub Actions recipe, exit codes, job summary, and keeping run evidence.

Reference

• CLI reference: every current command, argument, default, and exit code.
• Architecture: controller, k6 process, fixture/observer calls, and artifacts.
• Safety and limitations: trust boundaries, budget enforcement, secrets, and cleanup.
• Troubleshooting: engine version, reachability, incomplete evidence, and comparison failures.
• Roadmap: implemented scope versus future authoring and population work.
• Contributing and security reporting.

Design records

Engine-fit results record earlier real-engine validation. The original technical specification is a design proposal, not a command reference: some interfaces in it are not implemented. Use the guides above for commands that work today.

The documentation lives at the repository’s /docs path and renders directly on GitHub. LiteTraffic does not start a documentation web server or ship a marketing site.