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

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.


The forest deploy command enables you to apply some layout changes to your reference environment.

$ forest deploy --help

Deploy layout changes of the current branch to the reference one.

  forest deploy

  --force                  Skip confirmations.
  --help                   Display usage information.

Deploying your changes

It is paramount to understand this command before using it:

As you can see in the above figure, the layout changes (Δ) located in your local branch my-branch will be irreversibly applied to your Production layout. Since your remotes' layout are based on your production's layout, the changes will appear there too.

To deploy, simply run forest deploy:

$ forest deploy

To be able to deploy the origin of the branch should be the reference environment (eg: production)

Deploy from the UI

This is possible only from a remote which have the reference environment as origin:

To deploy your latest layout changes from a remote environment, you may use the top banner link: "Deploy to ...".

Last updated