zendesk-cli

A command line interface for ZenDesk admin tasks.

Table of Contents

• Install
• Usage
• Setup
• Commands
• License

Install

$ npm install -g zendesk-cli

Usage

$ zd [command] [options]

Setup

Before running any commands, you'll need to set up the CLI with your ZenDesk credentials. This requires three pieces of information:

1. Your ZenDesk username
2. Your access token
3. The Remote URI for the API

Once you have this information, run the following command:

$ zd init <username> <token> <remoteUri>

Commands

init

$ zd init <username> <token> <remoteUri>

See Setup for more information.

macro

$ zd macro [options]

Use this command to create, update, list, or open macros. By default, this command creates a new macro, unless you've specified -u <macro_id> (update macro), -l (list macros), or -o [macro_id] (open macro in browser).

Options:

Option	Argument	Description
-h, --help		output usage information
-t, --title	<title>	Set title of macro
-f, --file	<path>	Path to comment text file
-w, --write		Open editor to write comment content
-T, --tags	<tags>	Append tags (space delineated)
-i, --inactive		Make macro inactive
-p, --private		Set comment mode to private
-l, --list		List all macros
-u, --update	<macro_id>	Update macro
-o, --open	[macro_id]	Open the macro in browser

add macro

$ zd add macro [options]

This command is an alias for zd macro [options]

Options:

Option	Argument	Description
-h, --help		output usage information
-t, --title	<title>	Set title of macro
-f, --file	<path>	Path to comment text file
-w, --write		Open editor to write comment content
-T, --tags	<tags>	Append tags (space delineated)
-i, --inactive		Make macro inactive
-p, --private		Set comment mode to private
-o, --open		Open the macro in browser after adding

update macro

$ zd update macro <macro_id> [options]

This command is an alias for zd macro -u <macro_id> [options]

Options:

Option	Argument	Description
-h, --help		output usage information
-t, --title	<title>	Set title of macro
-f, --file	<path>	Path to comment text file
-w, --write		Open editor to write comment content
-T, --tags	<tags>	Append tags (space delineated)
-i, --inactive		Make macro inactive
-p, --private		Set comment mode to private
-o, --open		Open the macro in browser after updating

list macros

$ zd list macros

This command is an alias for zd macro -l

Options: None

open macro

$ zd open macro <macro_id>

This command is an alias for zd macro -o <macro_id>

Options: None