Skip to main content

CLI

You can use the dcupl CLI to create new projects based on different boilerplates and perform various tasks around them like data modelling and project configuration.

info

Make sure you have an up to date version of Node and NPM.

Installation

npm i -g @dcupl/cli

Methods

init

Create a new dcupl workspace on your local machine.

dcupl init
# you can choose on of our tutorials or a blank starter project

serve

Serves your local dcupl webserver. The default port is 8083.

dcupl serve

dcupl serve --port 3000

files:push

Uploads your local dcupl workspace folder to your connected Console project. You can access it as the draft version or the version name you specified. Make sure you set your projectKey and apiKey correctly.

dcupl files:push
# --name: set a name for your new uploaded version

files:pull

Downloads the current Console project workspace to local machine. Make sure you set your projectKey and apiKey correctly.

dcupl files:pull
# --name: to specify which version to pull

files:copy

Copies your already uploaded workspace from one version to the other.

dcupl files:copy --from draft --to backup_xyz

files:list

Lists all your uploaded workspace versions.

dcupl files:list

generate

Generates different types of files and data including:

typecommanddescription
Modeldcupl generate modelGenerates a Model Definition and adds it to your loader configuration
Transformerdcupl generate transformerGenerates a Transformer Function and adds it to your loader configuration
Operatordcupl generate operatorGenerates an Operator Function and adds it to your loader configuration
Typescript typesdcupl generate typescriptGenerates Typescript types from all of your Models Defintions
JSON Schemadcupl generate json-schemaGenerates a JSON Schema file from all of your Models Defintions
Initial Test Setupdcupl generate test-setupCreates your initial Test Setup
Custom Test Filedcupl generate testGenerates a Test file you can use to write custom test cases
Test Configdcupl generate test-configGenerates a Test configuration
dcupl generate
# dcupl generate model
# dcupl generate transformer
# ...