@cognite/cdf-cli v2.0.0--alpha2

CDF CLI

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

Data-models (alias: dm)

Options (Global)

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

Command Description

Signin

See the login section for more details

cdf signin

cdf login

Signout

This will logout and clear the global config files for the CLI.

cdf signout

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

Data models generate

This command generates the client side code for the specified project.

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 data-models 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