@usequeek/create-theme

Start a theme for Queek storefronts from the official starter.

Usage

Create a Queek storefront theme.

  npm create @usequeek/theme@latest my-theme -- --templates laundry --tags minimal
  pnpm create @usequeek/theme my-theme --templates laundry --tags minimal

npm needs -- before these flags. In a terminal, anything you leave out is asked,
and with no folder the folder is named after the theme (my-theme with --yes or no terminal).

  --name <text>          theme name (default: the folder name)
  --templates <keys>     businesses to make templates for, comma-separated (required with --yes)
  --primary <key>        the main template (default: the first)
  --categories <keys>    business categories (default: the templates')
  --tags <tags>          1–6 tags for the look (required with --yes)
  --pages <list|none>    extra pages: contact, faq (default: both)
  --ai <list>, --no-ai   AI assistants: claude, gemini (default: both; AGENTS.md unless --no-ai)
  --pm <npm|pnpm|yarn|bun>, --no-install, --no-git
  --yes, -y              never prompt; take the default for everything else
  --dry-run              print what would be written; write nothing
  --force                allow a folder that is not empty
  --template <source>    another starter: a giget source or a local folder

The starter is pinned to the tag matching this package's version. Everything is written into a temporary folder and moved into place at the end.

What you get

A theme is the look, a template is a business it is dressed as, and a design is one demo store of a template. Each business you pick becomes a template with one design. The main template's (--primary) is theme/demo.json; each other template's is theme/demos/<key>.json. theme/theme.config.ts declares every design with its template key, the business picked, so a template is never inferred from a design id. To give a template a second design later, add its demo file and declare { id, template, design_label, description }; a template with two or more designs names each one by its own design_label.

Right after create, npm run check rejects exactly your to-do list. For a one-template theme that is four rules: theme/placeholder-content (the starter's placeholder products and photos, and the theme's placeholder description), theme/structure and theme/template-screenshot (each design's screenshot), and theme/template-description (each design's description). With two or more templates, theme/template-versions is added: each design must have its own home page.

The target folder must be missing, empty, or hold only .git. The --force flag allows writing into another folder but refuses file-or-folder clashes and symlinks at paths the starter writes. A regular file at the target path is always refused.

License

MIT