README

Theme Kit

Shopify Theme Manipulation CLI


Theme Kit is a cross-platform command line tool that you can use to build Shopify themes.

Features

With Theme Kit, you can use your own development tools to interact with the Shopify platform in the following ways:

  • Use workflow tools like Git to work with a team of theme developers.
  • Upload themes to multiple environments.
  • Watch for local changes and upload them automatically to Shopify.
  • Work on Linux, macOS, and Windows.

Install Theme Kit

You can install Theme Kit using the command line on the following operating systems:

Node package

If you want to integrate Theme Kit into your build process, then you can run the following npm command to install the Node wrapper around Theme Kit:

$ npm install themekit

Reference guides

Troubleshooting

Refer to Troubleshooting Theme Kit to learn how to identify and resolve common issues in Theme Kit.

Contributing to Theme Kit

Theme Kit is open source and you can help contribute to the GitHub repository.

Where to get help

  • Open a GitHub issue - To report bugs or request new features, open an issue in the Theme Kit GitHub repository.
  • Shopify Community Forums - Visit our forums to connect with the community and learn more about Theme Kit development.

Directories

Path Synopsis
cmd
src
cmdutil/_mocks
Code generated by mockery v1.0.0.
Code generated by mockery v1.0.0.
env
release/_mocks
Code generated by mockery v1.0.0.
Code generated by mockery v1.0.0.
static
Package static allows for the bundling of static assets into a binary.
Package static allows for the bundling of static assets into a binary.