Getting Started

Install the package with the following command:

npm i @dscribe_data/dscribe-cli -g

If npm is not available as a command, install nodejs first via this link

Open a terminal and try to run the following:

dScribe

It should show something like this:

Usage: dScribe [options] [command]

CLI to work with the dScribe API.

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  apikeys         Methods to store and remove API keys.
  bulk            Methods to do bulk edits in your dScribe tenant.
  help [command]  display help for command

If the command is not recognized, run this command and try again:

sudo npm link

API Keys

The first thing we have to do is store an api key we want to use. Use this command

dScribe apikeys set --name test --key your_key

Check if this was succesfull with the following command:

dScribe apikeys list

Bulk update properties

To update properties in bulk we need the following command:

dScribe bulk update properties --property <property api handle> --to fg --apikey <name> --type <type>