Skip to main content

project create

Create a new project on the Codika platform.
codika-helper project create [options]

Options

OptionDescriptionRequired
--name <name>Project nameYes
--description <description>Project descriptionNo
--template-id <id>Template ID for project setupNo (platform default)
--organization-id <id>Organization IDFor admin keys only
--path <dir>Write project.json to this directoryNo
--api-url <url>Codika API URLNo
--api-key <key>Codika API keyNo
--jsonJSON outputNo

Behavior

  1. Calls the Codika platform API to create the project
  2. Creates a project in the specified (or inferred) organization
  3. If --path is provided, writes project.json containing projectId and organizationId

The —path flag

Using --path . is recommended when creating a project for an existing use case folder. It writes project.json which enables:
  • Org-aware profile selection during deployment
  • Automatic process instance ID resolution for trigger and get commands
cd my-use-case
codika-helper project create --name "My Automation" --path .
This creates ./project.json:
{
  "projectId": "abc123",
  "organizationId": "org_def456"
}

Examples

# Create a project and save project.json locally
codika-helper project create --name "Email Automation" --path ./email-automation

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

# With description
codika-helper project create \
  --name "CRM Reporter" \
  --description "Generates weekly CRM pipeline reports"

# For a specific organization (admin keys)
codika-helper project create \
  --name "Team Tool" \
  --organization-id org_abc123

# JSON output
codika-helper project create --name "My Project" --json

Output

✓ Project created
  Project ID: abc123
  Written:    ./email-automation/project.json

Exit codes

CodeMeaning
0Success
1API error
2CLI validation error (e.g., missing --name)