What?

CLI tool to interact with Medable Cortex API

How to run it?

npm install -g medable-cli
mcli --help

• You can either have an .env file with following values in your homedir or the directory where you running the command from

  username=test
  password=test
  org=mdbl-org
  apiKey=keydfkjk

• Run mcli login to login

• It should generate a token and log you in and then you should be able to run rest of commands like get,run and scripts download

Usage:

mcli get c_public_user --where '{"c_email": "[email protected]"}'

You can limit number of results with -l or --limit flag

mcli get c_public_user -l 1

Running scripts

You can write your script in a file.

return org.objects.c_public_users;

and then run it with mcli run command.

  mcli run test.js

Transformation functions

You can also pass transformation functions to mcli get object. This can be any valid javascript function.

For instance, if you want to find user with c_number 5 then you could do something like this:

mcli get c_public_users --find "(item) => item.c_number === 5"

Similarly, you can pass a map function and transform the output according to your needs

mcli get c_public_user --map "(item) => item.c_name"

Exporting Data

You can export the results to either excel or csv file by passing in the --export excel --file users option. You don't need to pass extension with the file name. The tool will generate that based on the value in --export option.

If you don't pass in --file then it'll save the results in generic output.csv or output.xlsx file.

  
mcli get c_public_users --find "(item) => item.c_number === 5" --export csv --file user

Type mcli get [object] --help to see all the available options.