structiagram

Crates.iostructiagram
lib.rsstructiagram
version0.1.3
sourcesrc
created_at2022-04-22 09:59:40.817924
updated_at2023-01-31 04:41:37.083372
descriptionStructiagram is a tool to generate Rust struct relation diagram as mermaid.js format.
homepage
repositoryhttps://github.com/ymgyt/structiagram
max_upload_size
id572083
size50,223
Yuta Yamaguchi (ymgyt)

documentation

README

Structiagram

Structiagram is a tool to generate Rust struct relation diagram as mermaid.js format.

Installation


Cargo Installation

Install structiagram as a CLI executable using cargo

cargo install structiagram

Usage


Run structiagram --help for the structiagram CLI parameter usage.

$ 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

Example usage of generating a diagram

structiagram --dir src

Example usage of generating a diagram and saving the output to a markdown file

structiagram --dir src --output project_diagram.md

🪪 License


This project is available under the terms of either the Apache 2.0 license or the MIT license.

Commit count: 26

cargo fmt