docs(scripts): add --help to remaining scripts; document scripts + layout in README
CI / rust client (hh) (macos-latest) (push) Waiting to run
CI / rust client (hh) (ubuntu-latest) (push) Waiting to run
CI / rust coverage (push) Waiting to run
CI / python server (3.10) (push) Waiting to run
CI / python server (3.11) (push) Waiting to run
CI / python server (3.12) (push) Waiting to run
CI / headless e2e smoke (push) Waiting to run
CI / dependency audit (push) Waiting to run
CI / secret scanning (push) Waiting to run
CI / rust client (hh) (macos-latest) (push) Waiting to run
CI / rust client (hh) (ubuntu-latest) (push) Waiting to run
CI / rust coverage (push) Waiting to run
CI / python server (3.10) (push) Waiting to run
CI / python server (3.11) (push) Waiting to run
CI / python server (3.12) (push) Waiting to run
CI / headless e2e smoke (push) Waiting to run
CI / dependency audit (push) Waiting to run
CI / secret scanning (push) Waiting to run
- Add a -h/--help guard (prints the usage header) to the five scripts that lacked one: smoke.sh, smoke-e2e.sh, test-features.sh, demo-save-load.sh, sandbox-bootstrap.sh. All 15 hh/scripts/*.sh now respond to --help. - README: new "Scripts" section detailing every script (setup, hosting, sandbox provisioning, tests) and noting each takes --help; plus an archive note for the film-* recording scripts. - README: new "Window layout" section documenting live pane resizing (F4 fullscreen, click/F5 to select + arrows to resize) and the /layout save/load/list/rm/reset presets, with matching keybinding-table rows. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -14,6 +14,11 @@
|
||||
# --keep leave the server, container, image and tmux sessions up afterwards
|
||||
set -uo pipefail
|
||||
|
||||
# -h/--help: print the usage header above and exit.
|
||||
case "${1:-}" in
|
||||
-h|--help|-help) sed -n '2,/^set /{/^set /d;s/^# \{0,1\}//;p}' "$0"; exit 0 ;;
|
||||
esac
|
||||
|
||||
# ---- config -----------------------------------------------------------------
|
||||
REPO="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
# Pick a free TCP port so we never collide with a stale server from another
|
||||
|
||||
@@ -12,6 +12,13 @@
|
||||
# HH_SBX_PKGS="vim tmux ripgrep" ./host-house.sh ...
|
||||
set -uo pipefail
|
||||
|
||||
# -h/--help: print the usage header above and exit. (No effect in normal use —
|
||||
# hh pipes this to `bash -s` inside the container with no args; the flag is for
|
||||
# running it standalone to read what it does.)
|
||||
case "${1:-}" in
|
||||
-h|--help|-help) sed -n '2,/^set /{/^set /d;s/^# \{0,1\}//;p}' "$0"; exit 0 ;;
|
||||
esac
|
||||
|
||||
SENTINEL=/var/lib/hh-bootstrap.done
|
||||
[[ -f "$SENTINEL" ]] && exit 0 # this container is already provisioned
|
||||
|
||||
|
||||
@@ -15,6 +15,11 @@
|
||||
# Env overrides: PY=<python> BIN=<client binary> PORT=<port> PW=<password>
|
||||
set -uo pipefail
|
||||
|
||||
# -h/--help: print the usage header above and exit.
|
||||
case "${1:-}" in
|
||||
-h|--help|-help) sed -n '2,/^set /{/^set /d;s/^# \{0,1\}//;p}' "$0"; exit 0 ;;
|
||||
esac
|
||||
|
||||
REPO="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
|
||||
# Python: prefer the repo venv locally, fall back to PATH (CI installs into the
|
||||
# job's own interpreter).
|
||||
|
||||
@@ -6,6 +6,11 @@
|
||||
# Run from anywhere: hh/scripts/smoke.sh
|
||||
set -uo pipefail
|
||||
|
||||
# -h/--help: print the usage header above and exit.
|
||||
case "${1:-}" in
|
||||
-h|--help|-help) sed -n '2,/^set /{/^set /d;s/^# \{0,1\}//;p}' "$0"; exit 0 ;;
|
||||
esac
|
||||
|
||||
HERE="$(cd "$(dirname "$0")/.." && pwd)" # .../hh
|
||||
ROOT="$(cd "$HERE/.." && pwd)" # repo root
|
||||
PY="$ROOT/.venv/bin/python"
|
||||
|
||||
@@ -14,6 +14,11 @@
|
||||
# tmux attach -t hh-autotest
|
||||
set -uo pipefail
|
||||
|
||||
# -h/--help: print the usage header above and exit.
|
||||
case "${1:-}" in
|
||||
-h|--help|-help) sed -n '2,/^set /{/^set /d;s/^# \{0,1\}//;p}' "$0"; exit 0 ;;
|
||||
esac
|
||||
|
||||
HERE="$(cd "$(dirname "$0")/.." && pwd)" # .../hh
|
||||
ROOT="$(cd "$HERE/.." && pwd)" # repo root
|
||||
PY="$ROOT/.venv/bin/python"
|
||||
|
||||
Reference in New Issue
Block a user