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.
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:
| type | command | description |
|---|---|---|
| Model | dcupl generate model | Generates a Model Definition and adds it to your loader configuration |
| Transformer | dcupl generate transformer | Generates a Transformer Function and adds it to your loader configuration |
| Operator | dcupl generate operator | Generates an Operator Function and adds it to your loader configuration |
| Typescript types | dcupl generate typescript | Generates Typescript types from all of your Models Defintions |
| JSON Schema | dcupl generate json-schema | Generates a JSON Schema file from all of your Models Defintions |
| Initial Test Setup | dcupl generate test-setup | Creates your initial Test Setup |
| Custom Test File | dcupl generate test | Generates a Test file you can use to write custom test cases |
| Test Config | dcupl generate test-config | Generates a Test configuration |
dcupl generate
# dcupl generate model
# dcupl generate transformer
# ...