Installation¶

Prerequisites¶

Java 17+ (Java 21 recommended for full sealed interface support)
Maven 3.9+
Git

Clone and Build¶

git clone https://github.com/patternops/patternops-framework.git
cd patternops-framework
mvn clean install

Project Modules¶

The build produces the following modules:

Module	Artifact	Purpose
`core`	`patternops-core`	Domain models, service interfaces, parser, validator, registry, echo, policy engine, lifecycle
`capabilities`	`patternops-capabilities`	All 21 capability contract interfaces
`providers`	`patternops-providers`	Provider implementations
`echo-api`	`patternops-echo-api`	REST API for the Echo service (Spring Boot)
`mcp`	`patternops-mcp`	MCP Layer for AI integration
`documentation`	`patternops-documentation`	Documentation Engine
`migration`	`patternops-migration`	Migration Accelerator
`agent`	`patternops-agent`	Agent Pipeline Constructor
`build`	`patternops-build`	Distribution compilation and packaging

Dependency Management¶

Add PatternOps to your project:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>io.patternops</groupId>
            <artifactId>patternops-core</artifactId>
            <version>0.1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>io.patternops</groupId>
            <artifactId>patternops-capabilities</artifactId>
            <version>0.1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</dependencyManagement>

Compile a Single Module¶

Each module compiles independently:

# Core only
mvn compile -pl core

# Core + capabilities
mvn compile -pl core,capabilities

# Run tests for core
mvn test -pl core

Technology Stack¶

Technology	Version	Purpose
Java	17+	Implementation language
Spring Boot	3.4.1	REST API (Echo service)
Jackson	2.18.2	JSON/YAML serialization
OpenTelemetry	1.44.1	Observability SDK
JUnit 5	5.11.4	Unit testing
jqwik	1.9.2	Property-based testing
AssertJ	3.27.0	Fluent assertions
Mockito	5.14.2	Mocking framework

Verify Installation¶

mvn test

Expected output:

[INFO] PatternOps :: Core ................................ SUCCESS
[INFO] PatternOps :: Capabilities ........................ SUCCESS
[INFO] PatternOps :: Providers ........................... SUCCESS
[INFO] PatternOps :: MCP ................................. SUCCESS
[INFO] PatternOps :: Documentation ....................... SUCCESS
[INFO] PatternOps :: Migration ........................... SUCCESS
[INFO] PatternOps :: Agent ............................... SUCCESS
[INFO] PatternOps :: Build ............................... SUCCESS
[INFO] PatternOps :: Echo API ............................ SUCCESS
[INFO] BUILD SUCCESS