Local Machine Setup

Important: Keep in mind that MATRIX CLI is intended to run on your host computer, not directly on the Pi running MOS.

Note 1: Pre-requisite of NodeJS on the client computer.

  1. Install MATRIX CLI via npm sudo npm install -g matrix-cli.
  2. Target the proper environment matrix set env rc.
  3. With MATRIX CLI installed on your computer, register an account with MATRIX via matrix register.
  4. Log into your account using matrix login.
  5. Once registered an account, run matrix register device.
  6. Enter a device name and (optional) device description.
  7. After a few moments you will be provided with a MATRIX_DEVICE_ID and MATRIX_DEVICE_SECRET.
  8. Select your device using matrix use, and enter your device ID. Command examples will be provided for easy copy paste.
# example variables generated via registration, yours will be different
export MATRIX_DEVICE_ID=dc7a1a71be2d
export MATRIX_DEVICE_SECRET=08629018e9d77h15i5n0t4r3alz0f06cd4f7e5544272b

Save these for the Configure ENV Variables step, near the end.

Note 2: Watch Getting Started, Registration and Installation of MATRIX OS and MATRIX CLI on Youtube. Watch now.

Raspberry Pi Setup

The following installation configures the MATRIX Creator, as well as installs the MATRIX Open Source platform.

# Does everything including reboot.
curl | sh
Configure ENV variables
  1. On the Pi, inside your ~ folder, create a file named .envrc with the variables from the Matrix CLI Setup above.
# in .envrc file or place in ~/.bash_profile to auto configure
export MATRIX_DEVICE_ID=dc7a1a71be2d
export MATRIX_DEVICE_SECRET=08629018e9d77h15i5n0t4r3alz0f06cd4f7e5544272b
  1. source .envrc from ~ to make the variables available to the shell.


  1. From the matrix-os folder. NODE_ENV=rc node index.js. While in alpha, we are running in our Release Candidate environment.

Returning to local computer

  1. If you didn't do it earlier, matrix use $deviceId
  2. Run matrix, verify you are on rc environment, your user is correct, and your selected device is correct.
  3. Now you can issue commands and deploy apps to your MATRIX OS from the MATRIX CLI.

Custom Raspbian Package

We'll be making a custom raspbian package available for download very soon!