anzbank/sysl

Sysl Docker 镜像文档

1. 镜像概述与主要用途

Sysl（发音为 "sizzle"）是一种系统规范语言，用于定义系统架构、端点行为、数据模型及数据转换规则。本 Docker 镜像封装了 Sysl 工具链，提供开箱即用的 Sysl 编译器及相关工具，支持从统一的 Sysl 规范自动生成架构视图、集成文档及代码，简化系统设计与规范管理流程。

2. 核心功能与特性

2.1 系统规范定义

• 支持定义系统、端点、端点行为及交互逻辑
• 可描述数据模型结构及数据转换规则

2.2 自动生成能力

• 自动生成序列图、系统集成视图等架构文档
• 基于规范生成多类型输出（如文本、图表）

2.3 多工具集成

• 包含 sysl 命令行工具（核心编译器）
• 包含 reljam 命令行工具（模型处理工具）

3. 使用场景与适用范围

• 系统设计与架构文档：统一描述系统组件及交互，自动生成可视化视图
• API 规范管理：定义端点接口及数据模型，作为团队协作的单一可信源
• 自动化工作流：集成到 CI/CD 流程，实现规范验证、文档自动更新
• 团队协作：通过标准化规范语言，简化跨团队的系统集成沟通

4. 使用方法与配置说明

4.1 拉取镜像

bash
docker pull anzbank/sysl

4.2 镜像标签（可选，简化命令）

为镜像添加本地标签，缩短后续命令：

bash
docker tag anzbank/sysl sysl

4.3 基本命令使用

4.3.1 查看工具帮助

bash
# 查看 sysl 命令帮助
docker run sysl sysl -h

# 查看 reljam 命令帮助
docker run sysl reljam -h

4.3.2 运行默认命令

直接运行镜像可查看基础信息：

bash
docker run sysl

4.4 使用示例文件

通过镜像内置的示例文件（来自 https://github.com/anz-bank/sysl/tree/master/demo%EF%BC%89%E6%BC%94%E7%A4%BA%E5%8A%9F%E8%83%BD%EF%BC%9A

4.4.1 生成文本输出

将 petshop 示例规范转换为文本格式并输出到指定路径：

bash
docker run -v $(pwd):/out sysl sysl textpb -o /out/petshop.txt /demo/petshop/petshop

说明：-v $(pwd):/out 挂载本地目录到容器内 /out，-o /out/petshop.txt 指定输出文件路径。

4.4.2 生成模型

使用 reljam 工具处理示例规范并生成模型：

bash
docker run sysl reljam model /demo/petshop/petshop PetShopModel

5. Docker 部署示例

5.1 基本命令模板

bash
docker run [OPTIONS] sysl [COMMAND] [ARGUMENTS]

• OPTIONS：如 -v（挂载目录）、-w（工作目录）等 Docker 运行参数
• COMMAND：指定工具命令（如 sysl、reljam）
• ARGUMENTS：工具命令的参数（如输入文件路径、输出选项）

6. 相关资源

• Dockerfile 源码：https://github.com/anz-bank/sysl/blob/master/Dockerfile
• Sysl 官方仓库：https://github.com/anz-bank/sysl