Guides

Task-focused guides for common Mergeway workflows and integrations.

The how-to guides capture focused, task-oriented recipes for Mergeway users. Each guide assumes you already understand the core concepts and need a concrete sequence of steps to accomplish a specific outcome, such as enforcing formatting in CI or wiring Mergeway into deployment automation.

For editor integration, start with Set up mergeway-lsp in VS Code and Neovim.


Communicate Repository Changes with mergeway-cli diff

Use mergeway-cli diff with a time-based Git baseline to explain semantic data changes over time.

Getting Started with Mergeway CLI Using the Example Repository

Use the example repository to get started with Mergeway CLI

Set up Mergeway with GitHub Actions

Set up GitHub Actions and CODEOWNERS to keep Mergeway formatting and ownership consistent.

Using JSON Schema & JSONPath in Mergeway

Advanced guide on using JSON Schema and JSON Path for setting up Mergeway with existing data structures

Enforce Mergeway Formatting with pre-commit

Configure pre-commit to run mergeway-cli fmt before each commit.

Set up mergeway-lsp in VS Code and Neovim

Configure the Mergeway VS Code extension or a generic LSP client to launch mergeway-lsp.