Skip to content

Iotize CLI

The IoTize command-line interface (CLI) is your go-to tool for developing IoTize apps.

Requirements

nodejs The download page has prebuilt installation packages for all platforms. We recommend selecting the LTS version to ensure best compatibility. Make sure the latest Node LTS is installed.

Installation

The IoTize CLI can be installed globally with npm:

Windows 10

Open elevated power shell and run

npm install --global --production windows-build-tools@4.0.0

Once done open a new shell (not elevated) and run

npm install --global @iotize/cli

Others

npm install --global @iotize/cli

Warning

When packages are installed globally, EACCES permission errors can occur.

Consider setting up npm to operate globally without elevated permissions. See Ionic framework page: Resolving Permission Errors.

Usage

Help

Command documentation is accessible with the --help flag.

iotize <command> --help
# or 
iotize --help

Version

Print current CLI version

iotize version

Info

Make sure the latest version of the Ionic CLI is installed. Update with npm install -g iotize/cli@latest.

Architecture

The IoTize CLI is built with Node.js. It supports Node 6+, but the latest Node LTS is always recommended.

Connectivity

This tools is able to communicate with WiFi and BLE Tap device.

NFC is not available. Use a smartphone with Tap Manager to configure a relay NFC to Socket.

Troubleshooting BLE

This tool uses @iotize/device-com-ble.node library.

It uses noble. See their README for more information.

Windows 10 users with BLE capabilities

Just install and use it, it should work out of the box

It uses noble-uwp. System requirements are the same specified in the README.md

Other platforms

You will need to install BLE dongle and install a universal USB driver (you can use Zadig tool)

This library has been tested with the following dongle:

Name USB VID USB PID
CSR8510 A10 0x0a12 0x0001

More information here https://github.com/noble/node-bluetooth-hci-socket