# Command: create

Command kl create creates a new Kumologica project.

# Usage

Usage: kl create [options]

# Options

  • -p, --path - path where project will be located, required. THe directory must not exists otherwise creation will fail. Additionally the path must be valid and cli must be able to create such a directory.
  • -t, --template - create a new project based on an available template.
  • -a, --api - the path or url to the openapi/swagger api definition. This will create project with the scaffolding for all apis defined in provided specification.

# Available templates

To see a list of available templates run: kl list-templates or visit the official repo (opens new window)

# Example: Create kumologica project

Command creates kumologica project.

$ cd /Users/john/Projects
$ kl create /Users/john/Projects/accounts-service

Command will create directory accounts-service within /Users/john/Projects/ After completion of the command, the content of account-service directory will contain following files:

/Users/john/Projects/accounts-service
 - accounts-service-flow.json
 - package.json

# Example: Create a kumologica project based on an existing template

$ kl create -p ./projects/hello-world -t aws-api-helloworld

# Example: Create kumologica project for swagger petstore api specification

The command below will create kumologica project named openapi in current working directory for api specification of example swagger petstore.

$ kl create --api https://raw.githubusercontent.com/swagger-api/swagger-petstore/refs/heads/master/src/main/resources/openapi.yaml -p .

The output of this command looks like below:

Successfully parsed API: Swagger Petstore - OpenAPI 3.0
Version: 1.0.20-SNAPSHOT
  post: /pet
  put: /pet
  get: /pet/findByStatus
  get: /pet/findByTags
  get: /pet/{petId}
  post: /pet/{petId}
  delete: /pet/{petId}
  post: /pet/{petId}/uploadImage
  get: /store/inventory
  post: /store/order
  get: /store/order/{orderId}
  delete: /store/order/{orderId}
  post: /user
  post: /user/createWithList
  get: /user/login
  get: /user/logout
  get: /user/{username}
  put: /user/{username}
  delete: /user/{username}
 
Project created successfully.
To open project in kumologica designer run the following command:
kl open openapi

← Doc Html →