Holistics CLI Commands

Holistics Command-line Tool#

Holistics CLI is an interface to Holistics Data Preparation module (like data transport, data transform, import). This also allows you to perform tasks such as uploading CSV data back into Holistics using the command line, which can be helpful if you're working on datasets in Python for re-importing, for example.

Setting Up#

Holistics CLI works with Ruby 2.0 onwards, if you don't have it installed on Linux/Mac OSX, we suggest you install it with RVM:

$ curl -sSL https://get.rvm.io | bash -s stable --ruby

After you have Ruby installed on your computer, then run:

$ gem install holistics


For general help or a list of command, run:

$ holistics help

Here is a list of some Holistics CLI commands you can run: Holistics CLI commands

Authentication (done once)#

Next, perform authentication. You can get the token in Holistics (go to Settings, under API Key section). Specifiically, first grant user permissions to access API in User Management, then visit your user settings and generate a user token.

$ holistics login <token>
Authenticating token...
Authentication successful. Info:
- ID: 1

Pushing CSV data back into Holistics via CLI (Example)#

Once you have completed the steps to install your Holistics gem, you can perform Holistics operations without having to open the platform. For example, you can re-import CSV data that you have worked on into Holistics, using the following command:

holistics import csv -d, --dest-ds-id=DEST_DS_ID -f, --filepath=FILEPATH -t, --dest-table-name=DEST_TABLE_NAME ## Import a local CSV file to destination server

More details on importing via CLI can be found using help: Holistics CLI import