smart-labs/knot-cli

KNoT CLI

KNoT CLI is a javascript package to speed up the development process in KNoT v2.

The KNoT CLI are available in NPM

Installation

Use the package manager npm to install knot-cli.

npm install -g knot-cli

Commands Summary

Supports the commands shown below

• Help

  To show all available commands, use the help.

  knot-cli --help

 

• Version

  To show the knot-cli version, use the version.

  knot-cli --version

 

• Create Application

  To create a new application, use create.

  Pass the project name and a blank project will be created.

  knot-cli create projectName

  Pass the project name and the number of digital pins and a project will be created configured with digital pins.

  knot-cli create projectName --digital value
  # or :
  knot-cli create projectName -d value

 

• Clone Exemple

  To clone a sample project, use the clone.

  Pass the function for the sample project to clone the repository.

  knot-cli clone function

  The table below follows the examples available for cloning.

  Projects	function
  analog alert	--al, --analogAlert
  blink	--blink
  button	--button
  digital counter	--dc, --digitalCounter
  multisensor	--ms, --multisensor
  plate	--plate
  tank	--tank
  thermo	--thermo
  toggle	--toggle

 

• KNoT Documentation

  To open KNoT documentation, use the doc:knot.

  Use one of the commands below to open the documentation on the home page.

  knot-cli doc:knot
  # or :
  knot-cli dock

  To open documentation in a specific location, use one of the following functions: --cloud, --gateway, --thing or --start.

  knot-cli dock function

 

• Zephyr Documentation

  To open Zephyr documentation, use the doc:zephyr.

  Use one of the commands below to open the documentation on the home page.

  knot-cli doc:zephyr
  # or :
  knot-cli docz

  To open documentation in a specific location, use one of the following functions: --api or --start.

  knot-cli docz function

 

• Open Docker

  To open the docker, use the docker.

  knot-cli docker

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT