# ummon-cli

> The command line interface for ummon-server

Latest version **0.0.15** (published 2013-09-13) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

Provides the command `ummon`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.15 |
| Published | 2013-09-13 |
| First published | 2013-06-20 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Matt McManus |
| Maintainers | mattmcmanus, gsf |

## Links

- npm: https://www.npmjs.com/package/ummon-cli
- Repository: https://github.com/punkave/ummon-cli
- Issues: https://github.com/punkave/ummon-cli/issues
- npm.io page: https://npm.io/package/ummon-cli

## Dependencies (7)

- [rc](https://npm.io/package/rc.md) ~0.3.0
- [colors](https://npm.io/package/colors.md) ~0.6.0-1
- [moment](https://npm.io/package/moment.md) ~2.1.0
- [helmsman](https://npm.io/package/helmsman.md) ~0.2.2
- [commander](https://npm.io/package/commander.md) ~2.0.0
- [underscore](https://npm.io/package/underscore.md) ~1.4.4
- [ummon-client](https://npm.io/package/ummon-client.md) ~0.0.9

## Recent versions

- 0.0.15 (latest) — 2013-09-13
- 0.0.14 — 2013-09-05
- 0.0.13 — 2013-09-04
- 0.0.12 — 2013-08-30
- 0.0.11 — 2013-08-30
- 0.0.10 — 2013-08-29
- 0.0.9 — 2013-08-28
- 0.0.8 — 2013-08-28
- 0.0.7 — 2013-08-26
- 0.0.6 — 2013-08-22
- 0.0.5 — 2013-07-29
- 0.0.4 — 2013-07-26
- 0.0.3 — 2013-07-11
- 0.0.2 — 2013-07-11
- 0.0.1 — 2013-06-20

## README

# ummon-cli

[![NPM version](https://badge.fury.io/js/ummon-cli.png)](http://badge.fury.io/js/ummon-cli) [![Build Status](https://secure.travis-ci.org/punkave/ummon-cli.png?branch=master)](http://travis-ci.org/punkave/ummon-cli) [![Dependency Status](https://gemnasium.com/punkave/ummon-cli.png)](https://gemnasium.com/punkave/ummon-cli)

The command line interface to the [ummon server](https://github.com/punkave/ummon-server). Since `ummon-server` only communicates over an HTTP API, you can install this module on any computer and as long as you have the url and a user and pass you can interact with it.

## Installation

```
npm install -g ummon-cli
```

## Usage

```
$ ummon --help

Commands:

   create           Add a new task to Ummon
   delete           Delete a Task
   log              Show recent log output. Filter logs by using --collection, --task or --run (only one!)
   ps               Show current worker counts and their pids
   task             Show the configuration for a task or group of tasks

```

## Default options for every command

* `url`: The url where `ummon-server` is accepting connections
* `retries`: The number of times
* `timeout`: Time to wait
* `username`
* `password`

## The `.ummonrc` file

You can save all of the above settings in `~/.ummonrc` so you don't have to type them in every time.

`$ cat ~/.ummonrc`
```json
{
  "--url": "http://localhost:8888",
  "--username": "user",
  "--password": "password"
}
```

Warning! Obviously if you save your password, it will be saved in clear text. Use appropriate caution

## Examples

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