OrgFlow CLI ***Docker镜像文档

镜像概述和主要用途

本镜像为OrgFlow CLI的***Docker镜像。OrgFlow是一款用于管理Salesforce组织和元数据的专业工具，旨在简化Salesforce开发流程中的元数据同步、版本控制和环境管理。该镜像提供预配置的OrgFlow CLI运行环境，封装了所有依赖组件，用户无需在本地系统安装OrgFlow及其依赖，即可通过容器化方式快速使用OrgFlow的全部功能，适用于跨平台环境和自动化流程集成。

核心功能和特性

***维护与同步

• 由OrgFlow***团队维护，确保与最新版OrgFlow CLI功能同步，包含最新特性和安全更新。

预配置运行环境

• 内置所有必要依赖组件，无需手动安装Java、Node.js等底层依赖，开箱即可使用。

轻量级设计

• 基于精简基础镜像构建，最小化镜像体积，降低资源占用和拉取时间。

跨平台兼容性

• 可在任何支持Docker的操作系统（Linux、macOS、Windows）和架构上运行，确保环境一致性。

无侵入式使用

• 无需修改本地系统配置，避免环境冲突，特别适合多版本工具并存的场景。

使用场景和适用范围

开发团队日常工作流

• Salesforce开发人员执行元数据拉取、推送、比对等日常操作。
• 团队内统一工具版本，避免因本地版本差异导致的操作不一致。

CI/CD流水线集成

• 在自动化构建、测试流程中嵌入OrgFlow命令，实现元数据部署自动化。
• 与Jenkins、GitHub Actions、GitLab CI等CI/CD工具无缝集成。

多环境统一管理

• 在开发、测试、UAT、生产等多环境中标准化OrgFlow工具版本和配置。
• 快速切换不同OrgFlow版本以适配特定环境需求。

临时环境快速部署

• 临时开发或审计场景下，无需本地安装即可快速启动OrgFlow。
• 培训或演示环境中，简化工具部署流程。

使用方法和配置说明

获取镜像

通过Docker Hub拉取最新版本镜像：

bash
docker pull orgflow/cli:latest

如需指定版本，可替换latest为具体版本号（如v1.2.3）：

bash
docker pull orgflow/cli:v1.2.3

基本使用示例

查看版本信息

验证镜像是否正常工作：

bash
docker run --rm orgflow/cli:latest orgflow --version

执行OrgFlow命令

基本命令格式：

bash
docker run --rm orgflow/cli:latest orgflow [command] [options]

关键操作示例

1. 认证Salesforce组织

OrgFlow需要认证Salesforce组织后才能执行操作。认证信息默认存储在~/.orgflow目录，需通过挂载本地目录持久化：

bash
# 挂载本地.orgflow目录到容器，执行Web认证
docker run --rm -v ~/.orgflow:/root/.orgflow orgflow/cli:latest orgflow auth:web

2. 拉取Salesforce元数据

将元数据拉取到本地工作目录，需挂载工作目录到容器：

bash
# 挂载当前目录作为工作区，拉取指定组织的元数据
docker run --rm -v ~/.orgflow:/root/.orgflow -v $(pwd):/workspace orgflow/cli:latest orgflow pull --org my-salesforce-org

3. 推送元数据到Salesforce组织

bash
# 推送当前工作区元数据到指定组织
docker run --rm -v ~/.orgflow:/root/.orgflow -v $(pwd):/workspace orgflow/cli:latest orgflow push --org my-salesforce-org

高级配置

环境变量

可通过-e参数传递环境变量，如设置日志级别：

bash
docker run --rm -e ORGFLOW_LOG_LEVEL=debug orgflow/cli:latest orgflow --version

Docker Compose集成

在docker-compose.yml中定义服务，便于复杂场景使用：

yaml
version: '3'
services:
  orgflow:
    image: orgflow/cli:latest
    volumes:
      - ~/.orgflow:/root/.orgflow
      - ./workspace:/workspace
    working_dir: /workspace
    # 可在此处定义默认命令或入口点

运行：

bash
docker-compose run orgflow orgflow pull --org my-salesforce-org

注意事项

• 持久化数据：.orgflow目录包含认证信息和配置，必须挂载以保留状态。
• 文件权限：挂载本地目录时需确保容器内用户（默认root）对挂载目录有读写权限。
• 版本兼容性：使用特定版本镜像时，需确保与目标Salesforce API版本兼容。
• 网络访问：执行auth:web等需要外部访问的命令时，容器需具备网络连接能力。