Skip to content

Command line interface

The DataCap CLI provides a terminal-based, interactive shell for running queries. The CLI is a self-executing JAR file, which means it acts like a normal UNIX executable.


The CLI requires a Java virtual machine available on the path. It can be used with Java version 8 and higher.

The CLI uses the DataCap client REST API over HTTP/HTTPS to communicate with the system.

The CLI version should be identical to the version of system, or newer.


Download datacap-client-cli-1.6.0.jar, rename it to datacap, make it executable with chmod +x.

Running the CLI


connect -h -p 9096 -u username -P password

If successful, you will get a prompt to execute commands. Use the help command to see a list of supported commands.

Command Description
source info Get data source details
source list Get a list of remote server data sources
source use <SourceID> Set the data source flag for subsequent operations on the data source
source execute "<QuerySQL>" Execute remote SQL

Last update: November 20, 2023
Created: November 20, 2023