MindConnect-NodeJS - CLI - Overview

Introduction

The library comes with a command line interface which can be used to upload timeseries, files and create events in the mindsphere. It can be installed via npm :

npm install -g @mindconnect/mindconnect-nodejs

See also getting started section of this documentation

What is it

The CLI can be used to create starter projects, upload timeseries, events and files, read agent diagnostics etc.

CLI in action

List of all commands

Usage: mc [options] [command]

Options:
  -V, --version                       output the version number
  -h, --help                          output usage information

Commands:
  onboard|ob [options]                onboard the agent with configuration stored in the config file
  agent-token|atk [options]           displays the agent token for use in other tools (e.g. postman)
  upload-timeseries|ts [options]      parse .csv file with timeseriesdata and upload the timeseries data to mindsphere
  upload-file|uf [options]            upload the file to the mindsphere file service (optional: passkey) *
  create-event|ce [options]           create an event in the mindsphere (optional: passkey) *
  agent-status|as [options]           displays the agent status and agent onboarding status *
  create-agent|ca [options]           create an agent in the mindsphere *
  offboard-agent|of [options]         offboards the agent in the mindsphere *
  renew-agent|rn [options]            renews the agent secrets  *
  service-credentials|sc [options]    provide login for commands which require technical user credentials *
  service-token|stk [options]         displays the service token for use in other tools (e.g. postman) *
  register-diagnostic|rd [options]    register agent for diagnostic *
  get-diagnostic|gd [options]         get diagnostic information *
  unregister-diagnostic|ud [options]  unregister agent from diagnostic *
  prepare-bulk|pb [options]           creates a template directory for timeseries (bulk) upload *
  run-bulk|rb [options]               runs the timeseries (bulk) upload job from <directoryname> directory *
  check-bulk|cb [options]             checks the progress of the upload jobs from <directoryname> directory *
  list-assets|la [options]            list assets in the tenant *
  list-files|ls [options]             list files stored with the asset *
  download-file|df [options]          download the file from mindsphere file service *
  spectrum-analysis|sp [options]      perform spectrum analysis on a sound file @
  signal-validation|sv [options]      perform signal validation @
  starter-ts|st [options]             creates a starter project in typescript #
  starter-js|sj [options]             creates a starter project in javascript #

  Documentation:

    the magenta colored commands * require service credentials.
    the cyan colored commands require mindconnectlib (agent) credentials
    the blue colored commands @ use analytical functions of MindSphere
    the green colored commands # are used to setup starter projects
    the service credentials should only be used in secure environments for setup tasks
    Full documentation: https://opensource.mindsphere.io
The content of the community tools and libraries documentation pages is licensed under the MIT License.
Siemens API Notice applies.
Back to top