camunda.json

A camunda.json file in the root of a folder marks the folder as a Camunda project, the unit you build, test, and deploy together. Desktop Modeler and c8ctl recognize the file.

File location and format

The file is named camunda.json, lives in the root of your project folder, and contains a single JSON object. There is one project per folder, and projects don't nest. In a monorepo, use sibling folders with one camunda.json each.

Fields

Field	Type	Description
hub	object	Optional. Camunda Hub connection settings.
hub.projectId	string	Optional. ID of the linked project in Camunda Hub.

All fields are optional. An empty camunda.json ({}) is valid and simply marks the folder as a project.

hub.projectId

Links the local project to a project in Camunda Hub.

A project does not need a Hub link. You can create a folder with camunda.json, build, and deploy locally with c8 deploy, and connect it to Hub later.

Example

{
  "hub": {
    "projectId": "<hub-project-id>"
  }
}

Related resources

• Development workflows: deploy, run, and watch projects with c8ctl.
• Projects: the Camunda project concept across Hub and Desktop Modeler.