Morphir Documentation
Welcome to the Morphir documentation! This guide will help you understand, install, and use Morphir effectively.
📚 Documentation Structure​
Getting Started​
Start here if you're new to Morphir!
- Introduction - What is Morphir and why use it?
- Installation - Install Morphir tools
- Installation and Usage - Detailed installation and basic usage
- Quick Start Tutorial - Get up and running quickly
- Editor Setup - Configure your development environment
- Morphir Web UI - Browse and visualize Morphir models
- Morphir Go Preview - Preview of the new Go-based Morphir CLI
CLI Preview​
The next-generation Morphir CLI built in Go
- Overview - Introduction to the new CLI
- Getting Started - Quick start with the new CLI
- What's New - Latest features and improvements
- Commands - CLI command reference
- Release Notes - Version history and changelogs
Design​
Draft design documents and specifications for upcoming features
- IR v4 - Next-generation IR design
- Document Tree Protocol - Document Tree layout and protocol
- Morphir Daemon - Workspace management design
Core Concepts​
Understand the fundamental concepts behind Morphir
- Introduction to Morphir - Overview of Morphir
- What's It About? - Business logic and application focus
- Why Functional Programming? - The FP paradigm in Morphir
- Morphir IR - The Intermediate Representation structure
- Morphir SDK - Standard library and SDK
Specifications​
Formal specifications for Morphir configuration and IR formats
- Overview - Specifications overview
- morphir.toml -
morphir.tomlformat - morphir.json -
morphir.jsonformat (morphir-elm legacy) - Morphir IR Specification - Detailed IR specification
- Morphir IR JSON Schemas - JSON schemas for IR versions
- Version 3 (Current) - Latest IR schema
- Version 2 - Previous IR schema
- Version 1 - Original IR schema
User Guides​
Learn how to model business logic and use Morphir tools
Modeling Guides​
- Application Modeling
- Modeling Overview
- What Makes a Good Domain Model
- Modeling for Database Developers
- Modeling in Finance
- Modeling and Testing
- Soul of Your Application
Command-Line Tools​
Development Techniques​
Reference​
Technical reference documentation for backends, APIs, and tools
Backends​
Scala​
Spark​
- Spark Backend Design
- Spark Backend API
- Spark Backend Joins
- Spark Backend Optional Values
- Spark as Relational Backend
- Spark Testing Framework
Other Platforms​
JSON Schema​
- JSON Codecs Documentation
- Generating JSON Schema
- JSON Schema Configuration
- JSON Schema Mappings
- JSON Schema Sample
- JSON Schema Developers Guide
- JSON Schema Backend Test Plan
- JSON Schema Backend Config Test Plan
- Codec Documentation
CLI Reference​
Other Reference​
Developer Guides​
Contributing to Morphir and advanced development topics
- Contributing Guide - How to contribute to Morphir
- Contribution Guide Index
- Contribution Guide README
- Morphir Developers Guide
- Development Bots
- Integrating Morphir with JVM Projects
- Publishing
- Release Retrospective v0.4.0-alpha.1 - Lessons learned from v0.4.0-alpha.1 release
Community​
Join the Morphir community
- Morphir Community - Community resources and how to get involved
- Media - Presentations, videos, and media resources
- Code of Conduct
- FAQs - Frequently Asked Questions
Use Cases​
Real-world applications of Morphir
🚀 Quick Links​
- New to Morphir? Start with Introduction
- Want to install? See Installation
- Need to model business logic? Check out Application Modeling
- Looking for API docs? Browse the Reference section
- Want to contribute? Read the Contributing Guide
- Have questions? Check the FAQs or join the Community
📖 Additional Resources​
- Examples: See the examples folder for practical examples
- Presentations: Check presentations for talks and slides
🔗 External Links​
🤖 Docs for AI Agents​
Morphir provides LLM-friendly documentation following the llms.txt specification:
| File | Description |
|---|---|
| /llms.txt | Compact version with curated links and descriptions |
| /llms-full.txt | Full version with inline content from key documents |
Use these files to provide Morphir context to AI assistants, chatbots, or code generation tools. See LLM-Friendly Documentation for usage examples.
Note: This documentation is organized to help newcomers navigate easily. If you're looking for something specific, use your browser's search function or check the FAQs.