Scaffold CLI

Reference Files

references/scaffold-configs.md

references/scaffold-source.md

references/post-scaffold.md

Scaffold Workflow

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 1: Gather project info

{{name}}

md-tools

{{description}}

CLI tool to convert content to markdown

{{bin}}

md

{{name}}

{{repo}}

acme/md-tools

{{author}}

Your Name

{{year}}

2026

Step 2: Create directory structure

{{name}}/
  .changeset/
  .github/
    workflows/
  src/
  skills/{{bin}}/

Step 3: Generate config files

references/scaffold-configs.md

{{placeholder}}

package.json

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

references/scaffold-source.md

• src/cli.ts

  — Commander entry point

• src/index.ts

  — Public API exports

• src/types.ts

  — Shared type definitions

Step 5: Generate docs and skill

references/scaffold-source.md

• AGENTS.md

  — Commands, architecture, gotchas

• README.md

  — Badges, features, install, usage, API, license

• skills/{{bin}}/SKILL.md

  — Agent skill definition

ln -s AGENTS.md CLAUDE.md

Step 6: Run post-scaffold commands

references/post-scaffold.md

Step 7: Validate scaffold

references/post-scaffold.md

Placeholder Reference

{{variable}}

{{name}}

{{description}}

{{bin}}

{{repo}}

{{author}}

{{year}}

Dependencies

@clack/prompts

commander

gray-matter

@changesets/cli

@types/node

tsdown

typescript

ultracite

vitest

node:util

@clack/prompts

Anti-patterns

• Do not use CommonJS — all output must be ESM with

  "type": "module"

• Do not skip AGENTS.md or

  skills/

  directory — every CLI project needs agent instructions
• Do not create test files in the scaffold — let the user add tests for their specific features
• Do not merge the dual tsdown builds — CLI (with shebang) and library (with dts) must stay separate
• Do not call oxlint or oxfmt directly — always use

  ultracite fix

  or

  ultracite check

• Do not configure git hooks manually — ultracite sets up lefthook automatically
• Do not add chalk or ora — use

  node:util

  styleText for colors and

  @clack/prompts

  spinner