# zendesk-cli

> A command line interface for ZenDesk admin tasks.

Latest version **0.0.12** (published 2016-10-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install zendesk-cli
pnpm add zendesk-cli
yarn add zendesk-cli
bun add zendesk-cli
```

Provides the command `zd`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2016-10-25 |
| First published | 2016-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zena Hirsch |
| Maintainers | zhirsch |
| Keywords | zendesk, cli |

## Links

- npm: https://www.npmjs.com/package/zendesk-cli
- Repository: https://github.com/zenahirsch/zendesk-cli
- Homepage: https://github.com/zenahirsch/zendesk-cli#readme
- Issues: https://github.com/zenahirsch/zendesk-cli/issues
- npm.io page: https://npm.io/package/zendesk-cli

## Dependencies (6)

- [open](https://npm.io/package/open.md) 0.0.5
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.30.0
- [columnify](https://npm.io/package/columnify.md) ^1.5.4
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [node-zendesk](https://npm.io/package/node-zendesk.md) ^1.1.8

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.12 (latest) — 2016-10-25
- 0.0.11 — 2016-10-25
- 0.0.10 — 2016-10-17
- 0.0.9 — 2016-10-04
- 0.0.8 — 2016-04-25
- 0.0.7 — 2016-04-25
- 0.0.6 — 2016-02-29
- 0.0.5 — 2016-02-29
- 0.0.4 — 2016-02-29
- 0.0.3 — 2016-02-29
- 0.0.2 — 2016-02-28
- 0.0.1 — 2016-02-28

## README

# zendesk-cli

A command line interface for ZenDesk admin tasks.

## Table of Contents

* [Install](#install)
* [Usage](#usage)
* [Setup](#setup)
* [Commands](#commands)
* [License](#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](#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

### License

MIT

---
_Source: https://npm.io/package/zendesk-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
