The Cognite Toolkit uses alpha flags to enable experimental functionality that we often plan to support in the next minor release. By default, alpha flags aren’t enabled. To enable them, you must update theDocumentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
cdf.toml file. For example, to enable the module-repeat 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 releases (for example,
0.3.0a1) test new features, may contain breaking changes, and aren’t recommended for production. - Beta releases (
0.3.0b1) focus on stability and bug fixes and are suitable for non-production testing. - Stable releases (
0.3.0) are production-ready.
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 migrates asset-centric resources to data modeling. This
is currently an experimental feature and isn’t recommended for production use.
Alpha flag: profile
Status: experimental Available from:0.5.27
cdf profile command. This command allows you to profile CDF resources and their dependencies.
Use the cdf profile --help command to see the available options. Note that this command is currently in development and
will change in future releases.
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: signals
Status: experimental Available from:0.7.166
This flag enables signal sinks and signal subscriptions in the Cognite Toolkit. When enabled, you can add YAML files under signals/ and deploy them with cdf build and cdf deploy. The YAML Reference Library describes the Sink and Subscription resource types.
Alpha flag: data-products
Status: experimental Available from:0.7.207
rulesets/ YAML files for RuleSet and RuleSetVersion, then build and deploy them with cdf build and cdf deploy.