GSL – I wanted to describe the architecture, not just draw it

Hacker News

Share card

GSL – I wanted to describe the architecture, not just draw it

I built GSL because I got fed up of building architecture diagrams that couldn't quite capture all of the nuance of the real world. I liked the idea of using a system like Mermaid or PlantUML to represent my systems but there was never really a satisfactory way of describing what was happening. I liked the easy-to-follow syntax of those diagramming tools but they very quickly ran into limitations. When you describe an API gateway component, you can't really say that it belongs in a specific region but also that it belonged in a certain zone of the architecture or which team owns it. And when I described what systems interacted with each other I only had the ability to use a text field to describe all of the metadata about the relationship. Is it HTTPS vs an async lambda invocation? What auth do we need? Something else I wanted was the ability to query the architecture. Surely when you have the full graph of what talks to what, you should be able to pose questions like: * "which customer actions trigger a call to vendor X's API?" * "what will be affected if database Y goes down?" I couldn't really find anything that did that in a way that felt natural. Diagramming tools were either completely visual or too presentation focussed to express what I wanted. Existing graph languages felt too clunky or cumbersome. I struggled to find any that worked with sets and querying in a way that felt right. So one rainy afternoon, I decided to see how far I could get with ChatGPT and some ideas - GSL was born! In the repo there is: * A specification for GSL, a language for defining directed graphs with nodes and edges along with set annotations to declare cross-cutting relationships * A specification for GQL, the companion query language * gsl-query - a CLI tool for executing queries on your GSL models * gsl-diagram - a very primitive tool for turning GSL into Mermaid or PlantUML diagrams * A small VS Code plugin for syntax highlighting * Guides, tutorials, documentation * Rich examples (including some non-tech oriented ones) I think GSL has turned into the language that I was looking for at the beginning of the year. I'm starting to use it in my day job. The guides and documentation have been written to make it easier for agents and LLMs to use and my casual use so far has shown some promise. It's still very much an experiment but I'd like to get other people to take a look and see if it's useful for them too. Have I even made the right assumptions and picked the right abstractions? Have you tried to do something like this yourself? You can begin with the "Getting Started" guide, the specs, or just jump right in to the flagship examples. "Example #3: Architecture Across Boundaries" is fairly close to what I wanted to do originally. https://github.com/dnnrly/gsl-lang