# run-camunda

> Download, spin up and shutdown the Camunda Platform painlessly from Node

Latest version **9.0.0** (published 2024-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install run-camunda
pnpm add run-camunda
yarn add run-camunda
bun add run-camunda
```

Provides the command `camunda`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 9.0.0 |
| Published | 2024-10-26 |
| First published | 2018-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Nico Rehwaldt |
| Maintainers | nikku |
| Keywords | camunda, camunda platform, camunda run, cli, run |

## Links

- npm: https://www.npmjs.com/package/run-camunda
- Repository: https://github.com/nikku/run-camunda
- Homepage: https://github.com/nikku/run-camunda#readme
- Issues: https://github.com/nikku/run-camunda/issues
- npm.io page: https://npm.io/package/run-camunda

## Dependencies (2)

- [tar](https://npm.io/package/tar.md) ^7.4.3
- [execa](https://npm.io/package/execa.md) ^9.4.1

## 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

- 9.0.0 (latest) — 2024-10-26
- 8.0.0 — 2023-05-25
- 7.0.0 — 2021-10-15
- 6.0.0 — 2021-04-14
- 5.0.0 — 2020-05-28
- 4.0.0 — 2020-02-07
- 3.2.1 — 2019-09-09
- 3.2.0 — 2019-09-09
- 3.1.0 — 2019-09-08
- 3.0.0 — 2019-08-27
- 2.3.0 — 2019-08-14
- 2.2.0 — 2019-08-14
- 2.1.1 — 2019-08-14
- 2.1.0 — 2018-12-17
- 2.0.0 — 2018-12-14
- … 9 more at https://npm.io/package/run-camunda/versions

## README

# run-camunda

[![CI](https://github.com/nikku/run-camunda/workflows/CI/badge.svg)](https://github.com/nikku/run-camunda/actions?query=workflow%3ACI)

[![Camunda Compatibility](https://img.shields.io/badge/Camunda-7.13+-blue.svg)](#choose-camunda-version)

Download, spin up and shutdown the [Camunda Platform](https://camunda.com/products/camunda-platform/) painlessly from Node.


## Usage

Install `run-camunda` globally or as a local dev dependency:

```sh
npm install -g run-camunda
```

Use the provided `camunda` command to start and stop [Camunda](https://camunda.org/):

```sh
$ camunda start
Downloading Camunda v7.22...
Starting Camunda.....
Camunda started.

$ camunda stop
Stopping Camunda...
Cleaning up...
Camunda stopped.
```


## Run Directly

You may run the utility directly without prior installation via `npx`:

```sh
$ npx run-camunda start
Downloading Camunda v7.22...
Starting Camunda.....
Camunda started.
```


## Use via API

```javascript
import {
  startCamunda,
  stopCamunda,
  isCamundaRunning
} from 'run-camunda';

await startCamunda();
await isCamundaRunning();
await stopCamunda();
```


## Choose Camunda Version

You may define the `CAMUNDA_VERSION` environment variable to decide which version to download:

```sh
set CAMUNDA_VERSION=7.13
camunda start
```


## Access Camunda

Camunda is up and running on [`http://localhost:8080`](http://localhost:8080) once `camunda start` completes.

### REST API

Access the Camunda instance via the [Camunda REST API](https://docs.camunda.org/manual/latest/reference/rest/overview/distro-use/), available at [`http://localhost:8080/engine-rest`](http://localhost:8080/engine-rest).

Refer to the [Camunda documentation](https://docs.camunda.org/manual/latest/reference/rest/) to learn how to deploy and run your processes. Checkout [camunda-worker-node](https://github.com/nikku/camunda-worker-node) for a simple way to contribute work via [external tasks](https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/).


### Webapps

The running Camunda instance includes all stock apps:

| App | Purpose |
| :--- | :--- |
| [Admin](http://localhost:8080/camunda/app/admin/) | administrate engines, users and rights |
| [Cockpit](http://localhost:8080/camunda/app/cockpit/) | introspect the engine |
| [Tasklist](http://localhost:8080/camunda/app/tasklist/) | list and execute tasks |
| [Welcome](http://localhost:8080/camunda/app/welcome/) | check your user profile |

The default login for these apps is `demo:demo`.


## Test Life-Cycle Integration

Use `pretest` and `posttest` hooks in your project's `package.json` to integrate `run-camunda` into the test life-cycle:

```json
{
  "scripts": {
    "pretest": "camunda start",
    "test": "echo 'running test'",
    "posttest": "camunda stop"
  }
}
```


## Related

### Resources

* [Camunda documentation](https://docs.camunda.org/manual/latest/) / [external tasks](https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/)

### Projects

* [camunda-worker-node](https://github.com/nikku/camunda-worker-node)
* [camunda-external-task-client-js](https://github.com/camunda/camunda-external-task-client-js)


## License

MIT

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