This repository contains Cognite deployment packs — downloadable, extensible Toolkit modules that you configure and deploy with the Cognite Toolkit.
Templates guide users through deploying, customizing, and building Cognite solutions: data processing, contextualization pipelines, and application configuration.
All deployable content lives under modules/. The registry of packs is modules/packages.toml.
| Folder | Purpose |
|---|---|
common/ |
Shared CDF platform modules (cdf_common, cdf_ingestion, cdf_project_foundation, cdf_search) |
contextualization/ |
File annotation, entity matching, P&ID annotation |
datamodels/ |
Industry and extension data models (rmdm, ISA, CFIHOS, …) |
solutions/ |
Product verticals (cdm_maintain, cdf_infield, cdf_ai_extractor) |
sourcesystem/ |
Extraction pipeline configs (PI, OPC-UA, SAP, database, files) and synthetic data dumps |
dashboards/ |
Streamlit dashboards and reporting |
common/cdf_dq_runtime/ |
SHACL data-quality validation (cdf_dq_runtime) |
tools/ |
Qualitizer |
custom/ |
Empty module template |
scripts/ — contributor tooling for the uv workspace and CDF deploy requirements.txt generation (scripts/README.md).
| Prefix | Use for | Examples |
|---|---|---|
cdf_ |
Cognite-built platform capabilities | cdf_common, cdf_pi_extractor, cdf_file_annotation |
cdm_ / cdf_ |
Solutions on Cognite Data Model | cdm_maintain, cdf_infield |
| (none) | Industry models, dashboards, tools | rmdm, context_quality, qualitizer |
Apply the prefix on module folder names where it helps discovery. Top-level folders (common/, datamodels/, …) are not prefixed.
Contributors: see CONTRIBUTING.md, scripts/README.md (uv workspace and deploy requirements), and modules/README.md.
The Cognite Toolkit ships with [library.cognite] already pointing at this
repository's latest release, so a new project is wired up out of the box.
[alpha_flags]
external-libraries = true- New project:
cdf modules init - Existing project:
cdf modules add
The Toolkit shows deployment packs defined in modules/packages.toml.
The open-source Github repository ("Repository") is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. Usage of the Repository is voluntary and in no event shall Cognite be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the use of the Repository.