Zid Docs
Merchant APIPayment APIAppsThemes
Merchant APIPayment APIAppsThemes
Help Center
Slack
  1. Themes CLI
  • 🚨 Important Update: Zid Themes
  • Landing Page Development
  • Getting Started with Zid Themes
    • Introduction to Theme Development
    • Manage your Themes
    • Building Themes in Zid
    • Theme File Structure
    • Twig Syntax and Features
    • Zid Theme Packager
  • Templates
    • Layout
    • Home Page
    • Products
    • Cart
    • Store Language and Currency
  • Settings Schema
    • Text
    • Number
    • Text-Area
    • Select
    • Radio Buttons
    • Checkbox
    • Range
    • Color
    • Image
    • Product
    • Category
    • List
    • Fieldset
  • Code Snippets
    • Apple Pay Quick Checkout
    • Custom CSS Injection
    • Displaying the Store's Business Center Logo
    • Customizing Copyright Text
    • Store's Main Navigation Menu
    • Customer Wishlist
    • Store Social Media
    • Products
      • Products Badges
      • Product Ratings
      • Remaining Product Stock
      • Sold Items Count
      • Product Filtration by Attributes
      • Grouped Products
      • Product Questions & Answers
      • Product Restock Notfication
    • SEO
      • Images alt text
      • Themes SEO Marketing Tags
    • Marketing
      • Metafields
      • Gift Feature
      • Loyalty Program
  • Zid Themes Library: API Integration
    • Products
    • Product Categories
    • Cart
    • Blog
    • Customer
    • Store Settings
  • Data Reference
    • Locals
    • Store
    • Cart
    • Product
    • Products List
    • Category
    • Categories List
    • Session
    • FAQs
    • Customer
    • Blogs
    • Page
    • Main Menu
    • Main Navigation Menu
    • Request
    • Orders
    • Addresses
    • Store Payment Methods
    • Store Shipping Methods
    • Store Banks
    • Asset URL
    • Header Meta Tags
    • Loyalty pogram Wallet
  • Themes CLI
    • CLI Authentication
    • Theme Create
    • Theme Package
    • Theme Update
    • Themes List
    • Theme Preview
  1. Themes CLI

Theme Preview

Preview your theme in development using a Zid demo store.

Description#

The preview command allows you to visualize your current theme in development using one of the demo stores associated with your Zid partner account. This command helps you see how your theme looks and functions in a live environment before deploying it to production.

Usage#

Required Options#

--store_email <email>: The email address associated with the development store you want to use for the preview.

Authentication#

This command requires authentication to access your Zid partner account and associated development stores.
If you're not logged in, the system will prompt you to log in.
Use the themes-cli login command to authenticate.

Finding Your Development Stores#

A list of your development stores can be found in the Zid Partner Dashboard.
Each store will have an associated email address that you'll need to use with this command.

Process#

1.
Authenticate: The command will authenticate your account if you're not already logged in.
2.
Locate Store: It will locate the development store associated with the provided email.
3.
Upload Theme: Your current theme will be temporarily uploaded to the selected store.
4.
Preview URL: A preview URL will be generated and displayed in the console.
5.
Preview Theme: Open the URL in your web browser to see your theme in action.

Example#

Expected Output#

Authenticating...
Finding development store for partner123@zid.dev...
Uploading theme to store...
Preview URL: http://demo.zid.dev/preview/your-theme

Important Notes#

Root Directory: Ensure you're in the root directory of your theme when running this command.
Local Changes: Any changes made to your local files will not be reflected in the preview until you re-run the command.

Troubleshooting#

If you encounter issues:
ProblemSolution
Incorrect email or store not foundVerify that you're using the correct email for an existing development store.
Not authenticatedEnsure you are authenticated by running the themes-cli login command.
Invalid theme structureCheck that your theme follows the required structure and passes validation.

Learn More#

For more information on theme development and deployment, refer to the Zid Theme Development Documentation.
Modified at 2025-01-23 11:02:32
Previous
Themes List
Built with