init

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.

init

The forest init command provides an all-in-one initialization command that will:

• allow you to log in if you haven't already done so with forest login

• set up your own development environment on a given project.

$ forest init --help
Set up your development environment in your current folder.

USAGE
  $ forest init

OPTIONS
  -p, --projectId=projectId  The id of the project you want to init.

forest init is not meant to help you create a new project. If you don't have an existing project yet, please refer to this guide.

forest init should be run from your project's root directory

Login

All Forest CLI commands require to be authenticated. You can do this on the fly using forest init or use forest login first. Refer to the forest login page if you need further details.

Project selection

The development environment you will initialize is unique per project and per developer. It is thus mandatory that we identify the right project to create your environment accordingly:

If you have 1 project only in your Forest Admin account, this step will be automatically skipped.

If you have 2 projects or more, you'll be asked to choose one: it should match the project from your current directory!

forest init requires your project to run on the latest version of Forest Admin:

$ forest init
✓ Selecting your project
✖ Analyzing your setup
> This project does not support branches yet. Please migrate your environments from your Project settings first.

If you're seeing the above message, please refer to this migration guide.

Endpoint selection

If you're using forest init, it means your admin backend should already be running locally. If you used the default values used during installation, your endpoint should be http://localhost:3310

Since we need to know your project's local endpoint in order to create your development environment, we've left the same default values. You can just hit "Enter" to use those; otherwise simply fill the host and port to fit your situation.

[? Enter your local admin backend host: (localhost) localhost
[? Enter your local admin backend port: (3310)

At this point, your development environment will be created! 🎉

Note that your new development environment is identified by the FOREST_ENV_SECRET in your .env file. If you had no such file, it will have been automatically created.

(Optional) Connecting your database

To work properly in your local environment, your Forest Admin project needs to be connected to the corresponding database (which could be local or remote, it's your choice.)

As a result, we've added an extra step to the forest init command to help you set up your database. If you accept the help, you'll be taken through a few prompts and your DATABASE_URL (and potentially other environment variables) will be generated and added to your .env file.