A powerful CLI tool to assist Zid partners with theme development.
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
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
@zidsa/themes-cli
CLI tool globally.themes-cli login
themes-cli new my-awesome-theme
cd my-awesome-theme
themes-cli build
themes-cli preview --store_email your-demo-store@zid.dev
themes-cli update --theme_id abc123def456 --change_type minor --release_notes "Added new footer design and improved mobile responsiveness"
This project is licensed under the MIT License.
If you encounter any issues or have questions, please:
For more information on Zid theme development, visit our official documentation.