Skip to main content

​
When to use

  • Before deploying to catch issues early
  • After modifying workflow JSON files
  • When the user asks to lint, validate, or check a use case
  • As part of a CI pipeline

​
Prerequisites

  • codika-helper CLI installed (no authentication needed)

​
Commands

# Validate entire use case folder
codika-helper verify use-case <path> [options]

# Validate single workflow file
codika-helper verify workflow <path> [options]

​
Options

OptionDescription
--jsonMachine-readable output
--fixAuto-fix fixable violations in place
--dry-runShow what --fix would change without modifying
--strictTreat should severity as must
--rules <ids>Run only these rules (comma-separated)
--exclude-rules <ids>Skip these rules (comma-separated)

​
Key validation rules

RuleSeverityWhat it checks
UC-CONFIG-EXPORTSmustconfig.ts exports WORKFLOW_FILES and getConfiguration
CK-INITmustParent workflows have Codika Init node
CK-SUBMITmustSuccess paths end with Submit Result
CK-ERRORmustError paths end with Report Error
WF-SETTINGSmustRequired workflow settings present
CK-PLACEHOLDERSmustPlaceholder syntax is valid
CK-CREDENTIALSmustCredentials use Codika patterns
CK-SUBWORKFLOW-PARAMSshouldSub-workflows have min 1 input param
WF-SANITIZATIONmustNo transient n8n IDs (fixable)
# 1. See all issues
codika-helper verify use-case <path>

# 2. Auto-fix fixable violations
codika-helper verify use-case <path> --fix

# 3. Manually fix remaining must violations

# 4. Verify clean
codika-helper verify use-case <path>

# 5. Deploy
codika-helper deploy use-case <path>

​
Examples

# Basic validation
codika-helper verify use-case ./my-use-case

# Auto-fix + validate
codika-helper verify use-case ./my-use-case --fix

# Strict mode
codika-helper verify use-case ./my-use-case --strict

# Single workflow
codika-helper verify workflow ./my-use-case/workflows/main.json

# JSON for CI
codika-helper verify use-case ./my-use-case --json

​
Exit codes

CodeMeaning
0All validations passed
1Validation failures found