Skip to content

lonely-lockley/archinsight

Repository files navigation

Archinsight

Archinsight implements an architecture-as-code approach, following the principles based on the C4 model. Its core feature is the Insight language, which simplifies architectural descriptions and frees architects from excessive visualization details. Insight emphasizes clarity, conciseness, and simplicity tailored to C4 diagrams.


Try It Out

Explore the Insight language and Archinsight features in the Playground. Here, you can:

  • Experiment with Insight’s syntax;
  • See real-time visualizations;
  • Discover the interactive diagram capabilities.

Building the Project

To build Archinsight from source, you need:

  • JDK 20
  • Docker

Run the command:

./gradlew clean dockerBuild

This will:

  • Compile all components;
  • Package them into Docker images;
  • Store those images in your local Docker repository.

Documentation

Find more detailed information about Archinsight and its setup here:

  • Insight Language
    A comprehensive description of the Insight syntax with usage examples.
  • Installation Guide
    Instructions on how to install and deploy Archinsight using Docker.
  • Developer Guide
    Insights for contributors interested in helping develop and improve Archinsight.

Builds

Official Docker images are available on Docker Hub.


License

Archinsight – C4 architecture as code
Copyright (C) 2022-2025 Alexey Zaytsev [email protected]

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see http://www.gnu.org/licenses/.

About

Simplicity in Code, Power in Design

Resources

License

Stars

Watchers

Forks

Contributors