Skip to content

Installation

CLI Tool

Install the system-spec CLI:

go install github.com/plexusone/system-spec/cmd/system-spec@latest

Verify installation:

system-spec help

Go SDK

Add to your Go module:

go get github.com/plexusone/system-spec@latest

Import packages:

import (
    "github.com/plexusone/system-spec/spec"
    "github.com/plexusone/system-spec/graph"
    "github.com/plexusone/system-spec/render"
)

Requirements

  • Go 1.24 or later
  • For rendering: D2, Mermaid CLI, or GraphViz (optional, for image generation)

Rendering Dependencies

To render diagrams to images (optional):

# macOS
brew install d2

# Linux
curl -fsSL https://d2lang.com/install.sh | sh

npm install -g @mermaid-js/mermaid-cli

# macOS
brew install graphviz

# Ubuntu/Debian
apt-get install graphviz