forestadmin/toolbelt

Forest Admin CLI Docker镜像

镜像概述

Forest Admin CLI（Lumberjacks' toolbelt）是Forest Admin的命令行工具，用于通过终端直接管理后台应用。本Docker镜像封装了该CLI工具，提供便捷的容器化使用方式，支持项目管理、环境配置、架构操作等核心功能，适用于开发者在Docker环境中高效管理Forest Admin后台应用。

核心功能与特性

多维度命令支持

• 用户管理：登录/登出账户、查看当前登录用户
• 项目管理：列出项目、创建项目（自动配置ORM/ODM的后端应用）、获取项目配置
• 环境管理：列出环境、获取环境配置、创建/删除环境、复制布局（无开发工作流时）、初始化开发环境、分支管理、切换分支、推送布局变更、部署环境、重置环境（有开发工作流时）
• 架构管理：应用当前仓库架构至指定环境、比较两个环境架构差异、更新架构（生成不存在的文件）

Docker环境适配

• 支持通过环境变量配置运行参数
• 兼容.env文件自动加载环境变量
• 预设会话令牌存储路径，确保容器内正常运行

使用场景

• 开发者通过命令行在Docker环境中快速创建Forest Admin项目
• 管理多环境配置，实现开发、测试、生产环境的布局同步与部署
• 在容器化CI/CD流程中集成架构验证与应用操作
• 团队协作中统一CLI工具版本与运行环境

使用方法与配置说明

环境变量（ENV variables）

注：若当前目录存在.env文件，Docker会自动加载其中的环境变量；否则需在docker run命令中通过-e参数显式传递所需变量。

Docker运行示例

使用以下命令运行Forest Admin CLI Docker镜像，执行指定命令：

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]

参数说明：

• --rm：容器退出后自动删除
• --init：使用init进程管理容器内进程
• -it：启用交互模式，支持终端输入
• -v pwd:/usr/src/app：挂载当前工作目录至容器内/usr/src/app，便于访问项目文件
• -v ~/.forest.d:/usr/src/cli/.forest.d：挂载本地会话数据目录至容器，持久化登录状态
• -e TOKEN_PATH="/usr/src/cli"：设置会话令牌存储路径，适配Docker镜像
• [command]：需执行的Forest Admin CLI命令（如login、projects:create等）

命令参考

通用命令（General）

• user：显示当前登录用户
• login：登录Forest Admin账户
• logout：退出Forest Admin账户
• help [cmd]：显示指定命令的帮助信息

项目管理（Projects）

• projects：列出所有项目
• projects:create <appName>：生成后端应用（自动配置ORM/ODM）
• projects:get：获取项目配置

环境管理（Environments）

• environments：列出所有环境
• environments:get：获取环境配置
• environments:create：创建新环境
• environments:delete：删除环境

无开发工作流时：

• environments:copy-layout：复制一个环境的布局至另一个环境

有开发工作流时：

• init：在当前文件夹设置开发环境
• branch：创建新分支或列出已有分支
• switch：切换本地开发环境的分支
• push：将当前分支的布局变更推送到远程环境
• deploy：将一个环境的布局变更部署到参考环境
• environments:reset：重置远程环境（移除所有布局变更）

架构管理（Schema）

• schema:apply：应用当前仓库架构至指定环境（使用.forestadmin-schema.json文件）
• schema:diff：比较两个环境的架构差异
• schema:update：更新架构（生成不存在的文件）

社区支持

加入Forest Admin开发者社区获取支持与更多资源：

![Discourse开发者社区]([***]