Skip to main content

The CDF Toolkit

ALPHA status

The CDF Toolkit is in alpha status and is currently being tested with named customers and with "hyper-care" from a representative of the development organisation. You are free to test it out, but do not use it on a production project yet.

The CDF Toolkit is a command-line interface (cdf-tk) used for configuring and administrating Cognite Data Fusion (CDF) projects. It supports three different modes of operation:

  1. As an interactive command-line tool used alongside the Cognite Data Fusion web application to retrieve and push configuration of the different Cognite Data Fusion services like data sets, data models, transformations, and more. This mode also supports configuration of new Cognite Data Fusion projects to quickly get started.
  2. As tool to support the project life-cyle by scripting and automating configuration and management of Cognite Data Fusion projects where CDF configurations are kept as yaml-files that can be checked into version control. This mode also supports DevOps workflows with development, staging, and production projects.
  3. As a tool to deploy official Cognite project templates to your Cognite Data Fusion project. The tool comes bundled with templates useful for getting started with Cognite Data Fusion, as well as for specific use cases delivered by Cognite or its partners. You can also create your own templates and share them.
Get the CDF Toolkit

The tool is available as a Python package. To install the cdf-tk tool, you need a working Python installation >=3.9 (recommended 3.11). Run: pip install cognite-toolkit

You can then run cdf-tk --help to see the available commands. Each of the commands has comprehensive help accessible using the --help option, e.g. cdf-tk init --help.

Last updated: