Skip to main content Link Menu Expand (external link) Document Search Copy Copied


A command-line interface for interacting with Matatika services.



  • Python >=3.7
  • pip

The Matatika CLI/SDK is available through PyPi here and can be installed using pip:

pip install matatika

You can check if the CLI/SDK installed successfully by running the following command:

matatika --version


For all commands, the CLI requires an authentication token and endpoint URL to make successful HTTP requests to the Matatika API. Sometimes, a workspace ID is also required if the operation is specific to a workspace (i.e. listing all datasets in or publishing datasets to a workspace). The CLI can resolve these variables from one of the following sources, respecting the order of precedence as listed:

  1. Command option
  2. System environment
  3. Default context

Each variable is resolve separately, meaning that it is possible to - for example - specify a authentication token as an environment variable, a endpoint URL as a command option and a workspace ID in the default context. When specifying a variable in more than one source, the CLI will check each by the order of precedence define above and resolve the first variable it finds. For debugging purposes, including the -t / --trace flag on the base matatika command will print the value and source of each resolved variable before processing the statement.

Command option

-a / --auth-token and -e / --endpoint-url options can be specified on the base matatika command. -w / --workspace-id can be specified on certain commands that involve interacting with a workspace (e.g. the list datasets command). See command-specific documentation for more information.

Additionally, including --help after any CLI command will provide detailed information on its usage.

System environment

# set an authentication token

# set an endpoint URL

# set a workspace ID

Default context

See the documentation for creating a context and using a context.

Table of contents