Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ForestAdmin/toolbelt
🛠The Forest Admin toolbelt is a CLI which makes easy to setup and manage your back office application lifecycle directly from your terminal.
https://github.com/ForestAdmin/toolbelt
admin admin-panel backend backend-api cli internal-tooling nodejs package
Last synced: 2 months ago
JSON representation
🛠The Forest Admin toolbelt is a CLI which makes easy to setup and manage your back office application lifecycle directly from your terminal.
- Host: GitHub
- URL: https://github.com/ForestAdmin/toolbelt
- Owner: ForestAdmin
- License: gpl-3.0
- Created: 2018-10-26T17:16:53.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-20T07:53:48.000Z (4 months ago)
- Last Synced: 2024-07-01T23:06:30.210Z (3 months ago)
- Topics: admin, admin-panel, backend, backend-api, cli, internal-tooling, nodejs, package
- Language: JavaScript
- Homepage: https://www.forestadmin.com
- Size: 7.55 MB
- Stars: 63
- Watchers: 12
- Forks: 1
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - ForestAdmin/toolbelt - 🛠The Forest Admin toolbelt is a CLI which makes easy to setup and manage your back office application lifecycle directly from your terminal. (JavaScript)
README
# Forest Admin CLI
[](https://badge.fury.io/js/forest-cli)
[](https://github.com/ForestAdmin/toolbelt/actions)
[](https://codeclimate.com/github/ForestAdmin/toolbelt/test_coverage)
[](https://github.com/semantic-release/semantic-release)
The Lumberjacks' toolbelt is the Forest Admin CLI which makes easy to manage your back office application directly from the terminal.
## Install
$ npm install -g forest-cli
## Commands
$ forest [command]
### 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:create ` generate a backend application with an ORM/ODM configured.
- `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.
Without the Development Workflow experience.
- `environments:copy-layout` copy the layout from one environment to another.
With the Development Workflow activated.
- `init` set up your development environment in your current folder.
- `branch` create a new branch or list your existing branches.
- `switch` switch to another branch in your local development environment.
- `push` push layout changes of your current branch to a remote environment.
- `deploy` deploy layout changes of an environment to the reference one.
- `environments:reset` reset a remote environment by removing all layout changes.
### Schema
Manage Forest Admin schema.
- `schema:apply` apply the current schema of your repository to the specified environment (using your `.forestadmin-schema.json` file).
- `schema:diff` allow to compare two environment schemas.
- `schema:update` refresh your schema by generating files that do not currently exist.
## Docker
### ENV variables
- `DATABASE_SCHEMA` the schema used by the database. (not for all commands)
- `DATABASE_URL` the connection string. (not fot all commands)
- `FOREST_ENV_SECRET` the env secret token used to access your Forest Admin environment.
- `SILENT` used to not log commands results. (optional)
- `TOKEN_PATH` path where store the session token. (need to be "/usr/src/cli" to work with the docker image)
If you have an `.env` file in you current folder docker should take it to run commands. So you can define the missing ENV variable inside.
Otherwise you should pass all env variable you need in the `docker run` command, eg: `-e TOKEN_PATH="/usr/src/app"`.
### Using Forest Admin CLI
- `TOKEN_PATH`="/usr/src/cli"
```bash
docker run --rm --init -it -v `pwd`:/usr/src/app -v ~/.forest.d:/usr/src/cli/.forest.d -e TOKEN_PATH="/usr/src/cli" forestadmin/toolbelt:latest [command]
```
## Community
👇 Join our Developers community for support and more
[](https://community.forestadmin.com)