https://github.com/chrisdothtml/shopify-themekit

node wrapper for Shopify ThemeKit
https://github.com/chrisdothtml/shopify-themekit

node-wrapper nodejs shopify themekit

Last synced: about 1 year ago
JSON representation

node wrapper for Shopify ThemeKit

• Host: GitHub
• URL: https://github.com/chrisdothtml/shopify-themekit
• Owner: chrisdothtml
• License: mit
• Created: 2017-10-16T04:00:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-12-03T17:14:14.000Z (over 7 years ago)
• Last Synced: 2025-03-27T05:01:42.179Z (about 1 year ago)
• Topics: node-wrapper, nodejs, shopify, themekit
• Language: JavaScript
• Homepage: https://npm.im/shopify-themekit
• Size: 44.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# shopify-themekit

[![StandardJS](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![travis-ci build status](https://api.travis-ci.org/chrisdothtml/shopify-themekit.svg?branch=master)](https://travis-ci.org/chrisdothtml/shopify-themekit/branches)

[![appveyor build status](https://ci.appveyor.com/api/projects/status/ir2eo2tqefcoawvj/branch/master?svg=true)](https://ci.appveyor.com/project/chrisdothtml/shopify-themekit)

> node wrapper for [Shopify ThemeKit](http://shopify.github.io/themekit)

This is based on [node-themekit](https://github.com/Shopify/node-themekit). I didn't agree with a lot of the ways that package was handling it, so I made my own.

## Install

```bash

yarn add shopify-themekit

# or npm

npm install --save shopify-themekit

```

## Use

See [ThemeKit Docs](https://shopify.github.io/themekit/commands) for full list of commands and options

### API

```javascript

const themekit = require('shopify-themekit')

const options = {

  files: ['assets/file.js', 'assets/file.css'],

  ignore: false,

  store: '...'

}

// equivalent to:

// theme upload assets/file.js assets/file.css --no-ignore --store=...

themekit('upload', options)

  .then(...)

  .catch(...)

```

### CLI

```bash

# arguments passed directly to themekit

theme upload --allenvs

```

## License

[MIT](LICENSE)