@cognite/cdf-cli v0.0.3--alpha

CDF CLI

Confluence

The CDF CLI's aim is to make it easier for developers to develop an app or solution on top of CDF. The CLI's current focus is on enabling key data modeling functionality, and we will expand towards other features in the future.

NOTE: This package is still in early alpha and under active development. We will document and test actively, but please file bug report via the Cognite Hub group

Install (Globally)

yarn global add @cognite/cdf-cli

Commands

We currently support these top level commands

Templates (alias: t)

Use templates backend to perform the action there (cdfrc.json file is the config file that helps execute the commands)

Templates Schema

Operate with schema inside templates instance

Solutions (alias: s)

Use new schema service backend to perform the action there (cdfrc.json file is the config file that helps execute the commands)

Options (Global)

These global --options are supported for helping with the executions

Command Description

Login

See the login section for more details

Logout

This will logout and clear the global config files for the CLI (not project config use templates delete for that)

cdf logout

Status

This command will tell about the login status and later on status of the backend your project is connected to.

cdf status

Templates Generate

This command generates the client side code for the specified project in cdfrc.json.

Currently following plugins are supported only:

• typescript
• typescript-operations
• typescript-resolvers
• typescript-react-apollo
• typescript-apollo-angular

--operations-file option will specify which graphql operations to generate hooks, functions for, like certain mutation or query

Example:

cdf templates generate --operations-file operations.graphql --plugins typescript typescript-operations

Metrics, Logs and Telemetry

Update Notifier

We check in background if a newer version of the package is published in npm and notify the user about the same if a newer version is available.

To opt-out set optOut to true in ~/.config/configstore/update-notifier-@cognite/cdf-cli.json or set env NO_UPDATE_NOTIFIER

Contributing to CDF CLI