Back
Quick Start

Up and running in
30 seconds

Clone, install, and build your first architecture in under a minute. No complex setup, no magic — just a deterministic monorepo that enforces its own boundaries.

Prerequisites

Node.js
v18+ (LTS recommended)
Yarn 4 (Berry)
Enabled via corepack
Git
v2.30+
TypeScript
v5.0+ (installed automatically)
1

Clone the repository

$ git clone git@github.com:martinkrakowski/hexagen-monaco.git
✓ Cloned hexagen-monaco

Requires SSH access to GitHub. Alternatively use HTTPS: git clone https://github.com/martinkrakowski/hexagen-monaco.git

2

Install dependencies

$ cd hexagen-monaco
$ corepack enable && yarn install
✓ Dependencies installed

Corepack ensures the correct Yarn version (Berry / v4) is used automatically.

3

Build the monorepo

$ yarn build
⚡ Building monorepo...
✓ 27 packages compiled

Turborepo parallelizes builds across all 27 packages. First build may take a minute; subsequent builds are incremental.

4

Sync architecture artifacts

$ yarn sync
⚡ Generating architecture artifacts...
✓ Manifest validated — 0 constraint violations
✓ Generated hexagonal boilerplate across all modules

The sync engine reads your manifest and generates the corresponding hexagonal boilerplate. Use --dry-run to preview changes.

5

Enforce architecture boundaries

$ yarn lint:arch
✓ Architecture boundaries enforced
$

Runs ESLint boundary rules and AST-based invariant checks. Add to CI to prevent drift before merge.

All-in-one

Copy and paste the full sequence in one go:

terminal
$ git clone git@github.com:martinkrakowski/hexagen-monaco.git
✓ Cloned hexagen-monaco
$ cd hexagen-monaco
$ corepack enable && yarn install
✓ Dependencies installed
$ yarn build
⚡ Building monorepo...
✓ 27 packages compiled
$ yarn sync
⚡ Generating architecture artifacts...
✓ Manifest validated — 0 constraint violations
✓ Generated hexagonal boilerplate across all modules
$ yarn lint:arch
✓ Architecture boundaries enforced
$

Next Steps

Read the docs

Explore the manifest schema, sync engine options, and governance rules in the official documentation.

Launch the Web UI

Open the interactive architecture canvas with Monaco Editor to visually edit your manifest and inspect dependency graphs.

Try the TUI

Run the terminal dashboard for a keyboard-driven workflow with violation inspection and AI-assisted refactoring.

Customize your manifest

Edit .architecture/manifest.yaml to define your own bounded contexts, ports, and layer rules — then re-run yarn sync.

Ready to compile your architecture?