Table of Contents
crystal-facet-uml creates diagrams to document system and software architecture.
Like a crystal shows different facets of the same thing, this application shows different views of the same system/software.
![]() |
As software architect, you create a set of diagrams describing use-cases, requirements, structural views, behavioral and deployment views.
These views show selected elements and their relationships. crystal-facet-uml keeps element names and element hierarchies consistent.
This tool runs on your local PC. It stores the model data in a json-based file which can be stored in git, branched and merged together with your source code. crystal-facet-uml exports diagrams in svg, pdf, ps and png formats which can be used in text processing systems like DocBook, html, LaTeX.
crystal-facet-uml provides a graphical user interface to
create, modify and delete diagrams,
create, modify and delete UML/SysML elements,
create, modify and delete relationships,
cut, copy, paste elements between diagrams,
undo and redo are supported,
multiple windows can show different or same parts of the uml model,
search for elements.
Diagrams are layouted part-automatically:
The user chooses the relative location of elements towards others,
crystal-facet-uml selects the exact locations of shown elements.
The user controls the positions of messages/transitions in sequence and timing diagrams,
crystal-facet-uml auto-layouts relationships in other diagrams.
crystal-facet-uml manages a meta model:
Diagrams are organized as a tree, similar to a book's table-of-contents;
Uml(TM)/SysML(TM) elements exist only once even if shown in many diagrams;
Relationships and features are consistent between all diagrams;
Diagram-local messages/transitions are supported in scenario-based interaction diagrams: sequence, communication, timing, interaction overview.
These extension mechanisms of UML are supported: Tagged values and stereotypes including stereotype images.
Diagrams can be exported as
images: pdf, ps, svg, png,
text: utf-8, DocBook, html,
machine-readable model: json, xmi(TM).
crystal-facet-uml can also be started from command line
to export all diagrams automatically or
to import a previously exported json file or
to check and repair database files.
crystal-facet-uml can be started in graphical mode (see the section called “Graphical User Interface”) or from command line (see the section called “Command Line Interface”).