get use-case
Download a deployed use case with all its metadata documents.Arguments
| Argument | Description |
|---|---|
<projectId> | Project ID of the deployed use case |
[outputPath] | Output directory (defaults to ./<projectId>) |
Options
| Option | Description | Default |
|---|---|---|
--version <X.Y> | Fetch specific version | Latest |
--list | List documents without downloading | — |
--api-url <url> | Override API URL | — |
--api-key <key> | Override API key | — |
--json | JSON output | — |
Behavior
Download mode (default):- Fetches metadata documents from the API
- Decodes file content
- Writes files to the output directory
--list):
- Fetches document listing only
- Displays file paths, sizes, and content types
- Does not download any files
Examples
Output
get execution
Fetch full n8n execution details for debugging.Arguments
| Argument | Description |
|---|---|
<executionId> | Codika execution ID (from trigger response) |
Options
| Option | Description | Default |
|---|---|---|
--process-instance-id <id> | Explicit process instance ID | Auto-resolved |
--path <path> | Path to use case folder with project.json | Current directory |
--deep | Recursively fetch sub-workflow executions | — |
--slim | Strip noise (pairedItem, workflowData) for readability | — |
-o, --output <path> | Save to file instead of stdout | stdout |
--api-url <url> | Override API URL | — |
--api-key <key> | Override API key | — |
--json | JSON output | — |
Process instance ID resolution
--process-instance-idflagdevProcessInstanceIdinproject.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.
Slim mode
Strips noisy fields for cleaner output:- Removes
pairedItemfrom all nodes - Removes
workflowDatafrom execution metadata
--deep for debugging: --deep --slim