Installing the pos-cli

Last edit: Dec 04, 2019
  • Contributors:
  • diana-lakatos
  • pavelloz

This guide will help you install the platformOS pos-cli, that allows you to easily deploy your configuration files and assets to our platform, and communicate with the platformOS API.


The pos-cli provides a wide range of features beyond initializing your codebase, including syncing and deployment, auditing, data export and import, migrations, logging, and a GUI.


To install the pos-cli, you need NPM (Node.js Package Manager). See our tutorials for installing Node.js on Mac or Windows:


Installing the pos-cli is a two-step process:

Step 1: Install the pos-cli using NPM

Start your command-line tool (e.g. Terminal on a Mac, or Git Bash on Windows), and enter:

npm install -g @platformos/pos-cli

If your Node.js is installed for all users you might need to use sudo to install NPM packages globally:

sudo npm install -g @platformos/pos-cli

You can follow the installation process in your command-line (something similar to this will be displayed during installation):

/usr/local/bin/pos-cli-deploy -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-deploy.js
/usr/local/bin/pos-cli -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli.js
/usr/local/bin/pos-cli-audit -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-audit.js
/usr/local/bin/pos-cli-env -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-env.js
/usr/local/bin/pos-cli-env-list -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-env-list.js
/usr/local/bin/pos-cli-env-add -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-env-add.js
/usr/local/bin/pos-cli-gui -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-gui.js
/usr/local/bin/pos-cli-logs -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-logs.js
/usr/local/bin/pos-cli-init -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-init.js
/usr/local/bin/pos-cli-gui-serve -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-gui-serve.js
/usr/local/bin/pos-cli-migrations -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-migrations.js
/usr/local/bin/pos-cli-modules -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-modules.js
/usr/local/bin/pos-cli-sync -> /usr/local/lib/node_modules/@platformos/pos-cli/bin/pos-cli-sync.js

> @platformos/pos-cli@4.1.18 postinstall /usr/local/lib/node_modules/@platformos/pos-cli
> node ./scripts/check-node-version.js

+ @platformos/pos-cli@4.1.18
added 406 packages from 238 contributors in 7.709s

Step 2: Test the pos-cli

Use the following command to test the pos-cli:

pos-cli -v

If the pos-cli has been installed correctly, running this command displays the version of your pos-cli. If the pos-cli hasn't been installed, running this command gives a command not found error.

Next steps

Congratulations! You have installed the pos-cli. You can now create your codebase.


We are always happy to help with any questions you may have.