Get started with the CLI

1. Install the CLI

The CLI is the npm package @tanqory/cli and runs on Node.js 18 or later. The Nova starter it scaffolds asks for more: Node.js 22.6 or later and pnpm 9.7 or later.

npm install -g @tanqory/clitanqory --version

2. Have a dev store

Themes are built in a dev store, not in a live one. If you have none yet, tanqory theme list answers "No dev stores yet. Create one at dev.tanqory.com."

3. Sign in

tanqory logintanqory whoami

login opens your browser, where you approve the CLI, and stores the token on your machine. whoami prints the account it belongs to. Tokens for CI are in CLI authentication.

4. Scaffold a theme

tanqory theme init my-themecd my-themepnpm install

1. Downloads the Nova starter from github.com/tanqory/tanqory-theme-nova into my-theme/.
2. Asks which dev store to use, unless you pass --store <id>.
3. Creates a new theme in that store, named after the folder unless you pass --name.
4. Writes tanqory.json, which links the folder to that store and theme so later commands need no flags.

Signed out, init scaffolds the folder only; the theme is created in a store on your first tanqory theme push.

5. Run it on your machine

tanqory theme dev

The theme runs at http://localhost:4321 with your dev store's real data. Add --mock to work offline with bundled sample data. The folders you will edit are in Theme anatomy.

6. Push to your store

tanqory theme push

Push uploads your source to the linked theme and the storefront rebuilds. The theme then shows in the store's Theme library.

Submit for review

tanqory theme submit \  --name "Aurora" \  --tagline "A bold theme for fashion brands" \  --category FASHION

Only --name is required. The theme enters review as submitted; when a reviewer approves it, it is published under Popular free themes. Every submit flag is in CLI commands.