#diagram #js #mermaid #generate #struct #relation #cli

app structiagram

Structiagram 是一个用于生成 Rust 结构关系图的工具,格式为 mermaid.js

4 个版本

0.1.3 2023年1月31日
0.1.2 2022年4月30日
0.1.1 2022年4月23日
0.1.0 2022年4月22日

#10#mermaid

MIT/Apache

19KB
397

Structiagram

Structiagram 是一个用于生成 Rust 结构关系图的工具,格式为 mermaid.js

安装


Cargo 安装

使用 cargostructiagram 安装为 CLI 可执行文件。

cargo install structiagram

用法


运行 structiagram --help 查看structiagram CLI 参数的用法。

$ structiagram --help
structiagram 0.1.2

USAGE:
structiagram [OPTIONS] --dir <DIR>

OPTIONS:
--dir <DIR> Root directory to parse files
-h, --help Print help information
-o, --output <OUTPUT> Output file. default stdout. The '-' is interpreted as stdout
-V, --version Print version information

生成图的示例用法

structiagram --dir src

生成图并保存输出到 markdown 文件的示例用法

structiagram --dir src --output project_diagram.md

🪪 许可证


本项目可在 Apache 2.0 许可证或 MIT 许可证的条款下使用。

依赖

~5–17MB
~197K SLoC