0.22

Command Line

Install the @accordproject/concerto-cli npm package to access the Concerto command line interface (CLI). After installation you can use the concerto command and its sub-commands as described below.

To install the Concerto CLI:

npm install -g @accordproject/concerto-cli

Usage

concerto <cmd> [args]

Commands:
  concerto validate  validate JSON against model files
  concerto compile   generate code for a target platform
  concerto get       save local copies of external model dependencies

Options:
      --version  Show version number                                   [boolean]
  -v, --verbose                                                 [default: false]
      --help     Show help                                             [boolean]

concerto validate

concerto validate lets you check whether a JSON sample is a valid instance of the given model.

concerto validate

validate JSON against model files

Options:
      --version     Show version number                                [boolean]
  -v, --verbose                                                 [default: false]
      --help        Show help                                          [boolean]
      --input       JSON to validate                                    [string]
      --model       array of concerto (cto) model files                  [array]
      --utcOffset   set UTC offset                                      [number]
      --offline     do not resolve external models    [boolean] [default: false]
      --functional  new validation API                [boolean] [default: false]
      --ergo        validation and emit for Ergo      [boolean] [default: false]

Example

For example, using the validate command to check the sample request.json file from a Late Delivery and Penalty clause:

concerto validate --input request.json --model model/clause.cto

returns:

{
  "$class": "org.accordproject.latedeliveryandpenalty.LateDeliveryAndPenaltyRequest",
  "forceMajeure": false,
  "agreedDelivery": "2017-12-17T04:24:00.000-04:00",
  "goodsValue": 200,
  "$timestamp": "2021-06-17T09:41:54.207-04:00"
}

concerto compile

Concerto compile takes an array of local CTO files, downloads any external dependencies (imports) and then converts all the model to the target format.

concerto compile

generate code for a target platform

Options:
      --version  Show version number                                   [boolean]
  -v, --verbose                                                 [default: false]
      --help     Show help                                             [boolean]
      --model    array of concerto (cto) model files          [array] [required]
      --offline  do not resolve external models       [boolean] [default: false]
      --target   target of the code generation  [string] [default: "JSONSchema"]
      --output   output directory path           [string] [default: "./output/"]

At the moment, the available target formats are as follows:

  • Go Lang: concerto compile --model modelfile.cto --target Go
  • Plant UML: concerto compile --model modelfile.cto --target PlantUML
  • Typescript: concerto compile --model modelfile.cto --target Typescript
  • Java: concerto compile --model modelfile.cto --target Java
  • JSONSchema: concerto compile --model modelfile.cto --target JSONSchema
  • XMLSchema: concerto compile --model modelfile.cto --target XMLSchema

Example

For example, using the compile command to export the clause.cto file from a Late Delivery and Penalty clause into Go Lang format:

cd ./model
concerto compile --model clause.cto --target Go

returns:

info: Compiled to Go in './output/'.

concerto get

Concerto get allows you to resolve and download external models from a set of local CTO files.

concerto get

save local copies of external model dependencies

Options:
      --version  Show version number                                   [boolean]
  -v, --verbose                                                 [default: false]
      --help     Show help                                             [boolean]
      --model    array of concerto (cto) model files          [array] [required]
      --output   output directory path                  [string] [default: "./"]

Example

For example, using the get command to get the external models in the clause.cto file from a Late Delivery and Penalty clause:

concerto get --model clause.cto

returns:

info: Loaded external models in './'.
← DecoratorsConcerto API →