Concepts

The YAML schema

High-level tour of socotra.yaml. For every field and validation rule see the full reference.

Top-level shape

Every socotra.yaml file lives under a single root key:

socotra:
  version: "1.1"
  solution:    { ... }
  architecture: { ... }
  modules:     [ ... ]
  shared:      [ ... ]
  host:        { ... }

solution — global settings: name, root namespace, target framework, output path, defaults.
architecture — pattern (modular-monolith or clean-architecture) and optional allowedDependencies rules.
modules — business modules, each with its own layers (typed projects).
shared — cross-cutting projects (e.g. SharedKernel) any module can reference.
host — the entry-point project (Web API, Worker) that wires modules together.

The complete field-by-field reference, validation rules, and architecture-pattern semantics live in the YAML reference.

Schema 1.1 · CLI 1.0