Skip to content

Worktrunk is a CLI for Git worktree management, designed for parallel AI agent workflows

feat: Add ZSH job control option for cleaner output

Maximilian Roos8066ef915a69
diff --git a/.gitignore b/.gitignore
index c2f13b5fa..71b641e38 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
/target
+scripts/wt-demo/out/
# Lychee link checker cache
.lycheecache
diff --git a/scripts/wt-demo-build.sh b/scripts/wt-demo-build.sh
new file mode 100755
index 000000000..84001223c
--- /dev/null
+++ b/scripts/wt-demo-build.sh
@@ -0,0 +1,214 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd "$SCRIPT_DIR/.." && pwd)"
+DEMO_DIR="$SCRIPT_DIR/wt-demo"
+OUT_DIR="$DEMO_DIR/out"
+DEMO_ROOT="${DEMO_ROOT:-$OUT_DIR/demo}"
+LOG="$OUT_DIR/record.log"
+TAPE_TEMPLATE="$DEMO_DIR/demo.tape"
+TAPE_RENDERED="$OUT_DIR/.rendered.tape"
+STARSHIP_CONFIG_PATH="$OUT_DIR/starship.toml"
+OUTPUT_GIF="$OUT_DIR/wt-demo.gif"
+BARE_REMOTE=""
+DEMO_CONTAINER=""
+DEMO_REPO=""
+
+cleanup() {
+ rm -f "$TAPE_RENDERED"
+}
+
+require_bin() {
+ if ! command -v "$1" >/dev/null 2>&1; then
+ echo "Missing dependency: $1" >&2
+ exit 1
+ fi
+}
+
+write_starship_config() {
+ mkdir -p "$(dirname "$STARSHIP_CONFIG_PATH")"
+ cat >"$STARSHIP_CONFIG_PATH" <<'CFG'
+format = "$directory$git_branch$git_status$cmd_duration$character"
+palette = "gh_light"
+
+[palettes.gh_light]
+fg = "#1f2328"
+bg = "#ffffff"
+blue = "#0969da"
+yellow = "#d29922"
+green = "#2ea043"
+red = "#d73a49"
+muted = "#57606a"
+
+[directory]
+style = "bold fg:blue"
+truncation_length = 3
+truncate_to_repo = true
+home_symbol = "~"
+
+[git_branch]
+style = "fg:muted"
+symbol = " "
+format = " [$symbol$branch]($style)"
+
+[git_status]
+style = "fg:red"
+format = " [$all_status$ahead_behind]($style)"
+conflicted = "⇕"
+ahead = "⇡"
+behind = "⇣"
+staged = "+"
+modified = "!"
+untracked = "?"
+
+[cmd_duration]
+min_time = 500
+format = " [⏱ $duration]($style)"
+style = "fg:muted"
+
+[character]
+success_symbol = "[❯](fg:green)"
+error_symbol = "[❯](fg:red)"
+vicmd_symbol = "[❮](fg:blue)"
+
+[time]
+disabled = true
+CFG
+}
+
+prepare_repo() {
+ # Clean previous temp repo; also clean legacy root-level .demo if it exists.
+ rm -rf "$DEMO_ROOT"
+ if [ -d "$REPO_ROOT/.demo" ] && [ "$REPO_ROOT/.demo" != "$DEMO_ROOT" ]; then
+ rm -rf "$REPO_ROOT/.demo"
+ fi
+ mkdir -p "$DEMO_ROOT"
+ DEMO_CONTAINER="$(mktemp -d "$DEMO_ROOT/session-XXXXXXXX")"
+ DEMO_REPO="$DEMO_CONTAINER/wt-demo"
+ mkdir -p "$DEMO_REPO"
+ export DEMO_REPO
+
+ BARE_REMOTE="$DEMO_ROOT/remote.git"
+ git init --bare -q "$BARE_REMOTE"
+
+ git -C "$DEMO_REPO" init -q
+ printf "# Worktrunk demo\n\nThis repo is generated automatically.\n" >"$DEMO_REPO/README.md"
+ git -C "$DEMO_REPO" add README.md
+ SKIP_DEMO_HOOK=1 git -C "$DEMO_REPO" commit -qm "Initial demo commit"
+ git -C "$DEMO_REPO" branch -m main
+ git -C "$DEMO_REPO" remote add origin "$BARE_REMOTE"
+ git -C "$DEMO_REPO" push -u origin main -q
+
+ # Add a visible git hook to prove hooks run during commits/merges.
+cat >"$DEMO_REPO/.git/hooks/pre-commit" <<'HOOK'
+#!/usr/bin/env bash
+[ -n "$SKIP_DEMO_HOOK" ] && exit 0
+echo "🔧 pre-commit hook: running quick checks"
+HOOK
+ chmod +x "$DEMO_REPO/.git/hooks/pre-commit"
+
+ # Create two extra branches (no worktrees) for listing.
+ git -C "$DEMO_REPO" branch docs/readme
+ git -C "$DEMO_REPO" branch spike/search
+
+ create_branch_and_worktree feature/alpha "notes: alpha" "- Added alpha note"
+ create_branch_and_worktree feature/beta "notes: beta" "- Added beta note"
+ create_branch_and_worktree feature/hooks "hooks: demo" "- Added hooks demo"
+}
+
+create_branch_and_worktree() {
+ local branch="$1" label="$2" line="$3"
+ local path="$DEMO_CONTAINER/wt-demo.${branch//\//-}"
+ git -C "$DEMO_REPO" checkout -q -b "$branch" main
+ printf "%s\n" "$line" >>"$DEMO_REPO/notes.txt"
+ git -C "$DEMO_REPO" add notes.txt
+ SKIP_DEMO_HOOK=1 git -C "$DEMO_REPO" commit -qm "$label"
+ git -C "$DEMO_REPO" push -u origin "$branch" -q
+ git -C "$DEMO_REPO" checkout -q main
+ git -C "$DEMO_REPO" worktree add -q "$path" "$branch"
+
+ # Add varied states for list output
+ case "$branch" in
+ feature/alpha)
+ echo "// alpha scratch" >"$path/scratch_alpha.rs" # untracked
+ ;;
+ feature/beta)
+ echo "- beta staged addition" >>"$path/notes.txt"
+ git -C "$path" add notes.txt # staged
+ ;;
+ feature/hooks)
+ echo "- hook tweak" >>"$path/notes.txt"
+ git -C "$path" add notes.txt && git -C "$path" commit -qm "hook tweak" # clean after commit, shows history
+ ;;
+ esac
+}
+
+render_tape() {
+ sed \
+ -e "s|{{DEMO_REPO}}|$DEMO_REPO|g" \
+ -e "s|{{STARSHIP_CONFIG}}|$STARSHIP_CONFIG_PATH|g" \
+ -e "s|{{OUTPUT_GIF}}|$OUTPUT_GIF|g" \
+ "$TAPE_TEMPLATE" >"$TAPE_RENDERED"
+}
+
+record_text() {
+ mkdir -p "$OUT_DIR"
+ DEMO_RAW="$OUT_DIR/run.raw.txt"
+ env DEMO_REPO="$DEMO_REPO" RAW_PATH="$DEMO_RAW" bash -lc '
+ set -o pipefail
+ export LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8
+ export STARSHIP_CONFIG="'"$STARSHIP_CONFIG_PATH"'"
+ export STARSHIP_CACHE="'"$DEMO_ROOT"'"/starship-cache
+ mkdir -p "$STARSHIP_CACHE"
+ export WT_PROGRESSIVE=false
+ export NO_COLOR=1
+ export CLICOLOR=0
+ eval "$(starship init bash)" >/dev/null 2>&1
+ eval "$(wt init bash)" >/dev/null 2>&1
+ cd "$DEMO_REPO"
+ {
+ wt list --branches --full
+ wt switch --create feature/reports --base main
+ echo "- Q4 report ready" >> notes.md
+ wt merge
+ wt list --branches --full
+ } >"$RAW_PATH" 2>&1
+ '
+ RAW_PATH="$DEMO_RAW" OUT_DIR="$OUT_DIR" python3 - <<'PY'
+import os, re, pathlib
+raw = pathlib.Path(os.environ["RAW_PATH"]).read_text(errors="ignore")
+# strip ANSI escape sequences and control chars
+clean = re.sub(r"\x1B\[[0-9;?]*[A-Za-z]", "", raw)
+clean = re.sub(r"[\x00-\x08\x0b\x0c\x0e-\x1f\x7f]", "", clean)
+clean = clean.replace("^D", "")
+clean = clean.lstrip()
+pathlib.Path(os.environ["OUT_DIR"]).joinpath("run.txt").write_text(clean.strip() + "\n")
+PY
+}
+
+record_vhs() {
+ mkdir -p "$OUT_DIR"
+ vhs "$TAPE_RENDERED" >"$LOG" 2>&1
+}
+
+main() {
+ require_bin wt
+ require_bin vhs
+ require_bin starship
+ trap cleanup EXIT
+
+ mkdir -p "$OUT_DIR"
+ write_starship_config
+ prepare_repo
+ record_text
+ prepare_repo
+ render_tape
+ record_vhs
+
+echo "GIF saved to $OUTPUT_GIF"
+echo "Text log saved to $OUT_DIR/run.txt"
+echo "Log: $LOG"
+}
+
+main "$@"
diff --git a/scripts/wt-demo/README.md b/scripts/wt-demo/README.md
new file mode 100644
index 000000000..df410d30b
--- /dev/null
+++ b/scripts/wt-demo/README.md
@@ -0,0 +1,10 @@
+# wt demo assets (VHS)
+
+- Primary asset: `scripts/wt-demo/out/wt-demo.gif` (regenerated by the script; ~1.9 MB).
+- VHS tape: `scripts/wt-demo/demo.tape` (edit this to adjust the recording).
+- Text transcript: `scripts/wt-demo/out/run.txt` (captured from a clean run parallel to the GIF).
+- Regenerate everything with `./scripts/wt-demo-build.sh` (depends on `wt`, `vhs`, `starship`).
+- Script creates a fresh temp repo under `scripts/wt-demo/out/demo/` (gitignored), seeds 4 worktrees + 2 extra branches, shows `wt list --branches --full`, creates another worktree, edits a file (pre-commit hook visible during merge auto-commit), merges with `wt merge`, then shows the final list.
+- Defaults: light theme (GitHub-light-inspired palette), starship prompt, 1280x720 window. Worktree paths appear as `./wt-demo*` inside the session container for readability.
+- Inline viewing: `qlmanage -p scripts/wt-demo/out/wt-demo.gif` (Quick Look) or `imgcat scripts/wt-demo/out/wt-demo.gif` in iTerm2.
+- Recording log: `scripts/wt-demo/out/record.log`.
diff --git a/scripts/wt-demo/demo.tape b/scripts/wt-demo/demo.tape
new file mode 100644
index 000000000..4b5bacc70
--- /dev/null
+++ b/scripts/wt-demo/demo.tape
@@ -0,0 +1,56 @@
+Output "{{OUTPUT_GIF}}"
+
+Require wt
+Require git
+
+Set Shell "bash"
+Set FontSize 19
+Set FontFamily "Menlo, SF Mono, JetBrains Mono, Consolas, Apple Color Emoji"
+Set Width 1280
+Set Height 720
+Set Theme { "name": "GitHub Light Custom", "black": "#24292f", "red": "#d73a49", "green": "#22863a", "yellow": "#d29922", "blue": "#0969da", "magenta": "#8250df", "cyan": "#1b7c83", "white": "#6e7781", "brightBlack": "#57606a", "brightRed": "#cb2431", "brightGreen": "#2ea043", "brightYellow": "#f2cc60", "brightBlue": "#218bff", "brightMagenta": "#a475f9", "brightCyan": "#39c5cf", "brightWhite": "#1f2328", "background": "#ffffff", "foreground": "#1f2328", "cursor": "#0969da", "selection": "#ddf4ff" }
+Set Padding 18
+Set LineHeight 1.12
+Set TypingSpeed 28ms
+Set CursorBlink false
+Set Framerate 30
+
+Env DEMO_REPO "{{DEMO_REPO}}"
+Env STARSHIP_CONFIG "{{STARSHIP_CONFIG}}"
+
+Hide
+Type "export LANG=en_US.UTF-8 LC_ALL=en_US.UTF-8"
+Enter
+Type 'eval "$(starship init bash)" >/dev/null 2>&1'
+Enter
+Type 'eval "$(wt init bash)" >/dev/null 2>&1'
+Enter
+Type "cd $DEMO_REPO"
+Enter
+Type "clear"
+Enter
+Show
+
+Type "wt list --branches --full"
+Enter
+Sleep 1.6s
+
+Type "wt switch --create feature/reports --base main"
+Enter
+Sleep 1.6s
+
+Type 'echo "- Q4 report ready" >> notes.md'
+Enter
+Sleep 0.8s
+
+Type "wt merge"
+Enter
+Sleep 2.2s
+
+Type "wt list --branches --full"
+Enter
+Sleep 1.5s
+
+Type "exit"
+Enter
+Sleep 700ms