Tanqory CLI
The Tanqory CLI (@tanqory/cli) is the developer tool for the two things you
can build on Tanqory and ship to the marketplace:
tanqory theme | storefront themes — scaffold, edit against your dev store's real data, push, submit |
tanqory app | marketplace apps (plugins) — scaffold, run framed on a dev store, push versions |
tanqory app dev is worth knowing before you start an app by hand. It creates
the app in the registry, writes your client id and secret into .env.local,
test-installs on a development store, prints the URL your app is framed at, and
starts your dev server — the whole
manual setup in one command.
npm install -g @tanqory/cli
tanqory --version
Requires Node.js 18+. The CLI installs from the public npm registry — no auth token or registry configuration needed.
What it does
| Command | What it does |
|---|---|
tanqory login | Authorize the CLI (opens your browser). |
tanqory theme init | Scaffold a new theme and create it in your dev store. |
tanqory theme dev | Run the theme on localhost:4321 with your store's live data. |
tanqory theme push | Upload your local theme to its store theme. |
tanqory theme pull | Download an existing store theme to keep developing it. |
tanqory theme submit | Submit the theme to the marketplace for review. |
The workflow at a glance
tanqory login # authorize (browser)
tanqory theme init my-theme # scaffold + create a theme in your dev store
cd my-theme && pnpm install
tanqory theme dev # localhost:4321 with live store data
# …edit sections/ and templates/, hot reload…
tanqory theme push # upload to the store (visible in Theme library)
tanqory theme submit --name "My Theme" --category FASHION
How it fits together
your machine Tanqory
┌───────────────┐ PAT (tqd_…) ┌──────────────────────────────────────┐
│ tanqory CLI │ ───────────────▶│ api.tanqory.com (public gateway) │
│ vite :4321 │ │ │ proxies (owns-store check) │
└───────────────┘ │ ▼ │
▲ live store data │ studio control plane (internal) │
└─────────────────────────┤ → your dev store's Theme library │
storefront GraphQL └──────────────────────────────────────┘
- Auth — a personal access token (
tqd_…) tied to your account. - Themes you create with the CLI appear in your store's Theme library, where you can preview, customize, and publish them.
- Starter — new themes are scaffolded from github.com/tanqory/tanqory-theme-nova, the reference Tanqory theme.
Continue with Getting started.