Scaffold CLI
- IS: bootstrapping a brand-new TypeScript CLI or npm package (Node 24, TypeScript 7) from the pinned templates in
references/, through to a green first CI run and a package npm can publish over OIDC.
- IS NOT: a Next.js web app (use
scaffold-nextjs), folder structure or module contracts for an existing codebase (use codebase-architecture), auditing an existing CLI's ergonomics (use dx-audit), or shipping a release of an existing package (use autoship).
The templates encode the house toolchain. Substitute project values and verify template APIs against installed package versions; repair proven incompatibilities instead of blindly reproducing them. The toolchain is the opinion: tsdown not tsup, vitest not jest, oxlint and oxfmt via ultracite not eslint or prettier, node:util styleText not chalk, @clack/prompts not ora. Swapping any of them or restructuring the layout produces a repo the templates' notes no longer describe.
Reference Files
| File |
Read When |
references/scaffold-configs.md |
Step 3: package.json, pnpm-workspace.yaml, tsconfig, tsdown, gitignore, license, changeset config, GitHub Actions |
references/scaffold-source.md |
Steps 4-5: src/cli.ts, src/index.ts, src/types.ts, AGENTS.md, README.md, skills/SKILL.md |
references/agent-friendly-cli.md |
Step 4, only when a command takes an identifier, path, or URL, or mutates state: input validation, dry-run, confirmation, schema |
references/post-scaffold.md |
Steps 6-8: post-scaffold commands, validation checklist, GitHub and npm bootstrap, troubleshooting |
Scaffold Workflow
Copy this checklist to track progress:
Scaffold progress:
- [ ] Step 1: Gather project info
- [ ] Step 2: Create directory structure
- [ ] Step 3: Generate config files
- [ ] Step 4: Generate source files
- [ ] Step 5: Generate docs and skill
- [ ] Step 6: Run post-scaffold commands
- [ ] Step 7: Validate scaffold
- [ ] Step 8: Bootstrap GitHub and npm (with the user's go-ahead)
Step 1: Gather project info
Ask only for what the user didn't provide:
| Variable |
Example |
Default |
Used in |
{{name}} |
md-tools |
required |
package.json name, README title, npm package |
{{description}} |
CLI tool to convert content to markdown |
required |
package.json, README, SKILL.md |
{{bin}} |
md |
same as {{name}} |
package.json bin field, CLI examples, skills folder |
{{repo}} |
acme/md-tools |
required |
package.json repository, GitHub repo, npm trusted publisher |
{{author}} |
Your Name |
required |
package.json, LICENSE |
{{year}} |
2026 |
current year |
LICENSE |
{{repo}} must be the exact GitHub owner/name: npm provenance rejects a publish whose repository.url differs from the repo it came from.
Step 2: Create directory structure
{{name}}/
.changeset/
.github/
workflows/
src/
skills/{{bin}}/
Step 3: Generate config files
Load references/scaffold-configs.md. Generate every file there, replacing each {{placeholder}}:
package.json, pnpm-workspace.yaml, tsconfig.json, tsdown.config.ts, .gitignore, LICENSE.md, .changeset/config.json, .changeset/README.md, .github/workflows/ci.yml, .github/workflows/npm-publish.yml
Step 4: Generate source files
Load references/scaffold-source.md. Generate:
src/cli.ts: Commander entry point with agent-friendly defaults (--output text|json, --no-input, stdout data / stderr log split, JSON error envelope)
src/index.ts: Public API exports
src/types.ts: Shared type definitions
When a command takes an identifier, path, or URL, or mutates state, also load references/agent-friendly-cli.md and copy the matching pinned pattern. Skip it for a CLI with no such command.
Step 5: Generate docs and skill
From the same references/scaffold-source.md, generate:
AGENTS.md: commands, architecture, gotchas, agent invariants
README.md: install, usage, API, agent skill install, license
skills/{{bin}}/SKILL.md: agent skill definition
Use AGENTS.md directly; do not create a CLAUDE.md wrapper or symlink.
Step 6: Run post-scaffold commands
Load references/post-scaffold.md. Run the command sequence in the order given.
Step 7: Validate scaffold
Run the validation checklist in references/post-scaffold.md. Every item is a command whose output is the evidence; the checklist includes publint, arethetypeswrong, the hook exercised against real files, and the placeholder sweep.
Step 8: Bootstrap GitHub and npm
For a local scaffold, stop after Step 7. If the user already requested remote setup or publication, carry out that authorized scope. Otherwise present the prepared repository/package identity before asking to create or publish it. Otherwise follow "Bootstrap GitHub and npm" in references/post-scaffold.md: create and push the repo, enable Actions-created PRs, publish 0.0.1 once by hand so the package exists, then register the workflow as a trusted publisher. Terminal evidence is a green CI run on the pushed commit and npm view {{name}} version printing 0.0.1. From here every release belongs to autoship.
Dependencies
Runtime: @clack/prompts, commander
Development (in the package.json template): @changesets/cli, @types/node, tsdown, typescript, vitest
Added by ultracite init, never listed by hand: ultracite (pinned exact by init), oxlint, oxfmt, lefthook, plus the check, fix, and prepare scripts. By-hand entries produce duplicate scripts and version skew against what init installs.
Gotchas
- tsdown emits
.mjs by default. With platform: node fixedExtension defaults to on, so a config without fixedExtension: false builds dist/cli.mjs, dist/index.mjs, and dist/index.d.mts, and bin, exports, and types point at files that do not exist. The fixedExtension: false line on both template entries is what keeps them .js and .d.ts in a "type": "module" package; do not trim it as noise. Whatever the tsdown version, list dist/ after the build and confirm every path in bin, exports, main, and types names a file that is there.
- No shebang in
src/cli.ts. tsdown's banner injects #!/usr/bin/env node; a source shebang doubles it in dist/cli.js. The two build entries stay separate: the CLI entry has the banner and dts: false, the library entry has dts: true and no banner.
"test": "vitest run" without --passWithNoTests exits 1 on a repo with zero test files, so the first CI run goes red.
@changesets/cli@3 pairs with changesets/action@v2 and the publish-script: input. @v1 cannot drive changesets v3, and @v2 given the v1 publish: input versions the package and then completes green without publishing. The templates carry the matching pair; do not downgrade one side.
pnpm-workspace.yaml is not optional in this single-package repo. Without its allowBuilds entry for lefthook, pnpm stops ultracite init at pnpm add -D lefthook with ERR_PNPM_IGNORED_BUILDS, lefthook.yml is never written, and CI's pnpm install --frozen-lockfile fails the same way.
- npm cannot register a trusted publisher for a package that does not exist yet. The first release run fails
E404 or ENEEDAUTH until Step 8's one-time manual pnpm publish has created the package and the workflow is registered. That publish happens before any changeset exists, so it is the one manual publish autoship's rules do not forbid.
- Node 22 ships npm 10.9.x; OIDC publishing needs npm 11.5.1 or later. Node 24 ships npm 11.19, which is why both workflows pin
node-version: 24. Lowering it to 22 breaks publishing with ENEEDAUTH. The release workflow upgrades npm even though the project uses pnpm: pnpm publish can hand the upload to the npm CLI on PATH, and an older npm there fails OIDC.
- Agent-facing output is a format contract. Data on stdout, logs and progress on stderr; a stray
console.log breaks a consumer parsing --output json. Never prompt when stdin is not a TTY: honor --no-input and take every value as a flag, or the process hangs under a pipe.
Related Skills
autoship: every release after the bootstrap publish: changeset, CI watch, Version Packages PR, publish verification, and diagnosis of a release that did not publish.
dx-audit: audit the CLI's flags, errors, and types once real commands exist.
agents-md: grow the generated AGENTS.md as the codebase gains structure.
ghostwriter: rewrite the README once there is a real usage story to tell.
Maintenance only: evals/evals.json contains regression scenarios for changes to this skill; it does not load during a user task.
1---2name: scaffold-cli3description: Scaffolds a TypeScript CLI and npm package with the house toolchain, dual tsdown outputs, CLI contracts, changesets, and publishing templates. Use when asked to "scaffold a CLI" or "start an npm package".4compatibility: Requires a shell, Git, Node.js, pnpm, and npm registry access. Remote publishing requires the relevant account authentication.5metadata:6 source: https://skillmd.com/skills/tuyv/scaffold-cli7---89# Scaffold CLI1011- **IS:** bootstrapping a brand-new TypeScript CLI or npm package (Node 24, TypeScript 7) from the pinned templates in `references/`, through to a green first CI run and a package npm can publish over OIDC.12- **IS NOT:** a Next.js web app (use `scaffold-nextjs`), folder structure or module contracts for an existing codebase (use `codebase-architecture`), auditing an existing CLI's ergonomics (use `dx-audit`), or shipping a release of an existing package (use `autoship`).1314The templates encode the house toolchain. Substitute project values and verify template APIs against installed package versions; repair proven incompatibilities instead of blindly reproducing them. The toolchain is the opinion: tsdown not tsup, vitest not jest, oxlint and oxfmt via ultracite not eslint or prettier, `node:util` `styleText` not chalk, `@clack/prompts` not ora. Swapping any of them or restructuring the layout produces a repo the templates' notes no longer describe.1516## Reference Files1718| File | Read When |19|------|-----------|20| `references/scaffold-configs.md` | Step 3: package.json, pnpm-workspace.yaml, tsconfig, tsdown, gitignore, license, changeset config, GitHub Actions |21| `references/scaffold-source.md` | Steps 4-5: src/cli.ts, src/index.ts, src/types.ts, AGENTS.md, README.md, skills/SKILL.md |22| `references/agent-friendly-cli.md` | Step 4, only when a command takes an identifier, path, or URL, or mutates state: input validation, dry-run, confirmation, schema |23| `references/post-scaffold.md` | Steps 6-8: post-scaffold commands, validation checklist, GitHub and npm bootstrap, troubleshooting |2425## Scaffold Workflow2627Copy this checklist to track progress:2829```text30Scaffold progress:31- [ ] Step 1: Gather project info32- [ ] Step 2: Create directory structure33- [ ] Step 3: Generate config files34- [ ] Step 4: Generate source files35- [ ] Step 5: Generate docs and skill36- [ ] Step 6: Run post-scaffold commands37- [ ] Step 7: Validate scaffold38- [ ] Step 8: Bootstrap GitHub and npm (with the user's go-ahead)39```4041### Step 1: Gather project info4243Ask only for what the user didn't provide:4445| Variable | Example | Default | Used in |46|----------|---------|---------|---------|47| `{{name}}` | `md-tools` | required | package.json name, README title, npm package |48| `{{description}}` | `CLI tool to convert content to markdown` | required | package.json, README, SKILL.md |49| `{{bin}}` | `md` | same as `{{name}}` | package.json bin field, CLI examples, skills folder |50| `{{repo}}` | `acme/md-tools` | required | package.json repository, GitHub repo, npm trusted publisher |51| `{{author}}` | `Your Name` | required | package.json, LICENSE |52| `{{year}}` | `2026` | current year | LICENSE |5354`{{repo}}` must be the exact GitHub `owner/name`: npm provenance rejects a publish whose `repository.url` differs from the repo it came from.5556### Step 2: Create directory structure5758```59{{name}}/60 .changeset/61 .github/62 workflows/63 src/64 skills/{{bin}}/65```6667### Step 3: Generate config files6869Load `references/scaffold-configs.md`. Generate every file there, replacing each `{{placeholder}}`:7071`package.json`, `pnpm-workspace.yaml`, `tsconfig.json`, `tsdown.config.ts`, `.gitignore`, `LICENSE.md`, `.changeset/config.json`, `.changeset/README.md`, `.github/workflows/ci.yml`, `.github/workflows/npm-publish.yml`7273### Step 4: Generate source files7475Load `references/scaffold-source.md`. Generate:7677- `src/cli.ts`: Commander entry point with agent-friendly defaults (`--output text|json`, `--no-input`, stdout data / stderr log split, JSON error envelope)78- `src/index.ts`: Public API exports79- `src/types.ts`: Shared type definitions8081When a command takes an identifier, path, or URL, or mutates state, also load `references/agent-friendly-cli.md` and copy the matching pinned pattern. Skip it for a CLI with no such command.8283### Step 5: Generate docs and skill8485From the same `references/scaffold-source.md`, generate:8687- `AGENTS.md`: commands, architecture, gotchas, agent invariants88- `README.md`: install, usage, API, agent skill install, license89- `skills/{{bin}}/SKILL.md`: agent skill definition9091Use AGENTS.md directly; do not create a CLAUDE.md wrapper or symlink.9293### Step 6: Run post-scaffold commands9495Load `references/post-scaffold.md`. Run the command sequence in the order given.9697### Step 7: Validate scaffold9899Run the validation checklist in `references/post-scaffold.md`. Every item is a command whose output is the evidence; the checklist includes `publint`, `arethetypeswrong`, the hook exercised against real files, and the placeholder sweep.100101### Step 8: Bootstrap GitHub and npm102103For a local scaffold, stop after Step 7. If the user already requested remote setup or publication, carry out that authorized scope. Otherwise present the prepared repository/package identity before asking to create or publish it. Otherwise follow "Bootstrap GitHub and npm" in `references/post-scaffold.md`: create and push the repo, enable Actions-created PRs, publish 0.0.1 once by hand so the package exists, then register the workflow as a trusted publisher. Terminal evidence is a green CI run on the pushed commit and `npm view {{name}} version` printing `0.0.1`. From here every release belongs to `autoship`.104105## Dependencies106107**Runtime:** `@clack/prompts`, `commander`108109**Development (in the package.json template):** `@changesets/cli`, `@types/node`, `tsdown`, `typescript`, `vitest`110111**Added by `ultracite init`, never listed by hand:** `ultracite` (pinned exact by init), `oxlint`, `oxfmt`, `lefthook`, plus the `check`, `fix`, and `prepare` scripts. By-hand entries produce duplicate scripts and version skew against what init installs.112113## Gotchas114115- **tsdown emits `.mjs` by default.** With `platform: node` `fixedExtension` defaults to on, so a config without `fixedExtension: false` builds `dist/cli.mjs`, `dist/index.mjs`, and `dist/index.d.mts`, and `bin`, `exports`, and `types` point at files that do not exist. The `fixedExtension: false` line on both template entries is what keeps them `.js` and `.d.ts` in a `"type": "module"` package; do not trim it as noise. Whatever the tsdown version, list `dist/` after the build and confirm every path in `bin`, `exports`, `main`, and `types` names a file that is there.116- **No shebang in `src/cli.ts`.** tsdown's `banner` injects `#!/usr/bin/env node`; a source shebang doubles it in `dist/cli.js`. The two build entries stay separate: the CLI entry has the banner and `dts: false`, the library entry has `dts: true` and no banner.117- **`"test": "vitest run"` without `--passWithNoTests`** exits 1 on a repo with zero test files, so the first CI run goes red.118- **`@changesets/cli@3` pairs with `changesets/action@v2` and the `publish-script:` input.** `@v1` cannot drive changesets v3, and `@v2` given the v1 `publish:` input versions the package and then completes green without publishing. The templates carry the matching pair; do not downgrade one side.119- **`pnpm-workspace.yaml` is not optional in this single-package repo.** Without its `allowBuilds` entry for `lefthook`, pnpm stops `ultracite init` at `pnpm add -D lefthook` with `ERR_PNPM_IGNORED_BUILDS`, `lefthook.yml` is never written, and CI's `pnpm install --frozen-lockfile` fails the same way.120- **npm cannot register a trusted publisher for a package that does not exist yet.** The first release run fails `E404` or `ENEEDAUTH` until Step 8's one-time manual `pnpm publish` has created the package and the workflow is registered. That publish happens before any changeset exists, so it is the one manual publish `autoship`'s rules do not forbid.121- **Node 22 ships npm 10.9.x; OIDC publishing needs npm 11.5.1 or later.** Node 24 ships npm 11.19, which is why both workflows pin `node-version: 24`. Lowering it to 22 breaks publishing with `ENEEDAUTH`. The release workflow upgrades npm even though the project uses pnpm: `pnpm publish` can hand the upload to the npm CLI on `PATH`, and an older npm there fails OIDC.122- **Agent-facing output is a format contract.** Data on stdout, logs and progress on stderr; a stray `console.log` breaks a consumer parsing `--output json`. Never prompt when stdin is not a TTY: honor `--no-input` and take every value as a flag, or the process hangs under a pipe.123124## Related Skills125126- `autoship`: every release after the bootstrap publish: changeset, CI watch, Version Packages PR, publish verification, and diagnosis of a release that did not publish.127- `dx-audit`: audit the CLI's flags, errors, and types once real commands exist.128- `agents-md`: grow the generated AGENTS.md as the codebase gains structure.129- `ghostwriter`: rewrite the README once there is a real usage story to tell.130131Maintenance only: `evals/evals.json` contains regression scenarios for changes to this skill; it does not load during a user task.