Easy Orders CLI

CLI tool for creating and developing EasyOrders storefront themes. Edit Liquid templates, CSS, and JavaScript in the theme/ folder and preview changes on a live store instantly.

Full theme documentation — Liquid variables, palette, sections, events:

https://themes-docs.easy-orders.net/docs/custom-themes/getting-started

⚠️ Important Notice

The tunnel URL is linked to your current browser session. To end the session, stop the dev server, close the theme browser, or delete the local_theme_src cookie manually.

If the the site loads slowly after closing session, the browser may still be using a cached tunnel session. Deleting the local_theme_src cookie usually fixes the issue.

Installation

npm install -g easyorders

Usage

Create a new theme project

easyorders create my-theme

This scaffolds a new directory my-theme/ containing only the theme/ folder and a minimal package.json. No server code is included — the server runs from the CLI package itself.

Start the dev server

cd my-theme
easyorders start

This will:

1. Prompt you for your store subdomain (e.g. sand from sand.myeasyorders.com)
2. Authenticate with the Easy Orders API
3. Start a local Express server that serves your theme
4. Open a Cloudflare tunnel so your store can load the theme in real-time

Interactive mode

Running easyorders without arguments shows an interactive menu where you can choose to create a theme or start the dev server.

Environment Variables

Create a .env file in your theme project root (or export the variables) to customise the defaults:

| Variable | Description | Default | | ------------------- | ------------------------------------------------- | ----------------------------- | | PORT | Local server port | 4000 | | API_BASE_URL | Backend API base URL used for CLI token endpoints | https://api.easy-orders.net | | FRONTEND_BASE_URL | Frontend base URL used for the approval page | https://app.easy-orders.net | | STORE_DOMAIN | Domain used to build the store preview URL | myeasyorders.com |

Theme Project Structure

After running create, your project will look like:

my-theme/
├── package.json
├── .gitignore
└── theme/
    ├── config.json
    ├── schema.json
    ├── theme-data.json
    ├── style.css
    ├── script.js
    ├── sections/
    │   ├── header.liquid
    │   ├── footer.liquid
    │   └── ...
    └── home-sections/
        ├── <section-key>/
        │   ├── config.json
        │   └── template.liquid
        └── ...

You only need to edit files inside the theme/ folder. The server code is handled by the CLI.

🔑 Clearing Sessions & Auth

If you want to delete any saved sessions or store authentication, simply delete the .cli-tokens.json file in your theme project root:

rm .cli-tokens.json

The next time you run the dev server, you will be prompted to authenticate again.