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 Dashboard

Quick access to all commands

Real-time build status tracking

Theme and authentication information at a glance

🔨 Build & Development

Visual build progress with step-by-step feedback

Watch mode with live file change detection

Instant theme preview on dev stores

🎨 Theme Management

Create new themes with guided setup

Browse and select existing themes

Automatic theme detection in current directory

🔐 Authentication & Settings

Easy login/logout flow

Configure API endpoints

Persistent settings management

📦 Store Operations

List and manage dev stores

One-click theme preview deployment

Install and activate themes visually

📦 Installing the CLI

Commands

Interactive TUI Mode

Launch the beautiful interactive terminal interface for a streamlined development experience:

Or:

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

Run with detailed logging for troubleshooting:

File Structure

Expected theme structure:

Authentication

Authentication tokens are stored in ~/.vitrin/config.json.

To logout:

Troubleshooting

Found a bug or unexpected behavior?
Please report issues on our GitHub tracker: zidsa/vitrin-cli/issues

Authentication Issues

Build Failures

Common causes:

Missing required directories (assets/, templates/)

Invalid or missing package.json

.DS_Store files (these are auto-cleaned during build)

Preview Errors

Common causes:

Expired authentication token → run vitrin login

Invalid store ID → check using vitrin list stores

Theme name conflict → CLI auto-generates a unique name

Explore Vitrin CLI Commands page for detailed syntax and options for each command.

With the CLI, you can:#

📦 Installing the CLI#

Commands#

Interactive TUI Mode#

Configuration#

Environment Variables#

Debug Mode#

File Structure#

Authentication#

Troubleshooting#

Authentication Issues#

Build Failures#

Preview Errors#

With the CLI, you can:

📦 Installing the CLI

Commands

Interactive TUI Mode

Configuration

Environment Variables

Debug Mode

File Structure

Authentication

Troubleshooting

Authentication Issues

Build Failures

Preview Errors