pos-cli is command line tool, which was developed to allow you to easily deploy your configuration files and assets to the platformOS. It expects you to follow a certain file structure in order 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 Terminal.
If you have any feature requests, feedback or problems please head over to the issues page and let us know.
All commands should be run in the project root directory - i.e. one level above
pos-cli requires nodejs >= v10 to work properly. Read more on how to install node on your platform.
Installation and update
If your node is installed for all users you might need to use
sudo to install npm packages globally:
sudo npm install -g @platformos/pos-cli
If you are using nvm or have node installed on your account, you can omit that:
npm install -g @platformos/pos-cli
Adding environments and authenticating
Authentication is done with your Partner Portal account credentials. See this guide if you don't have Partner Portal account yet.
To add your environment to a config file, run the
env add command, and authenticate with your Partner Portal credentials:
pos-cli env add <environment> --email <your email> --url <your application url>
pos-cli env add staging --email firstname.lastname@example.org --url https://example.com
Configuration for environments lays down in
pos-cli sync <environment>
pos-cli sync staging
Enables sync mode - immediately pushes changes made to filesystem to the proper environment. It feels like working on localhost. For obvious reason, it is dangerous to use on production, on a live application - it is recommended to use it only for staging.
pos-cli deploy <environment>
pos-cli deploy staging
Deploys all the changes. It is recommended to first deploy to
staging, test, and only then trigger to production. Effectively, deploy creates a zip file containning all your files and sends it to API. It is then processed in the background. Each zip file is stored by us, in order to allow you to rollback in case something goes wrong.
To skip audit during deploy, set environmental variable
Runs statical analysis on file in your current application directory.
Errors and logs that you or the system logs for you can be accessed via
logs command. Read more how to create logs.
pos-cli logs <environment>
From now on as long as your
logs command is running, logs will aprear here. Errors will trigger system notification if your operating system is supporting them.
If you forgot know what your environments are named or the url that is corresponding to any name, use:
pos-cli env list
Initializing directory structure
If you need to create new project from scratch you can init directory structure using:
pos-cli init --url mdyd-dev/directory-structure --branch master
Init command supports all formats supported by degit, as it is used as an engine underneath.
It will download directory structure from given git repository and extract it in your current directory.
Lists all the installed modules via Partners Portal on a given environment.
This command will not list modules that are deployed by you via
pos-cli modules list <environment>
Removes a module from your application.
pos-cli modules remove <environment> <module name>
Migrations are files that contain liquid code (including graphql) that you want to run and have trace of what exactly has been run.
This is very helpful if you want to execute the same code on multiple environments, after code has been deployed. For example: seeding initial data.
Read more about migrations in our documentation:
Lists migrations deployed to the server and their current status.
pos-cli migrations list <environment> <name>
Generates new migration with the name you provided. It will be prepended with a timestamp so if you create more than one, they will be run in the order you intended.
Migrations are run automatically on deploy.
pos-cli migrations generate <environment> <name>
You can run migration manually using
run command. You must first sync the migration file to the environment.
Name of the migration is the filename without extension, or just the timestamp.
pos-cli migrations run <environment> <name>
pos-cli migrations run staging 20190715132951_update_admin_password
Exports data from the environment to a given file in form of JSON.
Read more about exporting data with CLI, REST API and GraphQL in our documentation.
pos-cli data export staging --path=data.json
Imports data from a given JSON file with proper data structure.
Read more about importing data with CLI, REST API and GraphQL in our documentation.
pos-cli data import staging --path=data.json
Clean (only staging)
Cleans data on an instance. Keep in mind that this is only removing rows of data, not the structure definition.
For example, if you have model schema
car and there are 10 entries of type
car, those will be deleted, but the model schema
car will remain intact.
This is useful for testing your imports/exports or resetting your database to pristine state between tests.
This operation is irreversible. You will be asked twice by
pos-cli if you are sure you want to do it.
pos-cli data clean staging
To start http server locally that will serve GUI use:
pos-cli gui serve <environment>
pos-cli gui serve staging
To explore your instance database using GraphQL open http://localhost:3333/gui/graphql in your web browser.
In the right sidebar there is a schema documentation should you need it.
To list, edit and create resources open http://localhost:3333/gui/editor in your web browser.