Overview​

SHOPLINE CLI is a command-line interface tool that helps you build SHOPLINE themes.

This documentation explains how to use Shopline CLI for theme development.

Feature​

SHOPLINE CLI accelerates your theme development process with the following features:

• Safely preview, test, and share changes to themes using development themes
• Automatically refresh a page on file change, when previewing a theme.
• Initialize a new theme using Seed as a starting point.
• Push and publish themes from the command line.

Development themes​

A development theme can be used to perform the following tasks:

• View changes in real time to a theme that you're developing locally
• Customize and interact with the theme using the SHOPLINE admin theme editor
• Share a password-protected preview of the theme with other developers

Development themes are temporary, hidden themes that are connected to a SHOPLINE store that you're using for development.

• When you connect your theme to a store as a development theme, you can use that store's data for local testing.
• You can create a development theme using the shopline theme serve command.
• You can use development themes on a SHOPLINE store or a development store.
• Development themes don't count toward your theme limit, and are deleted from the store after seven days of inactivity.
• Your development theme is deleted when you run shopline logout. If you want a preview link for the theme that can be accessed after you log out, then you should push your development theme to an unpublished theme on your store.

Installation​

To learn how to install Shopline CLI on Windows, macOS, or Linux, refer to Install Shopline CLI.

Getting started​

Review the getting started with Shopline CLI guide to learn about topics including:

• Requirements for using Shopline CLI
• Connecting to a store
• Creating a new theme
• Previewing a theme

Directory structure​

You can run certain theme commands, such as shopline theme serve, only if the directory you're using matches the default SHOPLINE theme directory structure.

This structure represents a buildless theme, or a theme that has already gone through any necessary file transformations. If you use build tools to generate theme files, then you might need to run commands from the directory where the generated files are stored.

The default SHOPLINE theme directory structure is as follows:

└── project
    ├── assets
    ├── config
    ├── layout
    ├── locales
    ├── sections
    ├── snippets
    └── templates

Command references​

SHOPLINE CLI offers basic commands for authenticating and communicating with SHOPLINE, and specific commands for theme development.

• SHOPLINE CLI core command reference
• SHOPLINE CLI theme command reference

Upgrade or uninstall Shopline CLI​

To learn how to upgrade Shopline CLI, migrate from a legacy version, and uninstall SHOPLINE CLI, refer to Upgrade or uninstall SHOPLINE CLI.