diff --git a/index.html b/index.html index 2105e99..e6f0b24 100644 --- a/index.html +++ b/index.html @@ -3,21 +3,35 @@
-Write shell sessions. Run them as tests.
-shell output tester
+... matches anything — inline or across lines. [1] asserts the exit code.
... matches anything — inline or across lines.
[1] asserts the exit code.
... matches anything — inline for partial lines, standalone for multiple lines.
[N] asserts a specific exit code. [*] matches any non-zero code.
--parallel runs test files concurrently. Each gets its own shell.
--timeout 5s per-command timeout. Supports ms, s, m.
--path ./bin prepends to PATH. Test your local builds.
-v prints each command as it runs. See what's happening.
$ shout --help
+Usage: shout [options] [files...]
+
+shell output tester.
+
+Arguments:
+ files Files or directories to test
+
+Options:
+ -u, --update Rewrite expected output in-place with actual output
+ -k, --keep Keep temp directories after run
+ --clean-env Start with empty environment
+ --path <path> Prepend <path> to PATH (repeatable)
+ --timeout <dur> Per-command timeout (default: "10s")
+ -v, --verbose Print each command as it runs
+ --parallel Run files in parallel
+ -h, --help display help for command
+Shout sets these variables before running your commands:
+HOME → temp directory for this test file
+SHOUT_DIR → same temp directory
+PATH → prepended with --path dirs, if any
+ Each file runs in its own temp directory. --clean-env starts with an empty environment instead of inheriting yours.