Scroll to navigation

GAPHOR(1) User Commands GAPHOR(1)

NAME

gaphor - Simple GUI UML and SysML modeling tool

SYNOPSIS

gaphor [-h] [-V] [COMMAND [OPTIONS] [ARGUMENTS...]]

DESCRIPTION

Gaphor is a simple yet powerful modeling tool for UML, SysML, RAAML and C4. It provides a graphical interface and a collection of command-line utilities. When no command is given, the GUI (gui) is started automatically. schema once with: gaphor install-schemas (as root if installing system-wide).

OPTIONS (global)

These options must appear before any command.

Show a help message and exit.
Print the version number and exit.

COMMANDS

Launch the graphical user interface.
Show the new model greeter dialog (no model file given).
Internal flag for GApplication activation.
One or more Gaphor model files to open.

Export diagrams from a model to files.
Replace spaces with underscores in output filenames.
Output directory (default: current directory).
Output format: pdf (default), svg, png, etc.
Only export diagrams whose qualified name matches the case-insensitive regex.

Generate an HTML report from a model.
Output directory for the report.

Execute a Python script inside the Gaphor environment (access to Gaphor API).
(No extra options beyond global logging flags.)

Install the GSettings schema needed for saving preferences.
Directory to install the XML schema file.
Path to the glib-compile-schemas tool.

Run Gaphor’s internal self-tests and exit.
Print version and exit (overrides test execution).

All commands accept the following common options directly after the command name:

Verbose logging.
Suppress informational messages, show warnings and errors only.
Run the command under Python's cProfile profiler.

FILES

~/.config/gaphor
Per-user configuration.

Upstream Documents

You can find the upstream documentation at https://docs.gaphor.org/en/latest.

BUGS

Report issues at https://github.com/gaphor/gaphor/issues.

AUTHORS

Arjan Molenaar and contributors. See https://gaphor.org.

COPYRIGHT

Apache License 2.0.

2026-05-08 Gaphor