When to use
- Debug a workflow execution that failed or returned unexpected results
- Inspect node-level input/output for a specific execution
- Fetch sub-workflow execution details recursively
- Analyze execution timing and identify bottlenecks
Prerequisites
codikaCLI installed and authenticated- A deployed and triggered workflow
- An execution ID (from the
triggercommand response)
Typical debugging flow
Command
Arguments
| Argument | Description |
|---|---|
<executionId> | Codika execution ID (from trigger response) |
Options
| Option | Description | Default |
|---|---|---|
--process-instance-id <id> | Explicit process instance ID | Auto-resolved from project.json |
--project-file <path> | Path to custom project file (e.g., project-client-a.json) | project.json |
--path <path> | Path to use case folder with project.json | Current directory |
--deep | Recursively fetch sub-workflow executions | Off |
--slim | Strip noise (pairedItem, workflowData) for readability | Off |
-o, --output <path> | Save to file instead of stdout | stdout |
--api-url <url> | Override API URL | — |
--api-key <key> | Override API key | — |
--profile <name> | Use a specific profile instead of the active one | — |
--json | JSON output | — |
Recommended flags
For most debugging, use both flags together:--deepgives you the complete execution tree including sub-workflows--slimremoves noisy metadata for cleaner, more readable output
Process instance ID resolution
--process-instance-idflagdevProcessInstanceIdin--project-file(if provided)devProcessInstanceIdinproject.jsonat--pathdevProcessInstanceIdinproject.jsonin current directory
Deep mode
When--deep is used, the CLI recursively fetches sub-workflow executions and attaches them as _subExecutions on the parent node that triggered them. This gives you the complete execution tree.
How it works
- Fetches the main execution
- Identifies nodes that called sub-workflows (Execute Workflow nodes)
- Recursively fetches each sub-workflow execution
- Attaches results as
_subExecutionson the parent node
Slim mode
Strips noisy fields for cleaner output:- Removes
pairedItemfrom all nodes - Removes
workflowDatafrom execution metadata
--deep for debugging: --deep --slim
Examples
Output
Exit codes
| Code | Meaning |
|---|---|
0 | Success |
1 | API error or execution not found |