1.1.0 • Published 6 months ago
@zidsa/themes-cli v1.1.0
📦 @zidsa/themes-cli
A powerful CLI tool to assist Zid partners with theme development.
🔐 Prerequisites
⚙️ 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
- Install the
@zidsa/themes-cli
CLI tool globally. - Authenticate with your Zid partner account:
themes-cli login
- Create a new theme project:
themes-cli new my-awesome-theme
- Navigate to your new theme directory:
cd my-awesome-theme
- Build your theme:
themes-cli build
- Preview your theme in a demo store:
themes-cli preview --store_email your-demo-store@zid.dev
- 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.