Themes CLI

A robust Command-Line Interface tool designed to empower Zid partners in creating and maintaining custom themes for their stores.

:::info[]

Prerequisites

• Node.js (version 14 or higher)
• NPM (Node Package Manager) or Yarn
  :::

🔧 Installation

Make sure Node.js is installed on your system. To start a new project, initialize it with npm init or yarn init.

Install the CLI tool globally:

# Using npm
npm install -g @zidsa/themes-cli

# Using Yarn
yarn global add @zidsa/themes-cli

🚀 Quick Start

1. Install the CLI tool globally:

   npm install -g @zidsa/themes-cli
   

2. Authenticate with your Zid partner account:

   themes-cli login
   

3. Create a new theme project:

   themes-cli new my-awesome-theme
   

4. Navigate to your new theme’s directory:

   cd my-awesome-theme
   

5. Build your theme for deployment:

   themes-cli build
   

6. Preview your theme in a demo store:

   themes-cli preview --store_email your-demo-store@zid.dev
   

7. Submit an update for your theme:

   themes-cli update --theme_id abc123def456 --change_type minor --release_notes "Added new footer design and improved mobile responsiveness"
   

💻 Available Commands

For detailed information on each command, refer to the documentation links or run:

themes-cli help