archsight 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37f0d691fd1bdc0ce5b3a250c6bf0dc269b2586682ab1c46c25546cfa8d9c251
-  data.tar.gz: 56069d4dbdc04607c00c51af729433f63792ffbca81e79d785d5a0d1cfe75b25
+  metadata.gz: 750620aa30b68f0a3cfa0f53be2d717ae0496b829e5ecc588a904b3bf39dbd10
+  data.tar.gz: 8ddf46b557c7830212d0e699149ce2b53b9476c7748fc90c82480f22be226047
 SHA512:
-  metadata.gz: 4e1bc599625fc4ed0d7b16a9a9fd61d420faa4e58186e4ff6ebd6a15ca2ff05e44c1fa88164d45f45acfcd01d09d676d09bd90b57b31fcba30961d823212089e
-  data.tar.gz: 820b19c2650828976882d746fffa9674ebd7da9c418dcb663096c3cfdaf366aeecd4cb11fcd241b14c400f5d80adf21243774b45de6c6a6137736e832591dda0
+  metadata.gz: 39b0cc9b3b321c1e2627197a8f2edb13bdb8fe78273e315b70c886d05d64da534769850f5991e70d6c38d549f7229988d3d2e03bbd075f01e9aad0b4b4aad802
+  data.tar.gz: 69c4784e97d7c2aa01bf1030109a621f1eacdf4d7fe131d2e7c56eb29b42524ed3a68c69f97003ef804a7e38cedf118dc186157a948e5c81479191927955fa94

data/Dockerfile

@@ -1,11 +1,14 @@
 # Build stage
 FROM ruby:4.0-alpine3.23 AS builder
 
-RUN apk add --no-cache build-base git libffi-dev yaml-dev
+RUN apk add --no-cache build-base git libffi-dev yaml-dev nodejs npm
 
 WORKDIR /app
 COPY . .
 
+# Build frontend assets
+RUN cd frontend && npm ci && npm run build
+
 # Build and install the gem
 RUN gem build archsight.gemspec && \
     gem install --no-document archsight-*.gem
@@ -13,8 +16,6 @@ RUN gem build archsight.gemspec && \
 # Runtime stage
 FROM ruby:4.0-alpine3.23
 
-RUN apk add --no-cache graphviz
-
 # Copy installed gems from builder (including default gems that were updated)
 COPY --from=builder /usr/local/bundle /usr/local/bundle
 COPY --from=builder /usr/local/lib/ruby/gems /usr/local/lib/ruby/gems
@@ -35,4 +36,4 @@ HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
     CMD wget --no-verbose --tries=1 --spider http://localhost:4567/ || exit 1
 
 ENTRYPOINT ["archsight"]
-CMD ["web", "--port", "4567"]
+CMD ["web", "--port", "4567", "--host", "0.0.0.0"]

data/README.md

@@ -7,6 +7,10 @@
 
 Ruby gem for visualizing and managing enterprise architecture documentation using YAML resources with GraphViz visualization. Inspired by ArchiMate 3.2.
 
+| Service view | Artifact view |
+|:---:|:---:|
+| ![Service detail with graph and relations](media/service.jpg) | ![Artifact detail with metadata](media/artifact.jpg) |
+
 ## Installation
 
 Add to your Gemfile:
@@ -21,16 +25,8 @@ Or install directly:
 gem install archsight
 ```
 
-### Option 2: Helm (Kubernetes)
-
-```bash
-helm install archsight oci://ghcr.io/ionos-cloud/archsight/charts/archsight
-```
-
 ## Quick Start
 
-### Option 1: CLI
-
 ```bash
 # Start web server (looks for resources in current directory)
 archsight web
@@ -44,29 +40,7 @@ ARCHSIGHT_RESOURCES_DIR=/path/to/resources archsight web
 
 Access at: <http://localhost:4567>
 
-### Option 2: Docker
-
-```bash
-# Run web server (default)
-docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight
-
-# Run in production mode with logging
-docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight web --production
-
-# Run lint
-docker run -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight lint -r /resources
-
-# Run any command
-docker run ghcr.io/ionos-cloud/archsight version
-```
-
-Access web interface at: <http://localhost:4567>
-
-**Notes:**
-
-- Volume mount `-v "/path/to/resources:/resources"` mounts your resources directory
-- Default command starts the web server on port 4567
-- Pass subcommands directly (lint, version, console, template)
+Also available as [Docker](docs/docker.md) image and [Helm chart](docs/kubernetes.md).
 
 ## CLI Commands
 
