{"id":15674045,"url":"https://github.com/nikku/run-camunda","last_synced_at":"2025-06-12T11:05:19.988Z","repository":{"id":52898590,"uuid":"124523783","full_name":"nikku/run-camunda","owner":"nikku","description":"Download, spin up and shutdown Camunda painlessly from Node.","archived":false,"fork":false,"pushed_at":"2024-10-26T19:53:20.000Z","size":526,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-07T05:16:44.376Z","etag":null,"topics":["camunda","cli","nodejs","runner"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/run-camunda","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nikku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support.js","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["nikku"]}},"created_at":"2018-03-09T10:09:52.000Z","updated_at":"2024-10-26T19:53:24.000Z","dependencies_parsed_at":"2025-05-06T22:13:32.582Z","dependency_job_id":"366c7fcd-1545-4932-b1a5-4b503d7600a5","html_url":"https://github.com/nikku/run-camunda","commit_stats":{"total_commits":110,"total_committers":2,"mean_commits":55.0,"dds":"0.018181818181818188","last_synced_commit":"d74c99148606c8a4181ef08979865df180f4b9da"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/nikku/run-camunda","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Frun-camunda","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Frun-camunda/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Frun-camunda/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Frun-camunda/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikku","download_url":"https://codeload.github.com/nikku/run-camunda/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Frun-camunda/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259453488,"owners_count":22860085,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["camunda","cli","nodejs","runner"],"created_at":"2024-10-03T15:43:28.959Z","updated_at":"2025-06-12T11:05:19.967Z","avatar_url":"https://github.com/nikku.png","language":"JavaScript","funding_links":["https://github.com/sponsors/nikku"],"categories":[],"sub_categories":[],"readme":"# run-camunda\n\n[![CI](https://github.com/nikku/run-camunda/workflows/CI/badge.svg)](https://github.com/nikku/run-camunda/actions?query=workflow%3ACI)\n\n[![Camunda Compatibility](https://img.shields.io/badge/Camunda-7.13+-blue.svg)](#choose-camunda-version)\n\nDownload, spin up and shutdown the [Camunda Platform](https://camunda.com/products/camunda-platform/) painlessly from Node.\n\n\n## Usage\n\nInstall `run-camunda` globally or as a local dev dependency:\n\n```sh\nnpm install -g run-camunda\n```\n\nUse the provided `camunda` command to start and stop [Camunda](https://camunda.org/):\n\n```sh\n$ camunda start\nDownloading Camunda v7.22...\nStarting Camunda.....\nCamunda started.\n\n$ camunda stop\nStopping Camunda...\nCleaning up...\nCamunda stopped.\n```\n\n\n## Run Directly\n\nYou may run the utility directly without prior installation via `npx`:\n\n```sh\n$ npx run-camunda start\nDownloading Camunda v7.22...\nStarting Camunda.....\nCamunda started.\n```\n\n\n## Use via API\n\n```javascript\nimport {\n  startCamunda,\n  stopCamunda,\n  isCamundaRunning\n} from 'run-camunda';\n\nawait startCamunda();\nawait isCamundaRunning();\nawait stopCamunda();\n```\n\n\n## Choose Camunda Version\n\nYou may define the `CAMUNDA_VERSION` environment variable to decide which version to download:\n\n```sh\nset CAMUNDA_VERSION=7.13\ncamunda start\n```\n\n\n## Access Camunda\n\nCamunda is up and running on [`http://localhost:8080`](http://localhost:8080) once `camunda start` completes.\n\n### REST API\n\nAccess 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).\n\nRefer 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/).\n\n\n### Webapps\n\nThe running Camunda instance includes all stock apps:\n\n| App | Purpose |\n| :--- | :--- |\n| [Admin](http://localhost:8080/camunda/app/admin/) | administrate engines, users and rights |\n| [Cockpit](http://localhost:8080/camunda/app/cockpit/) | introspect the engine |\n| [Tasklist](http://localhost:8080/camunda/app/tasklist/) | list and execute tasks |\n| [Welcome](http://localhost:8080/camunda/app/welcome/) | check your user profile |\n\nThe default login for these apps is `demo:demo`.\n\n\n## Test Life-Cycle Integration\n\nUse `pretest` and `posttest` hooks in your project's `package.json` to integrate `run-camunda` into the test life-cycle:\n\n```json\n{\n  \"scripts\": {\n    \"pretest\": \"camunda start\",\n    \"test\": \"echo 'running test'\",\n    \"posttest\": \"camunda stop\"\n  }\n}\n```\n\n\n## Related\n\n### Resources\n\n* [Camunda documentation](https://docs.camunda.org/manual/latest/) / [external tasks](https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/)\n\n### Projects\n\n* [camunda-worker-node](https://github.com/nikku/camunda-worker-node)\n* [camunda-external-task-client-js](https://github.com/camunda/camunda-external-task-client-js)\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Frun-camunda","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikku%2Frun-camunda","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Frun-camunda/lists"}