Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nordic.edgeimpulse.com/llms.txt

Use this file to discover all available pages before exploring further.

The Edge Impulse Linux CLI is used for collecting data and running inferences on Linux devices. It is bundled as part of the Linux Node.js SDK and consists of multiple tools:

​
Installation

npm install -g edge-impulse-linux

​
Edge Impulse Linux

edge-impulse-linux --help

Usage: edge-impulse-linux [options]

Edge Impulse Linux client 1.4.3

Options:
  -V, --version         output the version number
  --api-key <key>       API key to authenticate with Edge Impulse (overrides current credentials)
  --hmac-key <key>      HMAC key to sign new data with (overrides current credentials)
  --disable-camera      Don't prompt for camera
  --disable-microphone  Don't prompt for microphone
  --width <px>          Desired width of the camera stream
  --height <px>         Desired height of the camera stream
  --clean               Clear credentials
  --silent              Run in silent mode, don't prompt for credentials
  --dev                 List development servers, alternatively you can use the EI_HOST environmental variable to specify the Edge Impulse instance.
  --verbose             Enable debug logs
  -h, --help            output usage information

​
Edge Impulse Linux Runner

edge-impulse-linux-runner --help

Usage: edge-impulse-linux-runner [options]

Edge Impulse Linux runner 1.3.12

Options:
  -V, --version            output the version number
  --model-file <file>      Specify model file (either path to .eim, or the socket on which
                           the model is running), if not provided the model will be fetched
                           from Edge Impulse
  --api-key <key>          API key to authenticate with Edge Impulse (overrides current
                           credentials)
  --download <file>        Just download the model and store it on the file system
  --force-target <target>  Do not auto detect the target system, but set it by hand
  --clean                  Clear credentials
  --silent                 Run in silent mode, don't prompt for credentials
  --quantized              Download int8 quantized neural networks, rather than the float32
                           neural networks. These might run faster on some architectures,
                           but have reduced accuracy.
  --enable-camera          Always enable the camera. This flag needs to be used to get data
                           from the microphone on some USB webcams.
  --dev                    List development servers, alternatively you can use the EI_HOST
                           environmental variable to specify the Edge Impulse instance.
  --print-info             Print model information and exit
  --verbose                Enable debug logs
  -h, --help               output usage information