dsl
kroki
dsl | kroki | |
---|---|---|
12 | 49 | |
1,398 | 2,680 | |
- | 4.7% | |
0.0 | 8.7 | |
4 months ago | 4 days ago | |
Java | JavaScript | |
Apache License 2.0 | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
dsl
-
D2 is now open source – a new, modern language that turns text to diagrams
1. not currently, but it's on the roadmap!
2. with any integration, if there's enough demand, we'll do it. Once we add interactivity to diagrams, it should be trivial to emulate. However I should mention that Simon Brown (the creator of C4) has his own DSL for C4 https://github.com/structurizr/dsl)! We have no intention of competing with it.
3. Currently the options to tune are limited. The Terrastruct app has granular layout control via drag-and-drop, and we're working to bring some of that to native/open-source.
-
How is your time spent in the architecture role?
It's really just an evolution of the original Structurizr for Java library that I built 5+ years ago. Some people really liked the ability to create a model+views using a programming language (ports are now available for .NET, PHP, Python, TypeScript, etc), but many thought it was silly. So I've always wanted to do something "text-based", but I wanted to do "models as code" rather than "diagrams as code". The lockdown in 2020 gave me some time to do this, and the DSL is really just a thin wrapper on that original Java library. Being a wrapper for the Java library provides a way for you to create parts of your model via scripts (Groovy, Kotlin, JRuby) or by mixing the DSL and code. This creates opportunities for manually defining a high level model, and then perhaps inserting a deployment architecture that's automatically generated by parsing AWS/Azure/Terrform/etc.
-
Structurizr – Diagrams as Code
Some helpful URLs, IMHO
https://structurizr.com/dsl?example=amazon-web-services (hover over the diagram and press the play icon to trigger the "animation" referenced in the DSL)
https://structurizr.com/products as for "which parts are free vs paid"
https://github.com/structurizr/dsl#readme (one of several repos, but unclear which is the "main one") they all seem to be Apache 2 licensed
---
I'm just serving as lazyweb bot, I haven't used this product(service?) before
-
Architecture as Code with C4 and Plantuml
Thanks for structurizr DSL. I'm a big fan of C4 and plantUML. I'll definitely have a look at https://github.com/structurizr/dsl.
-
Diagrams as Code 2.0
Structurizr DSL - https://github.com/structurizr/dsl
-
Software to build a visual representation of the solution?
The C4 model and the Structurizr DSL (demo) are pretty much designed to do exactly this. Disclaimer: I'm the author of both.
-
Reading up on C4 Model...how would you document related systems and repos without repeating yourself?
Create a system landscape, plus a drill-down for each system. In this option you create a new repo in which you define your system landscape - i.e. all of the people and software systems, plus their interactions. In the system1 repo, you extend this model to add the internal details, diagrams, and docs specifically for system1. Repeat for system2 and system3. With this approach, you would see that system1 (and system1.serviceX) interacts with system2, but you wouldn't see system2.serviceY, since that's an implementation detail of, and internal to, system2. The Structurizr DSL has been designed to work for this use case with the "workspace extension" feature, see https://github.com/structurizr/dsl/tree/master/docs/cookbook/workspace-extension for more details.
-
A visual C4 model tool for your team
This (icepanel.io) is just a graphical editor for C4 Model diagrams.
The actual standard (if you can call it that, because it is quite light weight, and that is a good thing) is open source as far as I know.
This means that you can create C4 diagrams with PlantUML [0] or using the C4 specific DSL [1].
[0] - https://github.com/plantuml-stdlib/C4-PlantUML
[1] - https://github.com/structurizr/dsl
-
Alternatives to c4 model?
With this in mind, the Structurizr DSL provides a way to create a model as code, which can then be rendered using tooling of your choice. The Structurizr renderer is one option, but there are others, and you can build your own to meet the style that you're looking for. See structurizr.org - Rendering tools for more.
-
Scripting support added to the Structurizr DSL
The Structurizr DSL now provides a way to run scripts written in Groovy, Kotlin, Ruby, and JavaScript, via the new !script keyword. This gives you access to the underlying Structurizr for Java workspace, for when you need to do something not supported by the DSL.
kroki
-
WireViz: Easily document cables and wiring harnesses
Your wish showing up in the face of a submission just 14 days ago and then another 29 days ago must be indicative of why there are so many dupes all the time: https://news.ycombinator.com/from?site=kroki.io
You can feel free to submit the GH repo, as that one doesn't seem to have been submitted before https://github.com/yuzutech/kroki
-
D2 Playground
Pikchr https://pikchr.org/home/pikchrshow is the other general purpose one and older than d2. It is "Source-Code License: 0-clause BSD" as it says on the page.
Someone made it into wasm and put playground for pikchr here https://www.jakethaw.com/pikchr_webassembly_demo/
Can also try pikchr online here on https://kroki.io/#try which is hosting many other text to diagram tools as well.
-
Mermaid Chart, a Markdown-like tool for creating diagrams, raises $7.5M
I use mermaid.js heavily, but plug for Kroki:
https://kroki.io/
“Kroki provides a unified API with support for BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag), BPMN, Bytefield, C4 (with PlantUML), D2, DBML, Ditaa, Erd, Excalidraw, GraphViz, Mermaid, Nomnoml, Pikchr, PlantUML, Structurizr, SvgBob, Symbolator, TikZ, UMLet, Vega, Vega-Lite, WaveDrom, WireViz... and more to come!”
- Kroki: A unified API to create any kind of diagram from text
- Kroki – Creates diagrams from textual descriptions
- How to draw beautiful software architecture diagrams
-
Nomnoml
If you don't mind my asking, what aspects of "acceptable layout" is usually the first to get busted?
I'm extremely excited about using WireViz[1] to automate wiring harness diagram creation, and if I can, I'd like to know the speedbumps before I hit them. I'm thinkin generous linking between diagrams will be one path.
[1] Project:: https://github.com/wireviz/WireViz SandboxP:: https://kroki.io/#try [select Diagram>WireViz]
-
LaTeX for publishing tabletop role-playing games
The SVG output is embedded into the PDF file.
https://kroki.io/examples.html#mind-map
Kroki has other text-based formats for flow charts, Gantt charts, UML diagrams, packet diagrams, network diagrams, word clouds, etc.
-
Documentation as Code for Cloud Using PlantUML
My cross-platform desktop text editor, KeenWrite, allows users to define variables in an external YAML file. The editor calls out to Kroki[1] to convert text-based diagrams to SVG. The diagrams can reference variables and are rendered using EchoSVG[2].
KeenWrite[3] can produce PDF documentation from Markdown documents that has PlantUML diagrams with elements stored in an external, machine-readable file. Here are screenshots showing variables on the left, diagram text in the middle, and a real-time render on the right:
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
* https://raw.githubusercontent.com/DaveJarvis/KeenWrite/main/...
KeenWrite supports all diagrams offered by Kroki, which includes "diagram-plantuml".
[1]: https://kroki.io/
[2]: https://github.com/css4j/echosvg/
[3]: https://github.com/DaveJarvis/keenwrite
- Pikchr: A PIC-like markup language for diagrams in technical documentation
What are some alternatives?
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
Mermaid - Edit, preview and share mermaid charts/diagrams. New implementation of the live editor.
kubernetes-client - Java client for Kubernetes & OpenShift
plantuml-syntax - vim syntax file for plantuml
cli - A command line utility for Structurizr.
plantuml - Generate diagrams from textual description
java - Structurizr for Java
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
c4model-visio-stencil - Visio stencil with C4 Model shapes
venn.nvim - Draw ASCII diagrams in Neovim
zerocode - A community-developed, free, opensource, automated testing framework for microservices APIs, Kafka(Data Streams) and Load testing. Zerocode Open Source enables you to create, change and maintain your automated test scenarios via simple JSON or YAML files. Visit documentation below:
Zettlr - Your One-Stop Publication Workbench