Skip to main content

Install the CLI

info

This is a preview of the new Shaped docs. Found an issue or have feedback? Let us know!

To get started using the CLI to create a model, first install the Shaped CLI from PyPi:

pip install shaped
info

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, use a Python virtual environment such as Conda, especially if you are using the system default Python installation.

Alternatively, you can use pipx to install Shaped: pipx install shaped

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 which you can find on the Shaped Dashboard