wizard

Files (2)

• SKILL.md
• template.md · resources/

SKILL.md (first lines)

<!-- Adapted from mattpocock/skills wizard at 6654f6b60cd9d5be8b54c6fafe44346dabeb3b76 (MIT). -->

# Wizard

A **wizard** is a bash script that walks the user, 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.

The delightful UX is already solved by [template](resources/template.md): 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.

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.

## Process

### 1. Scope the procedure

Work out every manual step the user must take and every value that gets captured along the way. Read the repo first, don't ask cold:

- For setup: the permitted templates and config, respecting off-limits (off-limits blocks `.env*` reads; the whitelist exempts `.env.example`): `.env.example`, `README`, `docker-compose*`, framework config, and `.github/workflows/*` (every `secrets.*` / `vars.*` reference is a value the wizard must produce).
- For a migration or transition: the current state, the target state, and the irreversible actions between them.

Then show the user the ordered list of stages and the values each produces, and confirm: he may add, drop, or reorder.

Never put a decision in a wizard, in prose or any other form: a decision needs context and a way to ask back, so settle each one in conversation before you author; the script asks the user only for operational confirmations (y/N or Enter to continue) and captured values (a secret, an identifier, a path).

**Done when:** every stage is named in order, and for each captured value you know (a) where the user gets it, (b) where it's written (`.env`, a GitHub secret, both, or nowhere; some stages are pure actions), and (c) whether it's secret (hidden entry) or public.

### 2. Map each stage's journey

For each stage, write the precise path the user follows: which URL to open, what to do there, where a value is shown, which variable it fills: e.g. "Dashboard → Developers → API keys → Reveal test key → copy". Where you don't actually know the current UI or the exact command, say so and ask the user or check the docs: never invent steps that may not exist.

Give each stage an outcome you can inspect without seeing a secret: a file exists, a command answers, a service responds, a non-secret config value is set; after the user runs the stage, check it yourself.

**Done when:** every stage traces to concrete instructions a stranger could follow.

### 3. Author the wizard

Copy the bash code block from [template](resources/template.md) to the target script 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`. Set `TOTAL_STAGES` to the number of stages you wrote.

Hold the bar the template sets: open the URL before asking for its value, use `ask_secret` for anything secret, `write_env` only the values whose destination includes `.env`, `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 user needs scrolls away. Don't touch the library above the marker. The script runs from any directory: below the marker, set `ENV_FILE` to an absolute path and export `GH_REPO=<owner>/<repo>` when it writes GitHub secrets.

Only when a step would otherwise have the user paste output back, the script may log that output (never a secret) to a file in the OS temp folder, which you delete after reading; the log is context, not proof, so check the result with a fresh command (a logged install isn't an installed package until you run it).

### 4. Verify and hand off

- `bash -n <script>`; run `shellcheck` if available.
- `chmod +x <script>`.
- Don't run it end-to-end yourself: it opens browsers and blocks on user input. Trace it statically instead: every value from step 1 is captured and lands where step 1 said, and every `set_secret` name exactly matches a `secrets.*` reference in CI.
- Hand the user one line he pastes into his current terminal and runs with Enter, nothing before it. Use absolute paths, and launch bash in the line when the terminal isn't bash: from PowerShell, `& "C:\Program Files\Git\bin\bash.exe" "C:/abs/path/wizard.sh"`; on Linux and macOS, `bash /abs/path/wizard.sh`. If it's a repeatable setup path, commit it and link it from the README so the next person runs the script instead of asking an AI.

From bodnarbalazs/dydo, MIT.

More from bodnarbalazs/dydo