cdf.toml file. For example, to enable the alpha-rules alpha flag,
add the following to your cdf.toml file:
Cognite Toolkit versioning and releases
The Cognite Toolkit uses semantic versioning to manage versions as major, minor, and patch (for example,0.3.17).
- A major version increases with breaking changes in the CLI or the format of modules and configuration files. Installing a new major toolkit version may require updating your configuration files or modules.
- Minor versions increase with new features and patch versions with bug fixes.
Alpha flag: alpha-rules
Status: experimental Available from:0.8.213
cdf build, the Cognite Toolkit validates the configurations against a set of rules. For example, one rule requires that all referenced resources are part of the build or already exist in CDF. If a view references a container, the Cognite Toolkit checks that the container is part of the build or already exists in CDF. New rules are added over time and become part of a stable minor release. The alpha-rules flag lets you turn those rules on before that release so you can test your configurations.
Alpha flag: import-cmd
Status: experimentalcdf import command. The only subcommand available is transformation-cli. The command
converts the transformation-cli manifest files to the Cognite API (Toolkit) format. Use this, for example, if you have
transformations managed by the transformation-cli and want to convert them to the Cognite Toolkit format.
Alpha flag: infield
Status: experimental Available from:0.5.10
infield configuration resource. See cdf.toml
for more information about the infield configuration resource.
Alpha flag: migrate
Status: experimental Available from:0.5.45
cdf migrate command. This command enables you to migrate asset-centric resources, Charts, Canvas, legacy InField config / data, 3D models, and legacy 360° Images to the Cognite Core Data Model (CDM).
See the Migration plugin section for more information about its capabilities and limitations.
Alpha flag: records-migrate
Status: experimental Available from:0.7.239
cdf migrate events-to-records command. This command enables you to migrate events to records in CDF. See the Migration plugin section for more information about its capabilities and limitations.
Alpha flag: infield-location-split
Status: experimental Available from:0.8.187
cdf migrate infield-data and cdf migrate infield-source-data commands. Location-split separates InField data migration so you can untangle shared legacy instance spaces.
Alpha flag: create
Status: experimental Available from:0.7.3
create subcommand under the dev plugin, which allows you to create resource YAML files from the CLI.
To use this subcommand, you need to enable the dev plugin. Once enabled, you can create resource YAML files with cdf dev create. To get more information about the subcommand, use the --help flag.
Alpha flag: data-products
Status: experimental Available from:0.7.207
data_products/ YAML files for DataProduct and DataProductVersion. You can also add rulesets/ YAML files for RuleSet and RuleSetVersion. Then build and deploy the files with cdf build and cdf deploy.
Alpha flag: custom-apps
Status: experimental Available from:0.8.82
apps/ and deploy them with cdf build and cdf deploy. See the YAML Reference Library for configuration details.
Alpha flag: api
Status: experimental Available from:0.8.202
cdf api that allows you to run API calls against CDF directly from the CLI.
Alpha flag: modules-list-json
Status: experimental Available from:0.7.107
--format flag to the cdf modules list command, with this flag you can output json
instead of the default table format. This is useful for machine-readable output.
Alpha flag: multi-configs
Status: experimental Available from:0.9.9
cdf build read several config.[env].yaml files. Pass --config-yaml once for each file. For example:
environment.project and environment.validation-type. These fields are described in the environment section of config.[env].yaml.
variables and environment.selected stay separate in each file, so you can build the same module with different variable values.
Use several config files for one CDF project to keep each config.[env].yaml smaller and easier to maintain.