Giter VIP home page Giter VIP logo

goseq's Introduction

goseq - text based sequence diagrams

A small command line utility used to generate UML sequence diagrams from a text-base definition file.

Inspired by js-sequence-diagram and websequencediagram.

Install

To install it:

go get github.com/lmika/goseq

To allow automatic generation of PNG files, build with the im tag (ImageMagick is required):

go get -tags im github.com/lmika/goseq

Usage

goseq [FLAGS] FILES ...

Supported flags:

  • -o filename: Specify output filename (either .svg or, if supported, .png)

Sequence Diagrams

goseq generates sequence diagrams from a text files which defines the participants and sequence of actions you want to represent:

Client->Server: Make request
Server->Database: Make database\nrequest
Database->Server: The result
Server->Client: The response

example

Sequence diagrams can also include things like blocks, notes and participant icons:

participant User (icon="human"): The User
participant Client
participant Server
participant Database (icon="cylinder")

User->Client: Clicks button
Client->Server: Make request
Server->Server: Check cache
alt: [response in cache]
    note over Server: Server only caches results\nfor 2 weeks.
    Server->Client: The cached response
else:
    Server->Database: Make database\nrequest
    Database->Server: The result
    Server->Client: The response
end

example2

For details and examples, please see the Language Guide.

Licence

Released under the MIT Licence.

goseq's People

Contributors

lmika-bom avatar lmika avatar hueypark avatar xperimental avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.