Getting started

Overview

Terrastruct is a tool to create programmable diagrams for visualizing software systems. We bring together data powering your organization, and let you create dynamic diagrams that respond to the real-time changes in that data. Instead of an unchanging snapshot, Terrastruct diagrams visualize the live state of your software system.

Everyone loves a good diagram, and diagrams are essential when looking for documentation. But with the current tools, it's hard to create good diagrams of software architecture. General-purpose diagramming tools try to fit every size -- whether you're in marketing, HR, or engineering. The problem is that engineering diagrams are orders of magnitude more complex. You're forced to map out this layered mental model you have in your head onto a one-dimensional image, and it just doesn't work. It's like using Microsoft word to write code.

Good documentation is a productivity multiplier. The majority of an engineer's time is spent building up mental models, and only a tiny fraction to write the code. Our mission is to perfect the tooling around planning and documenting software design for teams so that you can ship faster and build more robust software.

Start here

  • If you'd like a detailed walkthrough of basic diagramming functionality, continue onwards.
  • To skip to what makes us unique, check out

πŸ“ Help us improve our documentation

This guide will help you get jumpstarted with using Terrastruct. If you find any mistakes or have any suggestions while using it, please use the Suggested Edits feature on the top right corner of every page to let us know! It's like GitHub Pull Requests, but for this guide.


What’s Next

Let's get to know the basics of Terrastruct and start creating your first diagram