docs: add documentation

This commit is contained in:
technofab 2025-06-02 13:34:59 +02:00
parent c2ca17dfc5
commit fd58344ca7
9 changed files with 302 additions and 8 deletions

12
docs/cli.md Normal file
View file

@ -0,0 +1,12 @@
# CLI
```sh title="nix run .#nixtests:run -- --help"
Usage of nixtest:
--junit string Path to generate JUNIT report to, leave empty to disable
--pure Unset all env vars before running script tests
--skip string Regular expression to skip (e.g., 'test-.*|.*-b')
--snapshot-dir string Directory where snapshots are stored (default "./snapshots")
--tests string Path to JSON file containing tests
--update-snapshots Update all snapshots
--workers int Amount of tests to run in parallel (default 4)
```