From 88cca88dd9929b8dfc12eabec52e3d0b845b5619 Mon Sep 17 00:00:00 2001
From: Chris Wanstrath <chris@ozmm.org>
Date: Thu, 12 Mar 2026 14:26:31 -0700
Subject: [PATCH] docs: add --port-from and SHOUT_*_DIR env vars

---
 README.md      | 5 ++++-
 web/index.html | 2 ++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fde8091..3777571 100644
--- a/README.md
+++ b/README.md
@@ -85,6 +85,7 @@ Options:
   --path <path>    Prepend <path> to PATH (repeatable)
   --timeout <dur>  Per-command timeout (default: "10s")
   -v, --verbose    Print each command as it runs
+  --port-from <n>  Auto-assign $PORT starting from n (default: "5400")
   --parallel       Run files in parallel
   -h, --help       display help for command
 ```
@@ -97,7 +98,9 @@ Options:
 |---|---|
 | `HOME` | Path to the temp directory created for the test |
 | `SHOUT_DIR` | Same as `HOME` — the temp directory for the test |
-| `PORT` | Auto-assigned when `--port-from <n>` is used (increments per file). Not set if `PORT` is already defined via `@env` or `@setup`. |
+| `SHOUT_SOURCE_DIR` | Directory containing the `.shout` file being run |
+| `SHOUT_PROJECT_DIR` | The `cwd` where `shout` was invoked |
+| `PORT` | Auto-assigned starting from `5400` (or the value of `--port-from`), increments per file. Not set if `PORT` is already defined via `@env` or `@setup`. |
 
 ### Inherited
 
diff --git a/web/index.html b/web/index.html
index e42394b..3efb2cf 100644
--- a/web/index.html
+++ b/web/index.html
@@ -229,6 +229,7 @@ Options:
   --path &lt;path&gt;    Prepend &lt;path&gt; to PATH (repeatable)
   --timeout &lt;dur&gt;  Per-command timeout (default: "10s")
   -v, --verbose    Print each command as it runs
+  --port-from &lt;n&gt;  Auto-assign $PORT starting from n (default: "5400")
   --parallel       Run files in parallel
   -h, --help       display help for command</span></code></pre>
 </section>
@@ -240,6 +241,7 @@ Options:
 <span class="bright">SHOUT_DIR</span>      <span class="dim">→</span> <span class="output">same temp directory</span>
 <span class="bright">SHOUT_SOURCE_DIR</span>  <span class="dim">→</span> <span class="output">directory containing the .shout file</span>
 <span class="bright">SHOUT_PROJECT_DIR</span> <span class="dim">→</span> <span class="output">directory where shout was invoked</span>
+<span class="bright">PORT</span>           <span class="dim">→</span> <span class="output">auto-assigned from 5400 (or --port-from), increments per file</span>
 <span class="bright">PATH</span>           <span class="dim">→</span> <span class="output">prepended with --path dirs, if any</span></code></pre>
   <p>Each file runs in its own temp directory. <code>--clean-env</code> starts with an empty environment instead of inheriting yours.</p>
 </section>