StarUML可以用作终端中的CLI(命令行界面)。使用CLI功能,您可以在不启动 StarUML GUI的情况下生成各种工件,包括源代码、文档(markdown、HTML等)、图表图像。因此,您可以在构建脚本中使用CLI根据您的软件模型自动生成工件。

创建别名

苹果系统

在终端中为 StarUML应用程序创建别名很有用,如下所示:

$ alias staruml='/Applications/StarUML.app/Contents/MacOS/StarUML'

Windows系统

您可以在 PowerShell中为 StarUML应用程序创建别名,如下所示:

PS> Set-Alias -Name staruml -Value 'C:\Program Files\StarUML\StarUML.exe'

Linux

在 Linux中,您不需要创建别名。如果您成功安装 StarUML,您可以 staruml在终端中运行,无需额外配置。

命令

您可以在CLI模式下使用四个命令。如果省略支持的命令,StarUML将以GUI模式启动。您可以通过键入help()选项来查看支持的命令类型。--help

$ staruml --help
$ staruml ejs --help    # help for ejs command
$ staruml image --help  # help for image command
$ staruml html --help   # help for html command
$ staruml pdf --help    # help for pdf command
$ staruml exec --help   # help for exec command

ejs

该ejs命令允许从用户的软件模型文件(.mdj)生成文本工件。您可以使用EJS(嵌入式 JavaScript模板)编写自己的模板。您可以在 https:/github.com/staruml/staruml-cli-examplest找到EJS的简单示例。

您可以使用以下CLI命令生成文本工件:

:要加载的模型文件(.mdj) option-t,--template:要应用的模板文件(ejs) option-o,--output:输出文件名(默认:output.txt) option-s,--select:查询以选择元素(默认值@Project:) 这是一个生成HTML文件的示例。
$ staruml ejs myproject.mdj \
  -t class-list.ejs \
  -o class-list.html
您可以使用 select选项生成多个文件,如下所示:
$ staruml ejs myproject.mdj \
  -t java-class.ejs \
  -s @UMLClass \
  -o "out/<%=filenamify(element.name)%>.java"
此命令选择所有类(UMLClass类型),myproject.mdj然后java-class.ejs为每个类应用模板并将其保存为具有.java类名称的文件。您可以在按查询检索元素部分获取有关查询表达式以选择元素的更多信息。 请注意,您还可以在输出选项中使用EJS模板语法。有时元素名称不能用作文件名(包括特殊字符,如/,!,#,?等)。 您可以使用filename()函数将字符串转换为输出选项中的合法文件名字符串,例如-o"out/<%=filenamify(element.name)%>.java". 在EJS模板字符串中(在.js文件或输出选项中),您可以使用以下变量: ·app:应用程序对象。 ·element:选择选项检索的元素。 ·filenamify:一个函数将字符串转换为合法的文件名字符串。(见https://github.com/sindresorhus/filenamify) ## 图片 该image命令允许您为图表生成图像文件: $ staruml image <文件><选项> 《file》:要加载的模型文件(.mdj) 选项option -o,-output:输出路径。(默认./htmL-docs:) 选项-s, ---select,查询已选择图表(默认值@Diagram:) 这是一个将所有图表导出为out文件夹中的PNG图像的示例:
$ staruml image myproject.mdj \
  -f png \
  -o "out/<%=filenamify(element.name)%>.png"
## html 该html命令允许您为模型文件生成HTML文档: ![](https://macjpeg.macsc.com/macw/pic/202205/16153051_b35a35650a.jpeg) ·<文件>:要加载的模型文件(.mdj) ·选项-o,--output:输出路径。(默认./html-docs:) 这是生成HTML文档的示例:
$ staruml html myproject.mdj
## pdf pdf命令允许您为图表生成PDF文档: ![](https://macjpeg.macsc.com/macw/pic/202205/16153202_56b62a47f0.jpeg) ·<文件>:要加载的模型文件(.mdj) ·option-o,-output:输出文件名。(默认 output.pdf:) ·选项-s,-select:查询以选择图表(默认值@Diagram:) ·选项-z,--sizE:页面大小。4A0、2A0、A0、A1、A2、A3、A4、A5、A6、A7、A8、A9、A10、B0、B1、B2、B3、B4、B5、B6、B7、B8、B9、B10之一,C0,C1,C2,C3,C4,C5,C6,C7,C8,C9,C10,RA0,RA1,RA2,RA3,RA4,SRA0,SRA1,SRA2,SRA3,SRA4,Executive,Folio,Legal,Letter,小报(默认:A4)。 ·选项-l,-layout:页面布局。landscape或 portrait。(默认 landscape:) ·option-n,--showname:在页面顶部显示图表名称。yes或no。(默认yes:) 这是一个生成包含所有图表的PDF文档(A3大小的肖像)的示例:
$ staruml pdf myproject.mdj \
  -o doc.pdf \
  -z A3 \
  -l portrait
## exec执行 exec命令允许您执行命令: ![](https://macjpeg.macsc.com/macw/pic/202205/16153444_90859d8a3f.jpeg) ·file文件:在执行命令之前要加载的模型文件(.mdj) ·选项-c,--command:命令ID。(例如 application:main-log) ·option-a,--arg:命令的参数 下面是一个执行命令的例子:
$ staruml exec myproject.mdj \
  --command application:main-log \
  --arg hello
以上就是StarUML教程:CLI(命令行界面)功能的使用的全部内容了,更多精彩教程关注Macw网站。

以上就是MacW小编为大家带来的“StarUML教程:CLI(命令行界面)功能的使用”,本文关键词:“StarUML教程,CLI,命令行界面”,链接:“https://www.macw.com/news/2468.html”,转载请保留。

相关文章