Skip to main content

Getting Started

This walks you from zero to a theme running locally with live data and pushed to your dev store.

1. Install​

npm install -g @tanqory/cli
tanqory --version

Requires Node.js 18+ and pnpm for the theme itself.

2. Create a dev store​

A dev store is a free, private store for building themes. Create one at dev.tanqory.com → Dev stores → Create dev store. Enable Generate sample data so your theme has real products, collections, and pages to render.

3. Log in​

tanqory login

This opens your browser, you approve, and the CLI stores a token in ~/.tanqory/config.json. Confirm it worked:

tanqory whoami

See Authentication for tokens and CI.

4. Scaffold a theme​

tanqory theme init my-theme

You'll be asked which dev store to create the theme in (use ↑/↓ then Enter). This:

  1. Downloads the Nova starter from GitHub into my-theme/.
  2. Creates a new theme in your dev store — it appears in the store's Theme library immediately, as its own unpublished theme (it does not touch any live theme).
  3. Writes a tanqory.json linking the folder to that store + theme.
cd my-theme
pnpm install

5. Develop locally with live data​

tanqory theme dev

Opens http://localhost:4321 rendering your dev store's real products and collections, with hot reload. Edit files under sections/ and templates/ and the page updates instantly.

tanqory theme dev --mock     # offline, uses bundled sample data

See Theme anatomy for what to edit.

6. Push to your store​

tanqory theme push

Uploads your local source to the theme created in step 4. The storefront rebuilds, and the theme is visible in the store's Theme library, where you (or the merchant) can Customize, Preview, and Publish it.

7. Submit to the marketplace​

When it's ready:

tanqory theme submit \
  --name "Aurora" \
  --tagline "A bold theme for fashion brands" \
  --category FASHION \
  --thumbnail https://…/cover.png \
  --demo-url https://…

It enters the review queue. Once a reviewer approves it, it's published and appears in Popular free themes for other stores to install.

The daily loop​

edit  →  tanqory theme dev   (see it on localhost)
      →  tanqory theme push  (update the store)
      →  tanqory theme submit (when ready to publish)