Documentation
Live DemoGithubCommunity
Search…
v8 (v7 Rails v1 Django)
Forest Admin
Getting Started
Installation
Setup guide
Development workflow
Reference Guide
How it works
Models
Relationships
Views
Collections
Fields
Routes
Actions
Segments
Scopes
Performance
Charts
Integrations
Project settings
Teams, Users & Permissions
Organizations
Collaboration
Glossary
Extra help
Setup
Upgrade
Upgrade notes (Rails)
Upgrade notes (SQL, Mongodb)
Update your models' definition
Monitor your Forest's status
Manage your Forest Admin environments programmatically
Migrate to the new role system
Migrate to the new Development Workflow
Databases
Settings
Code samples
Powered By GitBook
Manage your Forest Admin environments programmatically
For continuous integration and automatisation, we have developed a CLI which makes it easy to manage your Forest Admin environments.
This can be used for Q&A and testing purposes.

Install

1
$ npm install -g forest-cli
Copied!

Commands

1
$ forest [command]
Copied!
General
  • user display the current logged in user.
  • login sign in to your Forest Admin account.
  • logout sign out of your Forest Admin account.
  • help [cmd] display help for [cmd].
Projects
Manage Forest Admin projects.
  • projects list your projects.
  • projects:get get the configuration of a project.
Environments
Manage Forest Admin environments.
  • environments list your environments.
  • environments:get get the configuration of an environment.
  • environments:create create a new environment.
  • environments:delete delete an environment.
  • environments:copy-layout copy the layout from one environment to another.

Schema

Manage Forest Admin schema.
schema:apply apply the current schema of your repository to the specified environment (using your .forestadmin-schema.json file).
This option is available only on lianas version >+ 3.
Previous
Monitor your Forest's status
Next
Migrate to the new role system
Last modified 2yr ago
Copy link
Contents