@elaraai/detect-cli NPM

EDK Detect CLI

The EDK (ELARA Development Kit) Detect CLI package contains a CLI and Typescript Libraries to manage type detection for ELARA datasources.

Installation

The EDK Detect CLI package can be installed with npm:

npm install -g @elaraai/detect-cli

Usage

The Detect package can be used either as the CLI or Typescript Libraries.

CLI Usage

Once the Detect CLI package is installed globally, the CLI can be invoked from the command line, for example to read the Detect CLI help:

$ edk-detect --help
Usage: edk-detect [options] <asset>

detect datasource expressions

Arguments:
  asset          the schema asset to detect

Options:
  -V, --version  output the version number
  --dir <dir>    the path for the project directory (default: "...")
  --defaults     set to true to choose the defaults automatically (default: false)
  -h, --help     display help for command

Library Usage

Alternatively the package modules may be imported and applied within a Typescript project:

 import * as cli from '@elaraai/cli'
 import * as detect from '@elaraai/detect-cli'
 // detect a datasource
 const project_dir = 'path_to_workspace'
 async function run() {
     // add a datasource to the project
     let config = detect.detectDataSource({
         asset: 'employees.source',
         defaults: true,
         config: cli.config(project_dir),
         dir: project_dir
     });
}

run()

Related NPM Packages

Core: Typescript Libraries to define ELARA Digital Twin Templates.
CLI: a CLI and Typescript Libraries to create, develop and deploy ELARA projects.
Plugins: Typescript Libraries with ELARA Digital Twin Template plugins.

Related Github Repositories

Examples: Typescript source-code for various ELARA Digital Twin Template projects.
Plugins: Typescript source-code for ELARA Digital Twin Template plugins.