Theme Kit command reference

This reference lists the Theme Kit commands for creating, configuring, updating, deploying, downloading, and removing themes.

Get help from the command line

If you want information about Theme Kit commands while you are working, then you can get help by running the following commands:

Get a list of all commands and flags

$ theme help

Get a list of all the flags for a command

$ theme [command] --help

Using environments

All Theme Kit commands can be run with a selected environment from the configuration. This allows multiple configurations to be held in the same config file.

To use environments, you must specify them by name with the --env flag or -e for short. The default environment is development. For example, if you want to deploy to your production environment, then you can run the following command:

$ theme deploy --env=production

To deploy to multiple environments, you can pass additional --env flags:

$ theme deploy --env=staging --env=production

Get

Sets up your theme on your local machine by creating a config file and downloading the theme you request.

The theme get --list command returns a list of themes and IDs that exist on the store specified:

$ theme get --list --password=[your-api-password] --store=[your-store.myshopify.com]

After you've retrieved the theme ID, you can run the following command. Make sure to also replace your-password with the API password that you generated and your-store with your store's domain name:

$ theme get --password=[your-api-password] --store=[your-store.myshopify.com] --themeid=[your-theme-id]

Running the theme get command outputs a config.yml file in the current directory with the following contents:

development:
  password: [your-api-password]
  theme_id: "[your-theme-id]"
  store: [your-store].myshopify.com

Required flags

Optional flag

New

Creates a new theme on the specified Shopify store, initializes your configuration using your API password and new theme ID, and generates and uploads default templates to make your theme valid.

$ theme new --password=[your-api-password] --store=[your-store.myshopify.com] --name="Dramatic Theme"

Required flags

Optional flag

Configure

Creates or updates configuration files.

$ theme configure --password=[your-api-password] --store=[your-store.myshopify.com] --themeid=[your-theme-id]

Running the theme configure command outputs a config.yml file in the current directory with the following contents:

development:
  password: [your-api-password]
  theme_id: "[your-theme-id]"
  store: [your-store].myshopify.com

Required flags

Optional flag

Open

Opens the preview page for your theme in your browser and prints out the URL for your reference.

$ theme open --env=production # opens http://your-store.myshopify.com?preview_theme_id=[your-theme-id]

Optional flags

Watch

Instructs Theme Kit to watch for any changes made to your local files, and automatically pushes updates to your theme in the connected Shopify store.

Both the changes and the status of the upload are logged to the terminal. To close the watch connection, type ctrl + c.

Optional flags

Using --notify with a URL

Supplying the --notify flag with a URL will send a payload. For example, if a change is made to the file assets/app.js, then the URL will receive a POST request with the following payload:

{
  "files": ["assets/app.js"]
}

Integration with other tools

To help integrate watch with tools such as LiveReload, you can provide the optional --notify flag with a file path that you want to have updated when the workers have gone idle.

For example, if you have LiveReload watching for updates made to a file at /tmp/theme.update, then you can use the following command:

$ theme watch --notify=/tmp/theme.updatetheme watch --notify=/tmp/theme.update

Deploy

Replaces your theme in the connected Shopify store with what's in your current project directory. For example, if you want to deploy only the 404.liquid and article.liquid templates, then you can use the following command:

$ theme deploy templates/404.liquid templates/article.liquid

How it works

• Any files that are in the connected Shopify store, but aren't on your local disk, will be removed from Shopify.
• Any files that are on both your local disk and in the connected Shopify store will be updated.
• Any files that are on only your local disk will be uploaded to the connected Shopify store.

If you use the deploy command without any file names, then the entire theme is replaced. If you provide some file names in the command, then only the specified files are replaced.

Theme Kit calculates a checksum for each file and only updates assets if you’ve made changes to them locally.

Optional flags

Download

Downloads files from your theme.

If you use the download command without any file names, then the entire theme is downloaded. If you provide some file names in the command, then only the specified files are downloaded.

For example, if you want to download only the 404.liquid and article.liquid templates, then you can use the following command:

$ theme download templates/404.liquid templates/article.liquid

Similar to the deploy command, Theme Kit will skip downloading any unchanged files.

Optional flag

Remove

Deletes theme files both locally and in the connected Shopify store.

Unlike the other file operation commands, the remove command requires file names. This prevents you from accidentally deleting your entire theme.

For example, if you want to delete the 404.liquid and article.liquid templates, then you can use the following command:

$ theme remove templates/404.liquid templates/article.liquid

Next steps

• Familiarize yourself with the configuration variables available and their accepted values in Theme Kit.
• Learn how to identify and resolve common issues in Theme Kit.