@@ -85,6 +59,7 @@ archsight version            # Show version
 ```bash
 archsight web [--resources PATH] [--port PORT] [--host HOST]
               [--production] [--disable-reload] [--enable-logging]
+              [--inline-edit]
 ```
 
 | Option | Description |
@@ -95,6 +70,7 @@ archsight web [--resources PATH] [--port PORT] [--host HOST]
 | `--production` | Run in production mode (quiet startup) |
 | `--disable-reload` | Disable the reload button in the UI |
 | `--enable-logging` | Enable request logging (default: false in dev, true in prod) |
+| `--inline-edit` | Enable inline editing to save directly to source files |
 
 ## Features
 
@@ -125,7 +101,7 @@ claude mcp add --transport sse ionos-architecture http://localhost:4567/mcp/sse
 **Browse & Search:**
 
 - Browse resources by type (Products, Services, Components, Requirements, etc.)
-- Search by name or tag using the [query language](lib/archsight/web/doc/search.md)
+- Search by name or tag using the [query language](docs/search.md)
 - Filter by annotations (quality attributes, status, frameworks)
 
 **Visualization:**
@@ -183,42 +159,18 @@ Detailed documentation is available in the web interface under the Help menu:
 
 | Guide | Description |
 |-------|-------------|
-| [Modeling Guide](lib/archsight/web/doc/modeling.md) | How to model architecture using resource types and relations |
-| [Query Language](lib/archsight/web/doc/search.md) | Full query syntax reference for searching resources |
-| [Computed Annotations](lib/archsight/web/doc/computed_annotations.md) | Aggregating values across relations |
-| [ArchiMate Reference](lib/archsight/web/doc/archimate.md) | ArchiMate concepts and mapping |
-| [TOGAF Reference](lib/archsight/web/doc/togaf.md) | TOGAF alignment and concepts |
+| [Modeling Guide](docs/modeling.md) | How to model architecture using resource types and relations |
+| [Query Language](docs/search.md) | Full query syntax reference for searching resources |
+| [Computed Annotations](docs/computed_annotations.md) | Aggregating values across relations |
+| [ArchiMate Reference](docs/archimate.md) | ArchiMate concepts and mapping |
+| [TOGAF Reference](docs/togaf.md) | TOGAF alignment and concepts |
+| [Architecture](docs/architecture.md) | Technology stack and directory structure |
+| [Docker](docs/docker.md) | Running Archsight in Docker |
+| [Kubernetes](docs/kubernetes.md) | Helm chart deployment guide |
 
 ## Architecture
 
-### Technology Stack
-
-- **Web Framework**: Sinatra
-- **Templating**: Haml
-- **Styling**: Pico CSS v2.x
-- **Interactivity**: HTMX
-- **Icons**: Iconoir (1,671+ icons)
-- **Visualization**: GraphViz (@hpcc-js/wasm for client-side SVG)
-
-### Directory Structure
-
-```text
-archsight/
-├── exe/archsight              # CLI executable
-├── lib/
-│   ├── archsight.rb           # Entry point
-│   └── archsight/
-│       ├── cli.rb             # Thor CLI
-│       ├── configuration.rb   # Resources path config
-│       ├── database.rb        # YAML loader and validator
-│       ├── query/             # Query language (lexer, parser, evaluator)
-│       ├── resources/         # Resource types (20+)
-│       ├── annotations/       # Annotation modules
-│       ├── mcp/               # MCP server tools
-│       └── web/               # Sinatra app, views, assets
-│           └── doc/           # Documentation (markdown)
-└── test/                      # Test suite
-```
+See [Architecture](docs/architecture.md) for the technology stack and directory structure.
 
 ## Contributing
 

data/chart/archsight/README.md

@@ -1,160 +1,3 @@
 # Archsight Helm Chart
 
