Skip to main content

Install the SDK

There are two modes to install the SDK: the standard and the developer mode. Choose the standard mode lets you use methods already available in the package and the developer mode if you plan to modify it.

Install in Standard Mode​

Install in this mode to use the methods already available in the package.

Run the following command:

pip install deepset-cloud-sdk

You can now use the CLI commands and Python methods included in the SDK.

Install in Developer Mode​

Use this installation mode if you want to modify the package:

  1. Clone the GitHub repository. For help, see GitHub docs.
  2. Run the following command: 
    pip install hatch==1.7.0
    hatch build

Update the SDK​

Update the SDK to the newest version:

pip install --upgrade deepset-cloud-sdk

Check the SDK Version​

Run the following command:

deepset-cloud --version

Get Help​

Run:

deepset-cloud --help