Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shopify/themekit
Shopify theme development command line tool.
https://github.com/shopify/themekit
go shopify shopify-theme shopify-themes theme-kit themekit
Last synced: 29 days ago
JSON representation
Shopify theme development command line tool.
- Host: GitHub
- URL: https://github.com/shopify/themekit
- Owner: Shopify
- License: mit
- Created: 2014-10-17T15:39:49.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T12:33:44.000Z (7 months ago)
- Last Synced: 2024-09-25T22:21:30.891Z (about 1 month ago)
- Topics: go, shopify, shopify-theme, shopify-themes, theme-kit, themekit
- Language: Go
- Homepage: https://shopify.dev/tools/theme-kit
- Size: 22.9 MB
- Stars: 1,184
- Watchers: 460
- Forks: 374
- Open Issues: 100
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Shopify Theme Manipulation CLI
---
Theme Kit is a cross-platform command line tool that you can use to build Shopify themes.
If you're working on Online Store 2.0 themes, you should use [Shopify CLI](https://github.com/Shopify/cli), which replaces Theme Kit for most Shopify theme development tasks. You should use Theme Kit instead of Shopify CLI only if you're working on older 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:
- [Linux](https://shopify.dev/tools/theme-kit/getting-started#linux)
- [macOS](https://shopify.dev/tools/theme-kit/getting-started#macos)
- [Windows](https://shopify.dev/tools/theme-kit/getting-started#windows)
### 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](https://github.com/Shopify/node-themekit) around Theme Kit:
``` terminal
$ npm install @shopify/themekit
```
## Reference guides
- **[Theme Kit command reference](https://shopify.dev/tools/theme-kit/command-reference)** - Learn about the different commands that you can use in Theme Kit to execute key operations.
- **[Theme Kit configuration reference](https://shopify.dev/tools/theme-kit/configuration-reference)** - Familiarize yourself with the configuration variables available and the accepted values.
## Troubleshooting
Refer to [*Troubleshooting Theme Kit*](https://shopify.dev/tools/theme-kit/troubleshooting) 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](https://github.com/Shopify/themekit/blob/main/CONTRIBUTING.md).
## Where to get help
- **[Open a GitHub issue](https://github.com/Shopify/themekit/issues)** - To report bugs or request new features, open an issue in the Theme Kit GitHub repository.
- **[Shopify Community Forums](https://community.shopify.com/)** - Visit our forums to connect with the community and learn more about Theme Kit development.