📦 @zidsa/themes-cli

A powerful CLI tool to assist Zid partners with theme development.

🔐 Prerequisites

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

⚙️ Installation

Ensure you have Node.js installed on your system. If you're starting a new project, initialize it with npm init or yarn init.

Install the package globally using npm:

npm install -g @zidsa/themes-cli

Or using Yarn:

yarn global add @zidsa/themes-cli

💻 Available Commands

| Command | Description | Usage | Documentation | | --------- | ------------------------------------------ | ------------------------------ |------------------------------------------| | build | Build your theme for deployment | themes-cli build [options] | Build Documentation | | new | Create a new theme project | themes-cli new [options] | New Theme Documentation | | help | Display help information for commands | themes-cli help | - | | login | Authenticate with your Zid partner account | themes-cli login | Login Documentation | | list | List available themes in your account | themes-cli list | List Documentation | | preview | Preview your theme in a demo store | themes-cli preview [options] | Preview Documentation | | update | Submit an update for your theme | themes-cli update [options] | Update Documentation |

For detailed information on each command, click the documentation links above or run:

themes-cli help

🚀 Quick Start

1. Install the @zidsa/themes-cli CLI tool globally.
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 directory:

   cd my-awesome-theme

5. Build your theme:

   themes-cli build

6. Preview your theme in a demo store:

   themes-cli preview --store_email [email protected]

7. Preview your theme in a demo store:

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

📄 License

This project is licensed under the MIT License.

🆘 Support

If you encounter any issues or have questions, please:

• If you can't find a solution, open an issue in our GitHub repository.

For more information on Zid theme development, visit our official documentation.