https://github.com/nikku/run-camunda
Download, spin up and shutdown Camunda painlessly from Node.
https://github.com/nikku/run-camunda
camunda cli nodejs runner
Last synced: about 1 year ago
JSON representation
Download, spin up and shutdown Camunda painlessly from Node.
- Host: GitHub
- URL: https://github.com/nikku/run-camunda
- Owner: nikku
- License: mit
- Created: 2018-03-09T10:09:52.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T19:53:20.000Z (over 1 year ago)
- Last Synced: 2025-06-07T05:16:44.376Z (about 1 year ago)
- Topics: camunda, cli, nodejs, runner
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/run-camunda
- Size: 514 KB
- Stars: 14
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Support: support.js
Awesome Lists containing this project
README
# run-camunda
[](https://github.com/nikku/run-camunda/actions?query=workflow%3ACI)
[](#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