Skip to main content

Command Reference

tanqory <command> [subcommand] [options]
tanqory --help
tanqory --version

Most theme commands accept --store and --theme. If you omit them, the CLI uses the values recorded in tanqory.json (from init/pull), and prompts you to pick a store when needed.

Auth​

tanqory login​

Authorize the CLI.

OptionDescription
--token <token>Use a tqd_… token instead of the browser flow.
--api <url>Override the API base URL.

tanqory logout​

Remove the stored token.

tanqory whoami​

Print the account the stored token belongs to.

App​

Marketplace apps (plugins), not themes. Everything under tanqory app reads tanqory.app.json from the current directory.

tanqory app init [dir]​

Scaffold a new app with create-tanqory-app — manifest, embedded page and webhook handler already wired.

tanqory app dev​

The one command that replaces the whole manual setup. In order, it:

  1. reads tanqory.app.json
  2. creates the app in the registry if this directory is not linked to one yet, and writes TANQORY_CLIENT_ID / TANQORY_CLIENT_SECRET into .env.local for you
  3. pushes the manifest as a version
  4. test-installs it on a development store
  5. prints the URL your app is framed at, and opens it with --open
  6. watches tanqory.app.json and re-pushes on save — a scope change re-installs, so consent is asked again
  7. starts your dev server (pnpm dev, yarn dev or npm run dev, chosen from the lockfile)
OptionDescription
--store <id>Development store to test-install on (otherwise you pick one).
--openOpen the framed app in your browser.
--no-serverPush and install only; do not start the local dev server.

Test installs only work on a development store. The CLI says so and names the flag if you point it at a live one.

tanqory app deploy​

Alias tanqory app push. Sends tanqory.app.json to the registry as a new version. New scopes go to review before they go live; everything else does not.

tanqory app info​

Your app's status and latest version.

Theme​

tanqory theme init [dir]​

Scaffold a new theme from Nova and create it in your dev store (it appears in the store's Theme library as a new, unpublished theme).

OptionDescription
--store <id>Dev store to create the theme in (otherwise you pick one).
--name <name>Theme name shown in the store (defaults to the folder name).
tanqory theme init my-theme --name "Aurora"

If you're not logged in, init still scaffolds locally; the theme is created in a store on your first push.

tanqory theme dev​

Run the theme on http://localhost:4321 with your store's live data (hot reload).

OptionDescription
--store <id>Dev store to pull live data from.
--theme <id>Theme id (defaults to the store's active theme).
--mockUse bundled sample data instead of live store data (offline).
--syncPush edits to the store theme on save, so the visual editor + preview reflect them. See Code + Visual Editor.

tanqory theme push​

Upload the local theme source to its store theme and rebuild the storefront. Targets only the linked theme (from init/pull) or --theme — it never overwrites your other themes. With no linked theme, it creates a new one.

OptionDescription
--store <id>Dev store.
--theme <id>Theme id to push to.

tanqory theme pull [dir]​

Download an existing store theme into dir (or the current folder) so you can continue developing it. Normalizes dependencies so pnpm install works.

OptionDescription
--store <id>Dev store.
--theme <id>Theme id to pull.

tanqory theme list​

List your dev stores and the themes in each (● = published, ○ = draft).

tanqory theme submit​

Submit the store's theme to the marketplace for review.

OptionDescription
--name <name>Required. Marketplace listing name.
--tagline <text>Short one-liner shown on the theme card.
--description <text>Longer description.
--category <cat>e.g. FASHION, ELECTRONICS, FOOD, GENERAL.
--thumbnail <url>Cover image URL.
--demo-url <url>A live demo storefront reviewers can click through.
--author-website <url>Your website.

Configuration files​

FilePurpose
~/.tanqory/config.jsonGlobal — your token and API URL.
tanqory.json (in the theme)Project — the linked storeId, themeId, and theme name.

Environment variables​

VariablePurpose
TANQORY_TOKENToken to use (for CI).
TANQORY_API_URLOverride the API base URL.
TANQORY_WEB_URLOverride the Dev Dashboard URL used by login.
TANQORY_STARTER_REFGit ref of the starter repo for init (default main).