Skip to content

Installing the Command-line Interface (CLI)

The CLI is a convenient tool for efficiently accessing a subset of the API, such as creating new projects and datasets, uploading large files to project datasets, deleting datasets & DICOM resources, and user management.

Download and install the latest version : v0.27.6

Download appropriate zip file containing the binary package for your platform. Note that only 64-bit platforms are supported.

Windows | MacOS | Linux | Linux (arm64)

After downloading, unzip the package. To run the mdai binary from any directory, make sure that the binary is available on the PATH. The following are instructions for on setting the PATH

Automatic Updates

With v0.19.0+, CLI can be configured to automatically upgrade to the latest version.

Verifying the Installation

After installing, verify the installation by starting a new terminal session and running mdai. By executing mdai you should see help output similar to this:

$ mdai
Usage: mdai [options] [command]

MDAI CLI is a command line interface to the API.
  See below for commands.

  -h, --help      display help for command

  version         Get package version
  config          View or set configuration variables
  project         Project operations
  dataset         Dataset operations
  model           Model operations
  deid            De-ID operations
  help [command]  display help for command

If you get an error that mdai could not be found (command not found or linux exit code 127), your PATH environment variable was not set up properly within your environment. Please go back and ensure that your PATH variable within your environment contains the directory where mdai was installed.