Theme asset interaction library and management tools written in Node.js
Clone or download

npm version


Node wrapper for Theme Kit.

Table Of Contents


$ npm install @shopify/themekit


const themeKit = require('@shopify/themekit');

await themeKit.command('version');
//=> ThemeKit 0.8.1 darwin/amd64


Run commands

This wrapper exposes a single function in its API which allows it to run any command available in the original Theme Kit CLI. Here are a collection of examples to run Theme Kit commands.

For a complete list of commands and args:

Example 1

Remove specific files from development environment.

const themeKit = require('@shopify/themekit');

await themeKit.command('remove', {
  env: 'development',
  files: ['snippets/pagination.liquid', 'snippets/date.liquid']

Example 3

Deploy all files to staging environment.

const themeKit = require('@shopify/themekit');

themeKit.command('deploy', {
  env: 'staging'

Example 4

Deploy theme to production via NPM scripts.

Warning: This example will overwrite the theme based on your config.yml.

"dependencies": {
  "@shopify/themekit": "1.0.0"
"scripts": {
  "deploy": "shopify-themekit replace --env production"


command(command[, flags][, options)

Executes command with arguments using the Theme Kit binary.

  • command <String>

    Theme Kit command to run.

  • flags <Object>

    Flags to pass into the command.

    All flags specified in the Theme Kit documentation are available, but in camelCase rather than in --flag-form.

      noIgnore: true, // --no-ignore
      env: 'development' // --env=development

    Additional flags:

    • files: Specify an array of target files to upload.
    • ignoredFiles: Like ignoredFile, but takes in an array of files to ignore.
  • options <Object>

      cwd: <String>,      // Hard-code a working directory to run the binary from
      logLevel: <String> // Set level additional output info | 'silent', 'error', 'all', 'silly'

For a complete list of commands and flags, see the Theme Kit documentation.


$ shopify-themekit <args>

This CLI component of this package is intended to be used with NPM scripts. It functions exactly the same as the original Theme Kit binary. If you plan on using the command line interface heavily, please refer to the original Theme Kit repository.


MIT, see for details.