DeploTeka Set up your first store
Developer docs: CLI

CLI

npx deploteka, run in your app’s repository, does the whole setup: it pairs with your workspace, prepares your code, adds the app, connects your backend and Shopify, and starts the deploy agent. It is safe to run again.

Commands

CommandDoes
npx deplotekaThe full setup, in the current repository.
npx deploteka onboard . --applyOnly prepares the repository. Without --apply it shows the changes and writes nothing.
npx deploteka connectOnly connects a Shopify organization.
npx deploteka mcpStarts the MCP server for AI tools. See MCP.

Needs Node.js 20.19 or newer. The first run opens your browser once to approve this computer.

Flags

FlagDoes
--yes, -ySkip confirmation prompts.
--resetIgnore the cached credential and pair again from scratch.
--reconnectRefresh only the Shopify session. Works in any directory.
--no-agentStop before starting the deploy agent.
--githubWrite a GitHub Actions workflow that runs releases for you, then exit.
--app-url <url>The backend URL to check. Defaults to application_url from the toml.
--target <dir>The repository to work on. Defaults to the current directory.
--manualPaste the Shopify session instead of capturing it in a browser.
--share-release-accessSend native App Management access for the registered app, with a one-hour limit.

What it changes in your code

It detects your framework first and says which one in its first line.

  • Remix v2–v4, React Router v7: it changes the code for you, shows the diff, then runs your own typecheck or build.
  • Express, Laravel: it never writes to your app. It names our package and prints the steps, about 10–30 minutes of your time.
  • Rails, Python, raw Node, extension-only: a guide and starter files.

Keep releases running

Each client store gets its own app in your Shopify organization, and Shopify releases each one only with a Shopify CLI login or a service-account key for that one app. The simplest way: connect the release login once under Settings → App releases. You approve one Shopify sign-in that can manage your apps (not read store data), and DeploTeka releases every new store of every app from its own server, token-delivery apps included. Updates from an app’s Update screen run from there too, except for an app that ships extensions, which goes through the deploy agent.

To keep releases on your side instead, run the deploy agent, signed in to Shopify CLI as you. Keep it running on a computer or server that stays on: create a pass for the app on the Deploy agent page, set it as DEPLOTEKA_TOKEN and run npx deploteka-deploy-agent in the repository. A pass lasts 90 days and sees only its app.

A GitHub Actions workflow, which npx deploteka --github writes, cannot sign in as you. Its service-account token covers one app, so it fits an app with one client store, not a fleet.