spograph

command module
v1.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 11, 2024 License: MIT Imports: 2 Imported by: 0

README

spograph

spograph is a tool for generating business architecture diagram based on the Go development framework Sponge.

Quick Start

Install spograph
go install github.com/go-dev-frame/spograph@latest
Example of Use

Open a project created with Sponge, for example: eshop/example-2-mono-repo

# Case 1: Generate a business architecture diagram for the entire project
spograph --project-dir=example-2-mono-repo

# Case 2: Generate a business architecture diagram for specific services
spograph --server-dir=example-2-mono-repo/flashSale --server-dir=example-2-mono-repo/order

# To include database services in the diagram, add the "--all" parameter

Output svg example:

example-2-mono-repo

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
pkg
conf
Package conf is parsing yaml, json, toml configuration files to go struct.
Package conf is parsing yaml, json, toml configuration files to go struct.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL