Node.js Developer Guide
Other documentationsDemoCommunityGitHub
  • Forest Admin
  • Getting started
    • How it works
    • Quick start
    • Install
      • Create your agent
      • Expose an HTTP endpoint
        • For standalone agents
        • On Express
        • On Koa
        • On Fastify
        • On NestJS
      • Autocompletion & Typings
      • Troubleshooting
    • Migrating legacy agents
      • What's new
      • Pre-requisites
      • Recommendations
      • Migration steps
        • Run new agent in parallel
        • Configure database connection
        • Code transformations
          • API Charts
          • Live Queries
          • Smart Charts
          • Route overrides
          • Smart Actions
          • Smart Fields
          • Smart Relationships
          • Smart Segments
        • Compare schemas
        • Swap agents
      • Post-migration
        • Dropping Sequelize
        • Optimize your agent
  • Data Sources
    • Getting Started
      • Collection selection
      • Naming conflicts
      • Cross-data source relationships
      • Query interface and Native Queries
        • Fields and projections
        • Filters
        • Aggregations
    • Provided data sources
      • SQL (without ORM)
      • Sequelize
      • Mongoose
      • MongoDB
    • Write your own
      • Replication strategy
        • Persistent cache
        • Updating the replica
          • Scheduled rebuilds
          • Change polling
          • Push & Webhooks
        • Schema & References
        • Write handlers
      • Translation strategy
        • Structure declaration
        • Capabilities declaration
        • Read implementation
        • Write implementation
        • Intra-data source Relationships
      • Contribute
  • Agent customization
    • Getting Started
    • Actions
      • Scope and context
      • Result builder
      • Static Forms
      • Widgets in Forms
      • Dynamic Forms
      • Form layout customization
      • Related data invalidation
    • Charts
      • Value
      • Objective
      • Percentage
      • Distribution
      • Leaderboard
      • Time-based
    • Fields
      • Add fields
      • Move, rename and remove fields
      • Override binary field mode
      • Override writing behavior
      • Override filtering behavior
      • Override sorting behavior
      • Validation
    • Hooks
      • Collection hook
      • Collection override
    • Pagination
    • Plugins
      • Provided plugins
        • AWS S3
        • Advanced Export
        • Flattener
      • Write your own
    • Relationships
      • To a single record
      • To multiple records
      • Computed foreign keys
      • Under the hood
    • Search
    • Segments
  • Frontend customization
    • Smart Charts
      • Create a table chart
      • Create a bar chart
      • Create a cohort chart
      • Create a density map
    • Smart Views
      • Create a Map view
      • Create a Calendar view
      • Create a Shipping view
      • Create a Gallery view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
  • Deploying to production
    • Environments
      • Deploy on AWS
      • Deploy on Heroku
      • Deploy on GCP
      • Deploy on Ubuntu
      • Deploy on Azure
    • Development workflow
    • Using branches
    • Deploying your changes
    • Forest Admin CLI commands
      • init
      • login
      • branch
      • switch
      • set-origin
      • push
      • environments:create
      • environments:reset
      • deploy
  • Under the hood
    • .forestadmin-schema.json
    • Data Model
      • Typing
      • Relationships
    • Security & Privacy
Powered by GitBook
On this page

Was this helpful?

  1. Deploying to production
  2. Forest Admin CLI commands

init

PreviousForest Admin CLI commandsNextlogin

Last updated 1 year ago

Was this helpful?

This is the official documentation of the @forestadmin/agent Node.js agent.

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

  • set up your 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 .

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

Login

All Forest Admin CLI commands require to be authenticated. You can do this on the fly using forest init or use forest login first. Refer to the 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 only have 1 project attached to your Forest Admin account, this step will be automatically skipped.

If you have more than 1 project, you'll be asked to choose one. It must match the project from your current directory.

Endpoint selection

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

Since Forest Admin needs to know your project's local endpoint to create your Development Environment, we've left the same default values. You can just hit "Enter" to use those; otherwise, simply fill in the host and port to fit your configuration.

[? Enter your local agent host: (localhost) localhost
[? Enter your local agent 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 do not have such file, it will be generated automatically during the command execution.

(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 ) will be generated and added to your .env file.

forest login
this guide
forest login
other environment variables