# choreograph

> An OSS tool to orchestrate docker based workers. Comes with a web-UI and an API.

Latest version **1.0.5** (published 2016-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install choreograph
pnpm add choreograph
yarn add choreograph
bun add choreograph
```

Provides the command `choreo`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-08-21 |
| First published | 2016-08-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ashish |
| Maintainers | tocttou |
| Keywords | Docker, worker, choreograph |

## Links

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

## Dependencies (9)

- [byline](https://npm.io/package/byline.md) ^5.0.0
- [dotenv](https://npm.io/package/dotenv.md) ^2.0.0
- [vorpal](https://npm.io/package/vorpal.md) 1.11.4
- [blessed](https://npm.io/package/blessed.md) ^0.1.81
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.6.1
- [dockerode](https://npm.io/package/dockerode.md) ^2.3.0
- [superagent](https://npm.io/package/superagent.md) ^2.2.0
- [blessed-contrib](https://npm.io/package/blessed-contrib.md) ^3.5.5
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^1.4.8

## Alternatives

- [cron](https://npm.io/package/cron.md) — 4.9M weekly downloads
- [@vercel/queue](https://npm.io/package/@vercel/queue.md) — 731.6K weekly downloads
- [create-sonicjs](https://npm.io/package/create-sonicjs.md) — 1.6K weekly downloads
- [@exellix/jobs-api](https://npm.io/package/@exellix/jobs-api.md) — 941 weekly downloads
- [@forwardimpact/libskill](https://npm.io/package/@forwardimpact/libskill.md) — 575 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2016-08-21
- 1.0.4 — 2016-08-21
- 1.0.3 — 2016-08-21
- 1.0.2 — 2016-08-21
- 1.0.1 — 2016-08-14

## README

# choreograph-cli
An OSS tool to orchestrate docker based workers. Comes with a web-UI and an API.


## Setup Instructions

1. Install [docker](https://docs.docker.com/engine/installation/)
2. Install [nodejs, npm](https://github.com/creationix/nvm)
3. `npm i -g choreograph`
4. Run the command: `choreo` to enter choreograph-cli shell.

*For initial setup, run the command, `setup` after enter choreograph-cli shell.*

*This setup should be done on each node that is to be used.*

### Options:

  Commands:

    help [command...]  Provides help for a given command.
    exit               Exits application.
    verify             Verifies the config file.
    setup              Setup parent docker container
    run                Add a new job
    list               Lists all the running jobs and their services
    stop               Stop a job
    monitor            Displays a dashboard for the job
    
## Documentation:
 
Open `http://localhost:6003` to view the documentation for writing `.choreo.yml` file to configure services.

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