# Command: open

Command kl open opens kumologica designer.

# Usage

Usage: kl open <project_directory>

# Parameters

  • project-directory - path to a valid kumologica project. (Optional)

Kumologica SDK version 3.5.0 and later is built on aws-sdk v3. The kl open command, when provided with the project-directory parameter, will check the version of aws-sdk used by the project. If aws-sdk v2 is detected, the user will be prompted to migrate to aws-sdk v3.

# aws-sdk v3 Migration Process

  • Version Check: The kl open command verifies the aws-sdk version in the project.json.
  • Prompt for Migration: If aws-sdk v2 is found, the user is prompted to migrate to aws-sdk v3.
  • Function Nodes check: If the project contains function nodes using aws-sdk v2, the user is informed that these functions require manual migration to aws-sdk v3. The command then asks the user to confirm whether to continue with the migration or abandon it.

For detailed migration instructions, refer to the AWS SDK v3 Migration Guide (opens new window).

# Example: Open kumologica designer

Command opens kumologica designer in current directory. If designer is opened for the first time then "Welcome" screen will be opened where user can create new project. Otherwise last opened project will be displayed.

$ kl open

# Example: Open kumologica designer with specific project

Command opens kumologica designer and project accounts-service. The accounts-service flow will be displayed.

$ kl open /Users/john/Projects/accounts-service

# Example: Open kumologica designer in current project directory

$ cd /Users/john/Projects/accounts-service
$ kl open .

# Example Open kumologica designer with migration to aws-sdk v3

Project can be automatically migrated to aws-sdk v3

$ cd /Users/john/Projects/accounts-service
$ kl open .

This project uses the deprecated aws-sdk v2. Migration to aws-sdk v3 is available.

✔ Do you wish to migrate the project to aws-sdk v3? (y/N) · true

running command: npm install

# Example Open kumologica designer with manual migration to aws-sdk v3

Project is migrated to aws-sdk v3 however Function nodes referencing aws-sdk v2 must be manually migrated.

$ cd /Users/john/Projects/accounts-service
$ kl open .

This project uses the deprecated aws-sdk v2. Migration to aws-sdk v3 is available.

✔ Do you wish to migrate the project to aws-sdk v3? (y/N) · true

WARNING
This project contains function nodes that use aws-sdk v2. These functions can not be automatically migrated to aws-sdk v3.
Manual migration is required. For details, see: https://github.com/aws/aws-sdk-js-v3/blob/main/UPGRADING.md

✔ Do you wish to continue with the project migration to aws-sdk v3? (y/N) · true
running command: npm install

← Test →