Skip to main content

​
When to use

  • User wants to create a new project for deploying use cases
  • Before deploying if no project exists for the use case folder
  • When project.json is missing and deployment requires a project ID

​
Prerequisites

  • codika-helper CLI installed and authenticated
  • Valid API key with appropriate scopes

​
Command

codika-helper project create --name "Project Name" [options]

​
Options

OptionRequiredDescription
--name <name>YesProject display name
--description <desc>NoProject description
--template-id <id>NoTemplate ID (uses platform default)
--organization-id <id>Admin keys onlySpecify target organization
--path <dir>RecommendedWrite project.json to this directory
--api-url <url>NoOverride API URL
--api-key <key>NoOverride API key
--jsonNoJSON output
Always use --path . when creating a project for a use case folder: 
cd my-use-case
codika-helper project create --name "My Automation" --path .
This writes project.json: 
{
  "projectId": "abc123",
  "organizationId": "org_def456"
}
Benefits of project.json:
  • Enables org-aware profile selection during deploy use-case
  • Auto-resolves processInstanceId for trigger and get execution
  • Stores devProcessInstanceId after first deploy

​
Examples

# Create and link to current directory
codika-helper project create --name "Email Automation" --path .

# Create with description
codika-helper project create \
  --name "CRM Reporter" \
  --description "Weekly pipeline reports to Slack" \
  --path ./crm-reporter

# Create without saving locally
codika-helper project create --name "Quick Test"

# For admin keys targeting a specific org
codika-helper project create \
  --name "Team Tool" \
  --organization-id org_abc123 \
  --path .

​
Exit codes

CodeMeaning
0Success
1API error (auth, network, server)
2CLI validation error (missing --name)