Name

fpm-deps - Create a fpm dependency graph in DOT language

Synopsis

fpm-deps [OPTION]…​

Description

The fpm-deps(1) command outputs the package dependency graph using the Graphviz DOT graph description language. Alternatively it can output the graph in format suitable for the Mermaid diagram-drawing tool.

Options

-o, --output OUTPUT

Output file. If not specified, the graph will be printed to standard output.

--manifest-path PATH

Path to the fpm.toml manifest file. In unspecified, fpm-deps(1) will look in the current directory.

--depth DEPTH

Maximum dependency DEPTH to display. For example a depth of 1 displays the direct dependencies.

*-x, --exclude LIST

A comma-separated list of packages to exclude from the graph. Either use quotes or make sure there are no spaces between elements of LIST.

--dpi DPI

Set the dots-per-inch for bitmap output, useful when piping to dot.

-M, --mermaid [FORMAT]

Output the graph as a Mermaid flowchart suitable for inclusion within Markdown document. The optional FORMAT can be either "md" (default) or "html", which will create a standalone HTML document.

--no-url

Do not add homepage URLs to the graph nodes.

--no-tooltip

Avoid adding package descriptions as tooltips. This is useful when converting the output to SVG or when using Mermaid output.

--rankdir RANKDIR

Set the direction of the graph layout. Supported values: TB (Top-Bottom), BT (Bottom-Top), LR (Left-Right), RL (Right-Left). The default is TB.

--version

Print the version number

-h, --help

Print a help message.

Exit status

Exits with 0 on success, and >0 if an error occurs.

EXAMPLES

Generate the dependency graph and produce a PNG image:

$ fpm-deps --dpi 96 | dot -Tpng -ograph.png

Generate the dependency graph and produce a SVG image:

$ fpm-deps | dot -Tsvg -ograph.svg

Write the graph in DOT language to a file:

$ fpm-deps -o graph.gv

Produce a Mermaid graph printed to standard output:

$ fpm-deps --mermaid

REPORTING BUGS

Please report any bugs or other comments/wishes by opening a new issue at: https://github.com/ivan-pi/fpm-deps

SEE ALSO

dot(1), mermaid(1)