Skip to content

Commit 113087c

Browse files
authored
Merge pull request #783 from mattpocock/wizard-no-time-estimate
refactor(wizard): remove the minutes estimate
2 parents bb8fdc3 + cb7db0e commit 113087c

4 files changed

Lines changed: 18 additions & 20 deletions

File tree

.changeset/wizard-no-minutes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"mattpocock-skills": patch
3+
---
4+
5+
wizard: remove the time estimate. The template drops `TOTAL_MINUTES` and the time-remaining display, `stage` takes a name only, and progress is counted in stages.

docs/engineering/wizard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ None to generate one. The wizard it writes runs on bash, and uses `gh` when a st
2525

2626
## Stages
2727

28-
A **stage** is one focused task on one screen. The script clears the terminal between stages, so a stage that overflows the screen loses the part that scrolled away. You author stages in dependency order and set `TOTAL_STAGES` and `TOTAL_MINUTES`, which drive the time-remaining display — make the estimate honest, because the person running it will hold you to it.
28+
A **stage** is one focused task on one screen. The script clears the terminal between stages, so a stage that overflows the screen loses the part that scrolled away. You author stages in dependency order and set `TOTAL_STAGES`, which drives the progress display.
2929

3030
Scoping happens before a line is written. The [skill](https://www.aihero.dev/ai-coding-dictionary/skill) reads the repo instead of asking cold: `.env*`, `docker-compose*`, framework config, and every `secrets.*` / `vars.*` reference in `.github/workflows/` — each of those is a value the wizard has to produce. It then shows you the ordered stage list to confirm, and only after that maps each stage to the exact path a human follows ("Dashboard → Developers → API keys → Reveal test key → copy"). Where it doesn't know the current UI, it asks you or checks the docs rather than inventing clicks.
3131

skills/engineering/wizard/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: Generate an interactive bash wizard that walks a human through step
55

66
# Wizard
77

8-
A **wizard** is a bash script that walks a human, step by step, through a manual procedure that's tedious to do by hand and tedious to re-explain to an AI every time. It opens each URL, says exactly what to click and copy, captures the values, writes them where they belong (`.env`, GitHub secrets), confirms at every stage, and shows how much is left. It might configure third-party services, run a one-off migration, or move the project from one state to another.
8+
A **wizard** is a bash script that walks a human, step by step, through a manual procedure that's tedious to do by hand and tedious to re-explain to an AI every time. It opens each URL, says exactly what to click and copy, captures the values, writes them where they belong (`.env`, GitHub secrets), confirms at every stage, and shows how many stages are left. It might configure third-party services, run a one-off migration, or move the project from one state to another.
99

10-
The delightful UX is already solved by [template.sh](template.sh)progress with time-remaining, confirmation gates, cross-platform URL opening (including WSL), hidden secret entry, idempotent `.env` upserts, `gh secret`/`gh variable` writes, and a closing summary. **Your job is only to scope the procedure and author its stages.** The library above the `STAGES` marker is identical in every wizard; that consistency is the point — never hand-edit it.
10+
The delightful UX is already solved by [template.sh](template.sh)stage-by-stage progress, confirmation gates, cross-platform URL opening (including WSL), hidden secret entry, idempotent `.env` upserts, `gh secret`/`gh variable` writes, and a closing summary. **Your job is only to scope the procedure and author its stages.** The library above the `STAGES` marker is identical in every wizard; that consistency is the point — never hand-edit it.
1111

1212
A wizard is ephemeral by default — built for one run, saved to a scratch or `scripts/` path, deleted when the job's done. Commit it only when the user wants a repeatable setup path that should live in the repo.
1313

@@ -32,7 +32,7 @@ For each stage, write the precise path a human follows: which URL to open, what
3232

3333
### 3. Author the wizard
3434

35-
Copy `template.sh` to the target path. Replace the example stage with one `stage` per step, in dependency order. Use the library helpers — `stage`, `say`/`step`, `open_url`, `ask`/`ask_secret`, `write_env`, `set_secret`/`set_var`, `pause`/`confirm` — and set `TOTAL_STAGES` and `TOTAL_MINUTES` to honest estimates (this drives the time-remaining display).
35+
Copy `template.sh` to the target path. Replace the example stage with one `stage` per step, in dependency order. Use the library helpers — `stage`, `say`/`step`, `open_url`, `ask`/`ask_secret`, `write_env`, `set_secret`/`set_var`, `pause`/`confirm` — and set `TOTAL_STAGES` to the number of stages you wrote.
3636

3737
Hold the bar the template sets: open the URL before asking for its value, use `ask_secret` for anything secret, `write_env` every persisted value, `set_secret` only the values CI actually needs, and `confirm` before any irreversible action. Each `stage` clears the screen so only the current step is visible — keep a stage to one focused task so nothing the human needs scrolls away. Don't touch the library above the marker.
3838

skills/engineering/wizard/template.sh

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@ else
1919
BOLD=""; DIM=""; RESET=""; BLUE=""; GREEN=""; YELLOW=""; RED=""
2020
fi
2121

22-
# Author sets these two at the top of the stages section.
22+
# Author sets this at the top of the stages section.
2323
TOTAL_STAGES=0
24-
TOTAL_MINUTES=0
2524

2625
_STAGE_INDEX=0
27-
_MINUTES_ELAPSED=0
2826
ENV_FILE="${ENV_FILE:-.env}"
2927
WRITTEN_ENV=() # KEYs written to ENV_FILE this run
3028
WRITTEN_SECRET=() # secret NAMEs set this run
@@ -37,28 +35,24 @@ _clear() {
3735
if command -v tput >/dev/null 2>&1; then tput clear; else printf '\033[2J\033[3J\033[H'; fi
3836
}
3937

40-
# banner "Title" — opening frame: what this wizard does and how long it takes.
38+
# banner "Title" — opening frame: what this wizard does.
4139
banner() {
4240
_clear
4341
printf '\n%s%s %s%s\n' "$BOLD" "$BLUE" "$1" "$RESET"
44-
printf '%s %s stages · about %s minutes%s\n\n' \
45-
"$DIM" "$TOTAL_STAGES" "$TOTAL_MINUTES" "$RESET"
42+
printf '%s %s stages%s\n\n' "$DIM" "$TOTAL_STAGES" "$RESET"
4643
printf '%s You drive the browser; this wizard tells you exactly what to do and\n' "$DIM"
4744
printf ' captures the values you copy back. Stop any time with Ctrl-C and re-run\n'
4845
printf ' later — it remembers values already saved.%s\n' "$RESET"
4946
pause "Ready to start?"
5047
}
5148

52-
# stage "Name" <minutes> — clear the screen, then announce a stage and show
53-
# progress + time remaining. Clearing keeps only the current step on screen.
49+
# stage "Name" — clear the screen, then announce a stage and show progress.
50+
# Clearing keeps only the current step on screen.
5451
stage() {
5552
_clear
5653
_STAGE_INDEX=$((_STAGE_INDEX + 1))
57-
local remaining=$((TOTAL_MINUTES - _MINUTES_ELAPSED))
58-
(( remaining < 0 )) && remaining=0
59-
_MINUTES_ELAPSED=$((_MINUTES_ELAPSED + ${2:-0}))
60-
printf '\n%s%s▸ Stage %s/%s · %s%s %s(~%s min left)%s\n' \
61-
"$BOLD" "$BLUE" "$_STAGE_INDEX" "$TOTAL_STAGES" "$1" "$RESET" "$DIM" "$remaining" "$RESET"
54+
printf '\n%s%s▸ Stage %s/%s · %s%s\n' \
55+
"$BOLD" "$BLUE" "$_STAGE_INDEX" "$TOTAL_STAGES" "$1" "$RESET"
6256
}
6357

6458
# say "..." — a plain instruction line.
@@ -187,16 +181,15 @@ finish() {
187181

188182
# ──────────────────────────────────────────────────────────────────────────
189183
# STAGES — author this section. One stage() per step the human takes.
190-
# Replace the example below. Set the two totals to match the stages you write.
184+
# Replace the example below. Set TOTAL_STAGES to match the stages you write.
191185
# ──────────────────────────────────────────────────────────────────────────
192186

193187
TOTAL_STAGES=1
194-
TOTAL_MINUTES=5
195188

196189
banner "Stripe setup"
197190

198191
# ── Example stage: replace with your real steps ───────────────────────────
199-
stage "Stripe — API keys" 5
192+
stage "Stripe — API keys"
200193
say "We'll grab your Stripe test keys and store them for local dev + CI."
201194
open_url "https://dashboard.stripe.com/test/apikeys"
202195
step "On the API keys page, copy the Publishable key (starts pk_test_)."

0 commit comments

Comments
 (0)