Skip to main content

Install the CLI

The CLI is the best way to interact with the Shaped API. You can use it to configure datasets, upload new models, and test queries.

Prerequisites​

  • Python 3.11 or below
  • A Shaped account

Install with pip​

First install the Shaped CLI from PyPi:

pip install shaped
tip

Python Version: Shaped supports Python 3.8 to 3.11.

Take a look at the installation instructions if you need to install pip.

If you are having trouble installing due to package conflicts, check out our guide: Install errors

Initialize the client​

You can then initialize the shaped client with your API key. If you don't have an API key yet, check out this page to get one.

shaped init --api-key <YOUR_API_KEY>

Replace YOUR_API_KEY with your actual API key from the console: Open console