# sinq

> Concurrent integration and end-to-end HTTP testing tool for stateful workflows.

sinq runs sequences of HTTP requests as stateful workflows. Tests are plain-text .sinq files (raw HTTP plus Lua) organised into directories; every leaf directory is one scenario, and scenarios run in parallel.

## Start here

- [Home](https://sinq.veitangie.dev/index.md): What sinq is and the workflow model.
- [Getting Started](https://sinq.veitangie.dev/getting-started/index.md): Install and run a first scenario.
- [Writing & Debugging Scenarios](https://sinq.veitangie.dev/authoring/index.md): Writing scenarios, common patterns, a Lua API cheat-sheet, and how to debug failures.

## Reference

- [CLI Reference](https://sinq.veitangie.dev/cli/index.md): Every flag, the scenario filters, environment variables, and exit codes.
- [Scenarios & Config](https://sinq.veitangie.dev/scenario/index.md): The .sinq format, the .scenario config schema, and the request lifecycle.
- [Lua API](https://sinq.veitangie.dev/lua-api/index.md): Full Lua API - globals, hooks, encoding, crypto, jwt, json, fake data, retry and assert helpers.
- [Environment Matrix](https://sinq.veitangie.dev/env-matrix/index.md): Running a scenario once per combination of environment values.
- [CI/CD Integration](https://sinq.veitangie.dev/ci-cd-integration/index.md): Exit codes and the JUnit XML mapping.
- [Versioning & Compatibility](https://sinq.veitangie.dev/versioning/index.md): What the SemVer compatibility promise covers.

## Architecture

- [Overview](https://sinq.veitangie.dev/overview/index.md): The three stages - discovery, execution, reporting.
- [Treewalker](https://sinq.veitangie.dev/treewalker/index.md): How directories become scenarios and how config is inherited.
- [Execution Runner](https://sinq.veitangie.dev/runner/index.md): The worker pool, isolation, caching, and cancellation.

## Background

- [Alternatives & Comparisons](https://sinq.veitangie.dev/alternatives/index.md): How sinq compares to Hurl, Venom, Postman, Bruno, k6, and editor HTTP clients.
- [FAQ](https://sinq.veitangie.dev/faq/index.md): Common questions.