@shopify/themekit/README.md

Node version of ThemeKit

# @shopify/themekit

Node version of [Theme Kit](http://themekit.cat/).

## Table Of Contents

- [Installation](#installation)
- [Examples](#examples)
- [API](#api)
    + [`commands(options, callback)`](#themekitcommandsargs)
- [CLI](#cli)
- [License](http://github.com/Shopify/node-themekit/blob/master/LICENSE.md)

## Installation

```bash
$ npm install @shopify/themekit
```

## Examples

### Run commands

Here are a collection of examples to run Theme Kit commands.

For a complete list of commands and args: [http://themekit.cat/docs/](http://themekit.cat/docs/).

#### Example 1

Print Theme Kit version info.

```javascript
var command = require('@shopify/themekit').command;

command({
  args: ['version']
}, function(err) {
  if (err) {
    console.error(err);
    return;
  }

  console.log('Theme Kit command has completed.');
});
```

#### Example 2

Remove specific files from development environment.

```javascript
var command = require('@shopify/themekit').command;

command({
  args: ['remove', '-env', 'development', 'snippets/pagination.liquid', 'snippets/date.liquid']
}, function(err) {
  if (err) {
    console.error(err);
    return;
  }

  console.log('Theme Kit command has completed.');
});
```

#### Example 3

Deploy all files to staging environment.

```javascript
var command = require('@shopify/themekit').command;

command({
  args: ['deploy', '-env', 'staging']
}, function(err) {
  if (err) {
    console.error(err);
    return;
  }

  console.log('Theme Kit command has completed.');
});
```

#### Example 4

Deploy theme to production via NPM scripts.

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

```json
"dependencies": {
  "@shopify/themekit": "0.4.3"
},
"scripts": {
  "deploy": "shopify-themekit replace -env production"
}
```

## API

### `command(options, callback)`

Executes command with arguments using the Theme Kit binary.

- options `<Object>`

  ```javascript
  {
    args: <Array>, // arguments to execute | ['version']
    logLevel: <String> // Set level additional output info | 'silent', 'error', 'all', 'silly'
  }
  ```

- callback `<Function>`

  ```javascript
  function(error) {

  }
  ```

For a complete list of commands and args: [http://themekit.cat/docs/](http://themekit.cat/docs/).

## CLI

```bash
$ shopify-themekit <args>
```

This CLI component of this package is intended to be used with NPM scripts. If you plan on using the command line interface heavily, please refer to: http://themekit.cat/install/.

## License

MIT, see [LICENSE.md](http://github.com/Shopify/node-themekit/blob/master/LICENSE.md) for details.

<img src="https://cdn.shopify.com/shopify-marketing_assets/builds/19.0.0/shopify-full-color-black.svg" width="200" />