staruml
in Terminal without additional configuration.--help
) option.ejs
command allow to generate textual artifacts from a user's software model file (.mdj). You can write your own templates with EJS (Embedded JavaScript templating). You can find simple examples for EJS at https://github.com/staruml/staruml-cli-examples.<file>
: A model file (.mdj) to load-t
, --template
: A template file (.ejs) to apply-o
, --output
: output file name (default: output.txt
)-s
, --select
: query to select elements (default: @Project
)myproject.mdj
and then apply the java-class.ejs
template for each class and save it as a .java
file with the name of the class. You can get more information about the query expression to select elements at the retrieving elements by query section./
, !
, #
, ?
, etc.). You can use filename()
function to convert a string to a legal filename string in output option like -o "out/<%=filenamify(element.name)%>.java"
.element
: The element retrieved by the select option.filenamify
: A function convert a string to a legal filename string. (See https://github.com/sindresorhus/filenamify)image
command allows you can generate image files for diagrams:<file>
: A model file (.mdj) to load-f
, --format
: image file format. One of png
, jpeg
, or svg
. (default: png
)-o
, --output
: output file name.-s
, --select
: query to select diagrams (default: @Diagram
)out
folder:html
command allows you can generate HTML docs for the model file:<file>
: A model file (.mdj) to load-o
, --output
: output path. (default: ./html-docs
)<file>
: A model file (.mdj) to load-o
, --output
: output file name. (default: output.pdf
)-s
, --select
: query to select diagrams (default: @Diagram
)-z
, --size
: page size. One of 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, Tabloid (default: A4
).-l
, --layout
: page layout. landscape
or portrait
. (default: landscape
)-n
, --showname
: Show diagram name on page top. yes
or no
. (default: yes
)<file>
: A model file (.mdj) to load before executing a command-c
, --command
: command id. (e.g. application:main-log
)-a
, --arg
: argument for the command