Upgrading the Cognite Toolkit

caution

This section applies to Cognite Toolkit version 0.3.0. If you are using an earlier version, refer to the 0.2.0 section.

Follow these steps to upgrade the Cognite Toolkit CLI and modules to the latest version.

Step 1: Upgrade the Cognite Toolkit CLI

To upgrade the Cognite Toolkit to the latest version, open up a terminal and run this command:

pip

pip install --upgrade cognite-toolkit

poetry

poetry add cognite-toolkit@latest

To upgrade the Cognite Toolkit to a specific version, for example a beta version, open up a terminal and run this command:

pip

pip install cognite-toolkit==0.3.0b4

poetry

poetry add cognite-toolkit@0.3.0b4

Replace 0.3.0b4 with the version you want to install.

Step 2: Upgrade the Cognite Toolkit modules

To update the Cognite Toolkit modules to be compatible with the installed version of the Cognite Toolkit CLI:

1. Open up a terminal and run this command:

   cdf-tk modules upgrade

2. Follow the Cognite Toolkit instructions to manually update settings that the Cognite Toolkit couldn't upgrade automatically.