Skip to main content

​
Overview

The Komerza CLI lets you develop storefronts locally instead of inside the browser-based Builder. It keeps your local files in sync with your Builder project in real time, and lets you deploy directly to production from the terminal. The typical workflow is: clone → dev → deploy.

​
Installation

Once installed, the komerza command is available globally.

​
Authentication

​
Login

Opens a browser window to authenticate with your Komerza account. Credentials are stored securely in your OS keychain - no tokens to copy and paste.

​
Logout

​
Check who you’re logged in as

Prints your account and the stores associated with it.

​
Cloning a Project

Downloads a Builder project to your local machine. If you omit the project ID, you’ll get an interactive list to pick from. This creates:
  • A directory named after your project
  • A .komerza/config.json file tracking the project - commit this file
  • A .gitignore
Options:

​
Local Development

Starts your local dev server and watches for file changes. Any saved file is automatically synced to the Builder within 1.5 seconds.
  • Detects your package manager (npm, pnpm, yarn, or bun) automatically
  • Requires a "dev" script in package.json
The dev server and file-watching run together in the same terminal process. Stop the server (Ctrl+C) to exit both.

​
Deploying

Builds the project and deploys it to production.
  1. Runs your build script from package.json
  2. Finds the build output (dist, out, build, .next/out, or public/dist)
  3. Uploads it and makes it live
The live store URL is printed on success.

​
Environment Variables

Manage env vars stored on your Builder project.

​
Other Commands

​
Manual sync

Both are manual escape hatches. Most workflows only need dev and deploy. komerza pull will ask for confirmation if local files already exist. Use -f / --force to skip the prompt.

​
List projects

Lists all Builder projects linked to your account.

​
Open in browser

​
Config File

.komerza/config.json is created when you run komerza clone. It stores: Commit this file - it is required by most CLI commands.

​
File Size Limit

Files larger than 12 MB are not synced.
Last modified on July 31, 2026