Skip to content

Commands

YouCan CLI offer many commands to build your themes

CommandDescription
auth loginAuthorize a YouCan Store
auth logoutLogout from a YouCan store
theme initstarts a dev server and watches over the current directory
theme listList of development themes
theme devStart a local server for developing your theme
theme deleteDelete an existing theme
theme packPackage a theme

Login

Authorize YouCan CLI with your YouCan Partner account, in case of multi-store, a list of development stores will be displayed and must choose one to continue.

bash
youcan auth login

Logout

Remove YouCan CLI’s authorization to access your account. This command will invalidate your current token.

bash
youcan auth logout

Theme Init

Clones and unpacks the default starter theme to your local machine's current working directory, you will be prompted to enter theme meta data such as theme name and theme author.

bash
youcan theme init

Flags

FlagAliasDescription
—default-dInsert default metadata

Theme List

It lists all of your development themes

bash
youcan theme list

Theme Dev

Set up a local server to work on your YouCan theme. It launches a Chromium browser with a preview of your theme and listens for changes in the theme code, then automatically uploads the changes and reloads the preview to display the most recent theme update.

bash
youcan theme dev

Flags

FlagAliasDescription
—preview-previewStarts the preview browser

Theme Delete

It lists all of your development themes and prompts you to select one to delete.

bash
youcan theme delete

Theme Pack

It Package a theme

bash
youcan theme pack