Skip to main content

​
When to use

  • Start a new use case from scratch
  • Create the initial folder structure for an n8n workflow project
  • Bootstrap a new automation with correct Codika patterns

​
Prerequisites

  • codika-helper CLI installed
  • For project creation: authenticated via codika-helper login (optional — scaffolding works without auth)

​
Command

codika-helper init <path> [options]

​
Options

OptionDescriptionDefault
--name <name>Use case display nameInteractive prompt
--description <desc>Use case descriptionAuto-generated
--icon <icon>Lucide icon nameWorkflow
--no-projectSkip platform project creation—
--project-id <id>Use existing project ID—
--jsonJSON output—

​
Generated files

my-use-case/
  config.ts                    # 3 template workflows, full configuration
  version.json                 # Initialized to 1.0.0
  project.json                 # Project ID and org ID (if project created)
  workflows/
    main-workflow.json         # HTTP trigger, Codika Init, sub-workflow call
    scheduled-report.json      # Schedule trigger with manual webhook fallback
    text-processor.json        # Sub-workflow with Execute Workflow Trigger

​
Template demonstrates

FeatureWhere
HTTP trigger with input validationmain-workflow.json
Schedule trigger (Monday 9 AM)scheduled-report.json
Manual webhook fallbackscheduled-report.json
Sub-workflow patterntext-processor.json
SUBWKFL placeholdermain-workflow.json calls text-processor
Codika Init (HTTP mode)main-workflow.json
Codika Init (schedule mode)scheduled-report.json
Submit Result / Report ErrorAll parent workflows
Placeholder usageAll workflows

​
Examples

# Interactive (prompts for name)
codika-helper init ./my-automation

# Named with project creation
codika-helper init ./email-tool --name "Email Tool"

# Without project (offline scaffolding)
codika-helper init ./local-test --name "Local Test" --no-project

# With existing project
codika-helper init ./my-tool --name "My Tool" --project-id abc123

​
Next steps after init

# Validate the scaffold
codika-helper verify use-case ./my-automation

# If --no-project was used, create a project
codika-helper project create --name "My Automation" --path ./my-automation

# Customize config.ts and workflows, then deploy
codika-helper deploy use-case ./my-automation

​
Exit codes

CodeMeaning
0Success
1Runtime error
2Validation error (directory exists, invalid path)