-A Helm chart for deploying [Archsight](https://github.com/ionos-cloud/archsight) on Kubernetes.
-
-## Introduction
-
-This chart bootstraps an Archsight deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. It is designed to be flexible in how you provide the architecture "resources" (YAML files) to the application.
-
-## Prerequisites
-
-- Kubernetes 1.19+
-- Helm 3.2.0+
-
-## Installing the Chart
-
-### From OCI Registry (Recommended)
-
-To install the chart from the GitHub Container Registry:
-
-```bash
-helm install my-archsight oci://ghcr.io/ionos-cloud/archsight/charts/archsight
-```
-
-### From Local Source
-
-To install the chart with the release name `my-archsight` from local source:
-
-```bash
-helm install my-archsight ./chart/archsight
-```
-
-## Configuration
-
-The following table lists the configurable parameters of the Archsight chart and their default values.
-
-| Parameter | Description | Default |
-|-----------|-------------|---------|
-| `image.repository` | Docker image repository | `archsight` |
-| `image.tag` | Docker image tag | `""` (uses appVersion) |
-| `service.type` | Kubernetes Service type | `ClusterIP` |
-| `service.port` | Service port | `80` |
-| `ingress.enabled` | Enable Ingress resource | `false` |
-| `app.resourcesDir` | Directory where app looks for resources | `/resources` |
-
-### Resource Management Strategies
-
-The most important configuration is how you provide your architecture YAML files to the application. This is controlled by the `content.type` parameter.
-
-#### 1. ConfigMap (Simple / Static)
-Best for small deployments where the architecture definitions rarely change or are small enough to fit in a ConfigMap (1MB limit).
-
-```yaml
-content:
-  type: configMap
-  configMap:
-    create: true
-    data:
-      analysis.yaml: |
-        apiVersion: architecture/v1alpha1
-        kind: Analysis
-        metadata:
-          name: MyAnalysis
-        # ... content ...
-```
-
-#### 2. Persistence (Manual Management)
-Mounts a Persistent Volume. You are responsible for putting files into this volume (e.g., manually copying them or having another process write to it).
-
-```yaml
-content:
-  type: persistence
-  persistence:
-    enabled: true
-    size: 1Gi
-```
-
-#### 3. EmptyDir + Git Sync (GitOps / Recommended)
-Uses an `emptyDir` volume that is shared between the main container and init containers. This allows you to fetch your architecture definitions from a Git repository at startup.
-
-**Example values.yaml configuration (Public Repo):**
-
-```yaml
-content:
-  type: emptyDir
-
-initContainers:
-  - name: git-sync
-    image: alpine/git
-    # Clone your architecture repo into /resources
-    args: ["clone", "--depth", "1", "https://github.com/my-org/my-architecture.git", "/resources"]
-    volumeMounts:
-      - name: resources
-        mountPath: /resources
-```
-
-**Example values.yaml configuration (Private Repo):**
-
-To use a private repository, create a Kubernetes Secret containing your git token (e.g., `git-credentials` with key `token`) and reference it:
-
-```yaml
-content:
-  type: emptyDir
-
-initContainers:
-  - name: git-sync
-    image: alpine/git
-    env:
-      - name: GIT_TOKEN
-        valueFrom:
-          secretKeyRef:
-            name: git-credentials
-            key: token
-    command: ["/bin/sh", "-c"]
-    # Use the env var in the URL so the token is not exposed in the pod spec
-    args:
-      - "git clone https://oauth2:$GIT_TOKEN@github.com/my-org/my-private-repo.git /resources"
-    volumeMounts:
-      - name: resources
-        mountPath: /resources
-```
-
-
-### Sidecars (Auto-Refresh)
-
-If you want your application to update dynamically when the git repository changes (without restarting the pod), you can add a sidecar container that periodically pulls changes.
-
-**Example (Private Repo with 60s Refresh Loop):**
-
-```yaml
-sidecars:
-  - name: git-refresher
-    image: alpine/git
-    env:
-      - name: GIT_TOKEN
-        valueFrom:
-          secretKeyRef:
-            name: git-credentials
-            key: token
-    command: ["/bin/sh", "-c"]
-    args:
-      - |
-        cd /resources
-        # Set the remote URL with the token to ensure authentication
-        git remote set-url origin "https://oauth2:${GIT_TOKEN}@github.com/my-org/my-private-repo.git"
-        while true; do
-          git pull
-          sleep 60
-        done
-    volumeMounts:
-      - name: resources
-        mountPath: /resources
-```
-
-## Uninstalling the Chart
-
-To uninstall/delete the `my-archsight` deployment:
-
-```bash
-helm delete my-archsight
-```
+See the full documentation at [docs/kubernetes.md](../../docs/kubernetes.md).

data/docs/architecture.md

@@ -0,0 +1,39 @@
+# Architecture
+
+## Technology Stack
+
+- **Backend**: Sinatra (REST API)
+- **Frontend**: Vue 3 + Vue Router 4
+- **Build Tool**: Vite
+- **Styling**: Pico CSS v2.x
+- **Icons**: Iconoir
+- **Visualization**: GraphViz (@hpcc-js/wasm, client-side)
+- **Editor**: Lexical
+
+## Directory Structure
+
+```text
+archsight/
+├── exe/archsight              # CLI executable
+├── frontend/                  # Vue 3 SPA
+│   ├── src/
+│   │   ├── components/        # Vue components (40+)
+│   │   ├── composables/       # Reusable composables
+│   │   ├── router/            # Vue Router config
+│   │   └── css/               # Styles
+│   └── vite.config.js         # Vite build config
+├── lib/
+│   ├── archsight.rb           # Entry point
+│   └── archsight/
+│       ├── cli.rb             # Thor CLI
+│       ├── configuration.rb   # Resources path config
+│       ├── database.rb        # YAML loader and validator
+│       ├── query/             # Query language (lexer, parser, evaluator)
+│       ├── resources/         # Resource types (20+)
+│       ├── annotations/       # Annotation modules
+│       ├── mcp/               # MCP server tools
+│       └── web/               # Sinatra API + static file serving
+│           └── doc/           # Documentation (markdown)
+├── docs/                      # Project documentation
+└── test/                      # Test suite
+```

data/docs/docker.md

@@ -0,0 +1,49 @@
+# Docker
+
+Archsight is available as a Docker image from the GitHub Container Registry.
+
+## Image
+
+```
+ghcr.io/ionos-cloud/archsight
+```
+
+The image is based on `ruby:4.0-alpine3.23`, exposes port **4567**, and includes a healthcheck.
+
+## Quick Start
+
+```bash
+# Run web server (default)
+docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight
+
+# Run in production mode with logging
+docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight web --production
+
+# Run lint
+docker run -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight lint -r /resources
+
+# Run any command
+docker run ghcr.io/ionos-cloud/archsight version
+```
+
+Access web interface at: <http://localhost:4567>
+
+## Notes
+
+- Volume mount `-v "/path/to/resources:/resources"` mounts your resources directory
+- Default command starts the web server on port 4567
+- Pass subcommands directly (lint, version, console, template)
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `ARCHSIGHT_RESOURCES_DIR` | Path to resources directory inside the container | `/resources` |
+| `APP_ENV` | Application environment | `production` |
+
+## Building Locally
+
+```bash
+docker build -t archsight .
+docker run -p 4567:4567 -v "/path/to/resources:/resources" archsight
+```

data/{lib/archsight/web/doc → docs}/index.md.erb

@@ -7,7 +7,7 @@ Welcome to the Architecture Documentation System. This documentation covers how
 - [Tool Guide](/doc/tool) - How to use the architecture tool
 - [Query Syntax](/doc/search) - Search and filter resources
 - [Architecture Modeling](/doc/modeling) - How to model your architecture
-- [REST API Documentation](/api/docs) - JSON API for programmatic access
+- [REST API Documentation](/docs/api) - JSON API for programmatic access
 
 ## Resource Model
 
@@ -73,3 +73,5 @@ Resources representing technology infrastructure and artifacts.
 - [TOGAF](/doc/togaf) - TOGAF framework reference
 - [Icons Reference](/doc/icons) - Available icons for resource types
 - [Computed Annotations](/doc/computed_annotations) - Available computed annotations
+- [Import System](/doc/import) - Declarative data imports from external sources
+- [License Scanning](/doc/licenses) - Repository license detection and dependency analysis

data/docs/kubernetes.md

@@ -0,0 +1,149 @@
+# Kubernetes (Helm)
+
+A Helm chart for deploying [Archsight](https://github.com/ionos-cloud/archsight) on Kubernetes.
+
+## Prerequisites
+
+- Kubernetes 1.19+
+- Helm 3.2.0+
+
+## Installing the Chart
+
+### From OCI Registry (Recommended)
+
+```bash
+helm install my-archsight oci://ghcr.io/ionos-cloud/archsight/charts/archsight
+```
+
+### From Local Source
+
+```bash
+helm install my-archsight ./chart/archsight
+```
+
+## Configuration
+
+The following table lists the configurable parameters of the Archsight chart and their default values.
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `image.repository` | Docker image repository | `archsight` |
+| `image.tag` | Docker image tag | `""` (uses appVersion) |
+| `service.type` | Kubernetes Service type | `ClusterIP` |
+| `service.port` | Service port | `80` |
+| `ingress.enabled` | Enable Ingress resource | `false` |
+| `app.resourcesDir` | Directory where app looks for resources | `/resources` |
+
+### Resource Management Strategies
+
+The most important configuration is how you provide your architecture YAML files to the application. This is controlled by the `content.type` parameter.
+
+#### 1. ConfigMap (Simple / Static)
+Best for small deployments where the architecture definitions rarely change or are small enough to fit in a ConfigMap (1MB limit).
+
+```yaml
+content:
+  type: configMap
+  configMap:
+    create: true
+    data:
+      analysis.yaml: |
+        apiVersion: architecture/v1alpha1
+        kind: Analysis
+        metadata:
+          name: MyAnalysis
+        # ... content ...
+```
+
+#### 2. Persistence (Manual Management)
+Mounts a Persistent Volume. You are responsible for putting files into this volume (e.g., manually copying them or having another process write to it).
+
+```yaml
+content:
+  type: persistence
+  persistence:
+    enabled: true
+    size: 1Gi
+```
+
+#### 3. EmptyDir + Git Sync (GitOps / Recommended)
+Uses an `emptyDir` volume that is shared between the main container and init containers. This allows you to fetch your architecture definitions from a Git repository at startup.
+
+**Example values.yaml configuration (Public Repo):**
+
+```yaml
+content:
+  type: emptyDir
+
+initContainers:
+  - name: git-sync
+    image: alpine/git
+    # Clone your architecture repo into /resources
+    args: ["clone", "--depth", "1", "https://github.com/my-org/my-architecture.git", "/resources"]
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+**Example values.yaml configuration (Private Repo):**
+
+To use a private repository, create a Kubernetes Secret containing your git token (e.g., `git-credentials` with key `token`) and reference it:
+
+```yaml
+content:
+  type: emptyDir
+
+initContainers:
+  - name: git-sync
+    image: alpine/git
+    env:
+      - name: GIT_TOKEN
+        valueFrom:
+          secretKeyRef:
+            name: git-credentials
+            key: token
+    command: ["/bin/sh", "-c"]
+    # Use the env var in the URL so the token is not exposed in the pod spec
+    args:
+      - "git clone https://oauth2:$GIT_TOKEN@github.com/my-org/my-private-repo.git /resources"
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+### Sidecars (Auto-Refresh)
+
+If you want your application to update dynamically when the git repository changes (without restarting the pod), you can add a sidecar container that periodically pulls changes.
+
+**Example (Private Repo with 60s Refresh Loop):**
+
+```yaml
+sidecars:
+  - name: git-refresher
+    image: alpine/git
+    env:
+      - name: GIT_TOKEN
+        valueFrom:
+          secretKeyRef:
+            name: git-credentials
+            key: token
+    command: ["/bin/sh", "-c"]
+    args:
+      - |
+        cd /resources
+        # Set the remote URL with the token to ensure authentication
+        git remote set-url origin "https://oauth2:${GIT_TOKEN}@github.com/my-org/my-private-repo.git"
+        while true; do
+          git pull
+          sleep 60
+        done
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+## Uninstalling the Chart
+
+```bash
+helm delete my-archsight
+```