zendesk-themer/README.md

CLI for zendesk hc theme deploy

# zendesk-themer
CLI for zendesk hc theme deploy

[![npm](https://flat.badgen.net/npm/v/zendesk-themer)](https://www.npmjs.com/package/zendesk-themer)


<p align="center">
    <img src="demo.gif" alt="demo">
</p>

⚠️ This package is made using a [puppeteer](https://github.com/GoogleChrome/puppeteer). **It's very easy to break**.

## Install
```sh
npm i -g zendesk-themer
```

## Usage
### themer up \<path> [options]
```sh
$ themer up --help

  Description
    Upload a live theme.

  Usage
    $ themer up <path> [options]

  Options
    -p, --persist    No remove a old theme.
    -h, --help       Displays this message

  Examples
    $ themer up
    $ themer up themes/test-theme/ -p
    $ themer up themes/*/themer.json
```

### themer down \<path> [options]
```sh
$ themer down --help

  Description
    Download live theme.

  Usage
    $ themer down <path> [options]

  Options
    -h, --help    Displays this message

  Examples
    $ themer down
    $ themer down ./theme
    $ themer down */themer.json
```

## themer.json
```json
{
  "domain": "https://test.zendesk.com/",
  "email": "test@rsupport.com",
  "password": "test1234",
  "target": "./",
  "theme_path": "../common_theme/"
}
```

- `domain` - Required. Zendesk help center domain.
- `email` - Required. Email for zendesk login.
- `password` - Required. Password for zendesk login.
- `target` - Required. Theme path to upload.
- `theme_path` - Optional. If it exists, upload files in that directory along with the "settings/" directory of "target".

## License
MIT