Skip to main content

​
When to use

  • Download a deployed use case from the platform
  • Restore a previously deployed use case to local files
  • Inspect what documents are stored for a project
  • Pull the latest deployed version locally

​
Prerequisites

  • codika-helper CLI installed and authenticated
  • Project ID of the deployed use case

​
Command

codika-helper get use-case <projectId> [outputPath] [options]

​
Arguments

ArgumentRequiredDescription
<projectId>YesProject ID of the deployed use case
[outputPath]NoOutput directory (defaults to ./<projectId>)

​
Options

OptionDescription
--version <X.Y>Fetch specific version (latest if omitted)
--listList documents without downloading
--api-url <url>Override API URL
--api-key <key>Override API key
--jsonJSON output

​
Examples

# Download latest version
codika-helper get use-case abc123

# Download to specific directory
codika-helper get use-case abc123 ./my-local-copy

# Download specific version
codika-helper get use-case abc123 --version 1.2

# List files without downloading
codika-helper get use-case abc123 --list

​
Output

​
Download mode

✓ Downloaded use case
  Project:   abc123
  Version:   1.3
  Files:     7
    config.ts
    version.json
    workflows/main-workflow.json
    workflows/helper.json

​
List mode

Documents for abc123 (version 1.3):
  config.ts                    (2.3 KB, text/typescript)
  version.json                 (32 B, application/json)
  workflows/main-workflow.json (15.2 KB, application/json)
  workflows/helper.json        (8.1 KB, application/json)

Total: 4 documents

​
Exit codes

CodeMeaning
0Success
1API error or project not found