defunkt/shout
1
0
Fork 0
Code Pull Requests Activity

docs: add --port-from and SHOUT_*_DIR env vars

Browse Source
This commit is contained in:
Chris Wanstrath 2026-03-12 14:26:31 -07:00
parent 649796b078
commit 88cca88dd9
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -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

2
web/index.html
View File

@ -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>