Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
Introduction
The Vitrin CLI is a command-line tool for Zid theme developers.
It helps you develop, validate, and publish themes to the Zid platform directly from your local environment.
With the CLI, you can:
āØ Visual DashboardQuick access to all commands Real-time build status tracking Theme and authentication information at a glance
šØ Build & DevelopmentVisual build progress with step-by-step feedback Watch mode with live file change detection Instant theme preview on dev stores
šØ Theme ManagementCreate, browse and select existing themes One-click theme preview deployment Automatic theme detection in current directory
š Authentication & SettingsEasy login/logout flow Configure API endpoints Persistent settings management
Installing the CLI
Quick Start
Launch the interactive TUI (recommended)
Use CLI Commands Directly:
Configuration
Environment Variables
VITRIN_API_URL - API endpoint (default: https://api.zid.sa)VITRIN_PARTNER_URL - Partner dashboard URL (default: https://partner.zid.sa)LOG_LEVEL - Logging level (debug, info, error)Debug Mode
File Structure
Authentication
~/.vitrin/config.json.Troubleshooting
Please report issues on our GitHub tracker: zidsa/vitrin-cli/issues
Authentication Issues
Build Failures
assets/, templates/)package.json.DS_Store files (these are auto-cleaned during build)Preview Errors
vitrin loginvitrin list storesExplore Vitrin CLI Commands page for detailed syntax and options for each command.
Modified atĀ 2025-10-08 10:07:25