zendesk-themer

CLI for zendesk hc theme deploy

⚠️ This package is made using a puppeteer. It's very easy to break.

Install

npm i -g zendesk-themer

Usage

themer up <path> [options]

$ 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]

$ 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

{
  "domain": "https://test.zendesk.com/",
  "email": "[e-mail]",
  "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