Last edit:

The pos-cli is a command line interface that helps you deploy configuration files and assets to your platformOS site. It expects you to follow a certain file structure to correctly communicate with the platformOS API. You do not have to use it, however, it is highly recommended that you do. It is a CLI tool, hence you are expected to have basic knowledge in working with a command line interface like Terminal.


pos-cli requires Node.js in at least the latest LTS version to work properly.


Follow our step-by-step Installing the pos-cli tutorial.

Commands and options

Run all commands in the project root directory - one level above the app or modules directory.

Learn about all pos-cli commands in the readme.


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

contact us