Mergeway
Mergeway is a specification and suite of tools for reading and modifying a file-based database.
Schemas and records stay in ordinary YAML and JSON files, so teams can review data changes in Git while Mergeway checks structure and relationships.
Install mergeway-cli Build your first repository
One repository model, several ways to work
Use mergeway-cli to validate, inspect, modify, format, and export records. Add mergeway-diff for semantic reviews, mergeway-python for typed Python automation, mergeway-mcp for read-only AI-tool access, or mergeway-lsp for editor diagnostics and navigation. Every component works with the same repository model defined by the Mergeway specification.
Define and validate
Use the version 1 specification and
mergeway-clito model, inspect, validate, and export repositories.Review changes
Use
mergeway-diffto compare repository states as records and relationships instead of raw text.Connect tools
Give AI clients read-only access through
mergeway-mcpor editor clients diagnostics and navigation throughmergeway-lsp.Automate with Python
Use the
mergewayPython package to generate typed models and automate repository operations.
Start here
- Build your first Mergeway repository with a fixed, tested example.
- Install the Mergeway tools for your platform and workflow.
- Understand the repository model before adapting Mergeway to existing data.
- Choose a component when you already know the kind of integration you need.