CLI Setup

The sos CLI is a command-line tool that is the primary interface between a developer and the signageOS platform. Using the sos CLI you can:

• Develop applets locally or on real devices
• Deploy applets to real devices
• Run applet test suites
• Develop custom scripts
• Upload custom device firmware

What you will need

You need the following stack to get started with your development:

• signageOS Account
• Organization created in the Box (create a new one here)
• Node.js >= 10.15.0 (Node.js download)
• Shell, Gitbash, Powershell, Windows Terminal, or Cmder.

tip

The best way for managing the Node.js and NPM environments is nvm or fnm.

Installation

Terminal

npm install @signageos/cli -g
sos --help

info

The full documentation can be found on the signageOS Github. Once installed, you can use sos --help for quick help within the CLI.

Log in

Once installed, log in to the CLI with your signageOS Account.

Terminal

sos login

Set up default Organization

CLI allows you to manage Applets, devices and tests from multiple organizations. Choose your default one which will be used for development and testing.

If you do not have one yet, create it in signageOS Box

Terminal

sos organization set-default

Now you are all set. Continue by generating your Applet boilerplate.