#!/usr/bin/env bash # gstack-doctor — readiness report without starting a skill. # # Usage: # gstack-doctor print one row per check; spends nothing # gstack-doctor --live also run the paid Codex model probe (one short call) # # Rows: install root, state root, bun, hooks, codex, codex probe, artifacts # sync, browse bundle, claude code, session journal, guard log. Each row is # `ok`, `warn`, `not configured` or `fail`; a row that is not ok carries a fix # line, and every gstack helper in a fix line is an absolute path under this # install root. Exit 1 when any row is `fail`, 2 on a usage error, else 0. # # Read-only. Each row reuses the owner's check instead of new probe logic: the # install registry rows behind `./setup --status`, bin/gstack-bun-version.sh, # bin/gstack-hook-check, bin/gstack-codex-probe's subcommands (the paid # `probe-model` only with --live; otherwise the cached result and its age), # the status file bin/gstack-brain-sync writes, and setup's browse build # outputs. The sync row prints only a clamped status code and counts, never # the status message or file paths: the message can quote a matched secret. # Bash 3.2 plus POSIX tools; it still reports when bun or python3 is missing. # Heredoc delivery guard, as in bin/gstack-brain-sync: compat level 50 keeps # heredoc bodies on the tempfile path, so a small pipe buffer cannot hang them. BASH_COMPAT=50 set -u usage() { sed -n '3,6p' "$0" | sed 's/^# \{0,1\}//' } LIVE=0 for _arg in "$@"; do case "$_arg" in --live) LIVE=1 ;; -h|--help) usage; exit 0 ;; *) echo "gstack-doctor: unknown argument '$_arg'" >&2; usage >&2; exit 2 ;; esac done ROOT="$(cd "$(dirname "$0")/.." && pwd)" || { echo "gstack-doctor: cannot resolve the install root" >&2; exit 1; } ROOT_REAL="$(cd "$ROOT" && pwd -P)" BIN="$ROOT/bin" SRC="$ROOT_REAL" DOCS="https://github.com/garrytan/gstack/blob/main/docs/troubleshooting.md" CODEX_FEATURES="outside reviews in /review, /ship, /autoplan and /codex" N_OK=0 N_WARN=0 N_NC=0 N_FAIL=0 row() { printf '%-15s %-15s %s\n' "$1" "$2" "$3" [ -n "${4:-}" ] && printf '%32sfix: %s\n' '' "$4" case "$1" in ok) N_OK=$((N_OK + 1)) ;; warn) N_WARN=$((N_WARN + 1)) ;; 'not configured') N_NC=$((N_NC + 1)) ;; *) N_FAIL=$((N_FAIL + 1)) ;; esac } # clamp CHARSET MAX — stdin's first line reduced to CHARSET, at most MAX chars. clamp() { head -1 | tr -cd "$1" | cut -c1-"$2"; } # epoch_of VALUE — epoch seconds for an epoch or an ISO-8601 UTC time; "" otherwise. epoch_of() { local v v=$(printf '%s' "$1" | tr -cd '0-9TZ:.+-') case "$v" in '') return 0 ;; *[!0-9]*) date -u -d "$v" +%s 2>/dev/null || date -u -j -f '%Y-%m-%dT%H:%M:%SZ' "$v" +%s 2>/dev/null || true ;; *) printf '%s' "$v" ;; esac } # json_field KEY JSON — a top-level string or number value from one-line JSON. # A key quoted inside a string value is escaped (\"key\"), so it never matches. json_field() { local v v=$(printf '%s' "$2" | sed -n "s/.*\"$1\"[[:space:]]*:[[:space:]]*\"\([^\"\\\\]*\)\".*/\1/p") [ -n "$v" ] || v=$(printf '%s' "$2" | sed -n "s/.*\"$1\"[[:space:]]*:[[:space:]]*\([0-9][0-9]*\).*/\1/p") printf '%s' "$v" } check_state_root() { if [ -d "$STATE_ROOT" ]; then row ok "state root" "$STATE_ROOT (selected by $_gstack_sr_var)" else row warn "state root" "$STATE_ROOT (selected by $_gstack_sr_var) does not exist yet" "cd $SRC && ./setup, or run any gstack skill" fi } check_install() { local rows host scope src dest reg cur result note real installed="" bad="" badnote="" other="" total=0 if ! . "$BIN/gstack-install-registry.sh" 2>/dev/null; then row fail "install root" "$BIN/gstack-install-registry.sh is missing" "reinstall gstack from a fresh checkout of https://github.com/garrytan/gstack, then run its ./setup" return fi rows="$(_gstack_status_rows)" while IFS=' ' read -r host scope src dest reg cur result note; do [ -n "$host" ] || continue total=$((total + 1)) real="$(cd "$src" 2>/dev/null && pwd -P)" if [ "$real" != "$ROOT_REAL" ] && [ "$(cd "$dest/gstack" 2>/dev/null && pwd -P)" != "$ROOT_REAL" ]; then [ -n "$other" ] || other="$src" continue fi [ -n "$real" ] && SRC="$real" case "$result" in current) installed="${installed:+$installed, }$host $scope current ($cur)" ;; *) bad="${bad:+$bad, }$host $scope $result"; [ -n "$badnote" ] || badnote="$note" ;; esac done </dev/null; then row fail bun "$BIN/gstack-bun-version.sh is missing" "reinstall gstack from a fresh checkout of https://github.com/garrytan/gstack" return fi if ! where=$(command -v bun 2>/dev/null); then row fail bun "not found on PATH; gstack's skills, hooks and builds need it" "install Bun $GSTACK_BUN_TESTED (https://bun.sh), then cd $SRC && ./setup" return fi found=$(bun --version /dev/null | clamp 'A-Za-z0-9.+-' 40) case "$(gstack_bun_status "$found")" in ok) row ok bun "$found at $where (floor $GSTACK_BUN_FLOOR, tested $GSTACK_BUN_TESTED)" ;; untested) row warn bun "$found at $where is below the tested $GSTACK_BUN_TESTED" "bun upgrade ($DOCS#bun-too-old)" ;; too-old) row fail bun "$found at $where is below the security floor $GSTACK_BUN_FLOOR" "bun upgrade, then cd $SRC && ./setup ($DOCS#bun-too-old)" ;; *) row warn bun "could not read the version of $where" "bun upgrade ($DOCS#bun-too-old)" ;; esac } check_hooks() { local out rc checked missing first out=$("$BIN/gstack-hook-check" "$SRC" &1) rc=$? checked=$(printf '%s\n' "$out" | grep -c '^ok ') missing=$(printf '%s\n' "$out" | grep -c '^missing ') case "$rc" in 0) if [ "$missing" -gt 0 ]; then row ok hooks "$checked hook(s) parse; $missing not installed"; else row ok hooks "$checked hook(s) parse"; fi ;; 1) first=$(printf '%s\n' "$out" | grep '^fail ' | head -1 | cut -c6-300) row fail hooks "$first" "repair the file (git -C $SRC status shows half-applied edits), then cd $SRC && ./setup ($DOCS#setup-hook-does-not-parse)" ;; 3) row warn hooks "TypeScript hook entries not checked: bun not found" "install Bun (see the bun row), then rerun $BIN/gstack-doctor" ;; *) row fail hooks "the hook check could not run (exit $rc)" "cd $SRC && ./setup" ;; esac } # check_codex — CODEX_MODE from the free checks; sets CODEX_READY=1 when the # probe row should follow. check_codex() { local reviews probe="$BIN/gstack-codex-probe" sel rc model src CODEX_READY=0 reviews=$("$BIN/gstack-config" get codex_reviews 2>/dev/null || echo enabled) if [ "$reviews" = disabled ]; then row "not configured" codex "codex_reviews disabled; $CODEX_FEATURES skip Codex" "$BIN/gstack-config set codex_reviews enabled" return fi if ! command -v codex >/dev/null 2>&1; then row "not configured" codex "Codex CLI not installed; $CODEX_FEATURES have no Codex coverage" "npm install -g @openai/codex, then codex login" return fi sel=$("$probe" select-model exec &1) rc=$? model=$(printf '%s\n' "$sel" | sed -n 's/^CODEX_SEL: //p' | clamp 'A-Za-z0-9._:/-' 80) if [ "$rc" -ne 0 ] || [ -z "$model" ]; then [ "$rc" -ne 0 ] && rc="exited $rc" || rc="printed no CODEX_SEL line" row fail codex "CODEX_MODE helper_unavailable: select-model $rc (the probe could not locate its scripts, or the requested model id is invalid)" "run $probe select-model exec to see the cause; reinstall with cd $SRC && ./setup" return fi src=$(printf '%s\n' "$sel" | sed -n 's/^CODEX_MODEL: .*source: \(.*\))$/\1/p' | clamp 'A-Za-z0-9 ._:/=-' 80) gstack_codex_version if ! "$probe" check-auth /dev/null 2>&1; then row warn codex "CODEX_MODE not_authed; model $model (source: ${src:-unknown})" "codex login, or export CODEX_API_KEY" return fi if ! "$probe" check-sandbox /dev/null 2>&1; then row warn codex "CODEX_MODE sandbox_unavailable; no paid call runs" "run $probe check-sandbox for the reason and fix" return fi if "$probe" check-version &1 | grep -q '^WARN'; then row warn codex "${_gcx_version:-version unknown} has a known problem; model $model (source: ${src:-unknown})" "run $probe check-version for the fix" else row ok codex "${_gcx_version:-version unknown}; self-locate ok; model $model (source: ${src:-unknown})" fi CODEX_READY=1 } check_codex_probe() { local out rc state probe="$BIN/gstack-codex-probe" model_fix="set GSTACK_CODEX_MODEL= or model in config.toml, then $BIN/gstack-doctor --live" if [ "$LIVE" -eq 1 ]; then out=$("$probe" probe-model exec &1) rc=$? state=$(printf '%s\n' "$out" | sed -n 's/^CODEX_PROBE_STATE: //p' | clamp 'a-z_' 40) case "$rc" in 0) case "$state" in inconclusive|rate_limited) row warn "codex probe" "live probe: CODEX_MODE unverified ($state)" "rerun $BIN/gstack-doctor --live later" ;; *) row ok "codex probe" "live probe: ok" ;; esac ;; 1) row warn "codex probe" "live probe: model_unusable; $CODEX_FEATURES skip Codex" "$model_fix" ;; 2) row fail "codex probe" "live probe: broken_install (the Codex CLI cannot execute)" "npm install -g @openai/codex" ;; 4) row warn "codex probe" "live probe: quota_exhausted (the account's Codex usage limit)" "wait for the reset time Codex names: $probe probe-model exec" ;; *) row warn "codex probe" "live probe: exit $rc${state:+ ($state)}" "rerun $BIN/gstack-doctor --live" ;; esac return fi gstack_codex_cache_read "$STATE_ROOT" local age age=$(gstack_codex_age_text "$_gcx_age") case "$_gcx_probe" in '') row warn "codex probe" "not probed; Codex readiness is unverified until a skill or --live runs it" "$BIN/gstack-doctor --live (one short paid Codex call)" ;; MODEL_OK) row ok "codex probe" "cached MODEL_OK, $age (not re-run; --live probes now)" ;; MODEL_UNUSABLE) row warn "codex probe" "cached MODEL_UNUSABLE, $age; $CODEX_FEATURES skip Codex" "$model_fix" ;; MODEL_QUOTA_EXHAUSTED) row warn "codex probe" "cached MODEL_QUOTA_EXHAUSTED, $age (the account's Codex usage limit)" "wait for the reset, then $BIN/gstack-doctor --live" ;; *) row warn "codex probe" "cached entry unrecognized, $age" "$BIN/gstack-doctor --live" ;; esac } check_sync() { local mode file json status held drainable drain push queue=0 now f detail fix="$BIN/gstack-brain-sync --status" mode=$("$BIN/gstack-config" get artifacts_sync_mode 2>/dev/null || echo off) if [ ! -d "$STATE_ROOT/.git" ]; then row "not configured" "artifacts sync" "off; cross-machine artifacts sync is unavailable" "$BIN/gstack-artifacts-init" return fi if [ "$mode" = off ]; then row "not configured" "artifacts sync" "artifacts_sync_mode off; cross-machine artifacts sync is unavailable" "$BIN/gstack-config set artifacts_sync_mode artifacts-only" return fi for f in "$STATE_ROOT/.brain-queue.d"/*.json; do [ -f "$f" ] && queue=$((queue + 1)); done for f in "$STATE_ROOT/.brain-queue.jsonl" "$STATE_ROOT/.brain-queue.jsonl.migrating"; do [ -f "$f" ] && queue=$((queue + $(wc -l < "$f" | tr -d ' '))) done file="$STATE_ROOT/.brain-sync-status.json" if [ ! -f "$file" ]; then if [ "$queue" -gt 0 ]; then row warn "artifacts sync" "no drain recorded while $queue record(s) are queued" "$fix" else row ok "artifacts sync" "mode $mode; no drain yet, queue empty"; fi return fi json=$(head -c 16384 "$file" 2>/dev/null | tr '\n\r' ' ') status=$(json_field status "$json") case "$status" in ok|idle|held|blocked|push_failed|error) ;; *) status=unknown ;; esac held=$(json_field held_count "$json" | tr -cd '0-9') drainable=$(json_field drainable "$json" | tr -cd '0-9') drain=$(epoch_of "$(json_field last_drain_at "$json")") push=$(epoch_of "$(json_field last_push_at "$json")") [ -n "$push" ] || push=$(epoch_of "$(head -1 "$STATE_ROOT/.brain-last-push" 2>/dev/null)") now=$(date +%s) case "$status" in held) row warn "artifacts sync" "status held${held:+ ($held file(s) held by the secret scanner)}" "$fix"; return ;; blocked) row warn "artifacts sync" "status blocked (a re-scan still flags staged content)" "$fix"; return ;; push_failed|error|unknown) row warn "artifacts sync" "status $status" "$fix"; return ;; esac if [ "${drainable:-0}" -gt 0 ] && { [ -z "$push" ] || [ $((now - push)) -gt 86400 ]; }; then row warn "artifacts sync" "status $status; no push for 24h while $drainable record(s) wait" "$fix" elif [ "$queue" -gt 0 ] && [ -n "$drain" ] && [ $((now - drain)) -gt 86400 ]; then row warn "artifacts sync" "status $status; no drain for 24h while $queue record(s) are queued" "$fix" else detail="status $status (mode $mode; queue $queue)" row ok "artifacts sync" "$detail" fi } check_browse() { local exe="" missing="" f case "${OSTYPE:-}" in msys*|cygwin*|win32*) exe=".exe" ;; esac if [ ! -x "$ROOT/browse/dist/browse$exe" ]; then row warn "browse bundle" "not built; the gstack browser fallback for /browse, /qa, /qa-only, /design-review, /make-pdf, /pair-agent is unavailable (the Aside browser is unaffected)" "cd $SRC && ./setup" return fi for f in server-node.mjs .build-complete; do [ -e "$ROOT/browse/dist/$f" ] || missing="${missing:+$missing, }$f"; done if [ -n "$missing" ]; then row warn "browse bundle" "incomplete build (missing browse/dist: $missing)" "cd $SRC && ./setup" else row ok "browse bundle" "browse/dist built" fi } check_claude() { local override cmd raw ver rc a local args=() override="${GSTACK_CLAUDE_BIN:-${CLAUDE_BIN:-}}" override="${override#\"}"; override="${override%\"}" if [ -n "$override" ]; then case "$override" in /*|[A-Za-z]:*) cmd="$override" ;; *) cmd=$(command -v "$override" 2>/dev/null) ;; esac raw="${GSTACK_CLAUDE_BIN_ARGS:-${CLAUDE_BIN_ARGS:-}}" case "$raw" in '') ;; '['*) raw="${raw#[}"; raw="${raw%]}" while IFS= read -r a; do a=$(printf '%s' "$a" | sed 's/^[[:space:]]*"\{0,1\}//; s/"\{0,1\}[[:space:]]*$//') [ -n "$a" ] && args+=("$a") done </dev/null) fi if [ -z "${cmd:-}" ]; then row "not configured" "claude code" "Claude Code CLI not found; the Claude Code host and Claude outside reviews are unavailable" "install Claude Code (https://code.claude.com), or set GSTACK_CLAUDE_BIN" return fi ver=$("$cmd" ${args[@]+"${args[@]}"} --version /dev/null) rc=$? ver=$(printf '%s\n' "$ver" | clamp 'A-Za-z0-9 ._()+-' 60) if [ "$rc" -ne 0 ]; then row warn "claude code" "$cmd --version failed (exit $rc)" "reinstall Claude Code (https://code.claude.com)" else row ok "claude code" "${ver:-version unknown} at $cmd" fi } check_journal() { local cwd dir f size largest=0 count=0 case "${OSTYPE:-}" in msys*|cygwin*) cwd=$(pwd -W 2>/dev/null || pwd -P) ;; *) cwd=$(pwd -P) ;; esac dir="${CLAUDE_CONFIG_DIR:-$HOME/.claude}/projects/$(printf '%s' "$cwd" | sed 's/[^A-Za-z0-9]/-/g')" for f in "$dir"/*.jsonl; do [ -f "$f" ] || continue count=$((count + 1)) size=$(wc -c < "$f" | tr -d ' ') [ "$size" -gt "$largest" ] && largest="$size" done if [ "$count" -eq 0 ]; then row ok "session journal" "no session journals for this project" return fi row ok "session journal" "largest of $count: $(awk -v b="$largest" 'BEGIN { if (b >= 1048576) printf "%.1f MiB", b / 1048576; else if (b >= 1024) printf "%.1f KiB", b / 1024; else printf "%d B", b }')" } check_guard_log() { local log="$STATE_ROOT/analytics/autoplan-guard.jsonl" summary if [ ! -f "$log" ]; then row ok "guard log" "no guard decisions logged" return fi summary=$(awk ' !/^\{/ || !match($0, /"schema"[[:space:]]*:[[:space:]]*1[,}[:space:]]/) { next } match($0, /"decision"[[:space:]]*:[[:space:]]*"(allow|deny)"/) { n++; if (substr($0, RSTART, RLENGTH) ~ /deny/) d++ } match($0, /"reason_code"[[:space:]]*:[[:space:]]*"[a-z0-9_]+"/) { c = substr($0, RSTART, RLENGTH); sub(/^[^:]*:[[:space:]]*"/, "", c); sub(/"$/, "", c) codes[k++ % 5] = c } END { out = (n + 0) " decisions (" (d + 0) " denied)" if (k > 0) { out = out "; last codes:"; sep = " " for (i = (k > 5 ? k - 5 : 0); i < k; i++) { out = out sep codes[i % 5]; sep = ", " } } print out }' "$log" 2>/dev/null) row ok "guard log" "${summary:-0 decisions (0 denied)}" } if ! . "$BIN/gstack-state-root.sh" 2>/dev/null; then row fail "state root" "$BIN/gstack-state-root.sh is missing" "reinstall gstack from a fresh checkout of https://github.com/garrytan/gstack, then run its ./setup" exit 1 fi gstack_state_root_select STATE_ROOT="$_gstack_sr_root" GSTACK_STATE_ROOT="$STATE_ROOT" . "$BIN/gstack-codex-status.sh" 2>/dev/null || { echo "gstack-doctor: $BIN/gstack-codex-status.sh is missing; reinstall with cd $SRC && ./setup" >&2; exit 1; } echo "gstack doctor $(head -1 "$ROOT/VERSION" 2>/dev/null | clamp '0-9A-Za-z.+-' 40)" check_install check_state_root check_bun check_hooks check_codex [ "$CODEX_READY" -eq 1 ] && check_codex_probe check_sync check_browse check_claude check_journal check_guard_log echo "$N_OK ok, $N_WARN warn, $N_NC not configured, $N_FAIL fail" [ "$N_FAIL" -eq 0 ]