Forest CLI commands

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Forest CLI commands

You've seen in the previous section how developing on Forest Admin leverages our powerful Forest CLI to manage your UI changes.

Installing Forest CLI

To install Forest CLI, run the following command in your terminal:

npm install -g forest-cli

For further details on the package, check out this page.

Using Forest CLI

In the following pages, we'll cover all available Forest CLI commands in details, from introduction to advanced usage. For now, there are 6 commands:

• login

• init

• branch

• switch

• set-origin

• push

• environments:reset

• environments:create

• deploy

• schema:diff [beta]

Some additional commands might be added in the future. In the meantime, those should be largely sufficient to manage your development workflow.

Be aware that almost all commands take the FOREST_ENV_SECRET env variable, provided on the command or inside your .env file, to know on which environment the command is run.