Skip to content

from-api

Help command

> csm-data legacy generate-orchestrator from-api --help

 Usage: csm-data legacy generate-orchestrator from-api [OPTIONS] OUTPUT         

 Connect to the cosmotech API to download a run template and generate an        
 orchestrator file at OUTPUT                                                    

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *  OUTPUT    FILE  [required]                                                │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ OPTIONS ────────────────────────────────────────────────────────────────────╮
│ *  --organization-id           o-##########  The id of an organization in    │
│                                              the cosmotech api               │
│                                              ENV: CSM_ORGANIZATION_ID        │
│                                              [required]                      │
│ *  --workspace-id              w-##########  The id of a solution in the     │
│                                              cosmotech api                   │
│                                              ENV: CSM_WORKSPACE_ID           │
│                                              [required]                      │
│ *  --run-template-id           NAME          The name of the run template in │
│                                              the cosmotech api               │
│                                              ENV: CSM_RUN_TEMPLATE_ID        │
│                                              [required]                      │
│    --describe/--no-describe                  Show a description of the       │
│                                              generated template after        │
│                                              generation                      │
│                                              DEFAULT: no-describe            │
│    --web-help                                Open the web documentation      │
│    --help                                    Show this message and exit.     │
╰──────────────────────────────────────────────────────────────────────────────╯