diff --git a/index.html b/index.html index 2105e99..e6f0b24 100644 --- a/index.html +++ b/index.html @@ -3,21 +3,35 @@ -shout — test your CLI - +shout — shell output tester + @@ -189,9 +175,9 @@

$ shout

-

Write shell sessions. Run them as tests.

-
- $ bun install -g @because/shout +

shell output tester

+
+ $ bun install -g @because/shout --registry=https://npm.nose.space click to copy
@@ -207,8 +193,9 @@ [1] $ brew --version -Homebrew ... -

... matches anything — inline or across lines. [1] asserts the exit code.

+Homebrew 5... +

... matches anything — inline or across lines.

+

[1] asserts the exit code.

@@ -226,33 +213,33 @@
-

Features

-
-
-

Wildcards

-

... matches anything — inline for partial lines, standalone for multiple lines.

-
-
-

Exit codes

-

[N] asserts a specific exit code. [*] matches any non-zero code.

-
-
-

Parallel

-

--parallel runs test files concurrently. Each gets its own shell.

-
-
-

Timeouts

-

--timeout 5s per-command timeout. Supports ms, s, m.

-
-
-

PATH control

-

--path ./bin prepends to PATH. Test your local builds.

-
-
-

Verbose

-

-v prints each command as it runs. See what's happening.

-
-
+

Usage

+
$ 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
+
+ +
+

Environment

+

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.