Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Mergeway's goal is to make metadata a commodity putting it in the open and treating it as code. Instead of juggling spreadsheets or custom scripts, you describe entities in YAML/JSON, run a quick validation, and catch broken references before they reach production. By storing metadata as code, changes become a simple patch.

What the CLI Does

  • Stores entity definitions and relationships in version-controlled files.
  • Validates schemas and records so required fields and references stay consistent.
  • Generates simple reports you can attach to pull requests or issues.

Key Features

  • Workspace scaffolding: mergeway-cli init writes a starter mergeway.yaml into your working directory so you can begin defining entities immediately.
  • Dual schema sources: Author entity fields inline in YAML or reference existing JSON Schema documents (json_schema) so teams can reuse specs.
  • Object lifecycle commands: list, get, create, update, and delete operate on local YAML/JSON files, respecting schema-defined identifiers whether they come from record fields or the special $path file-path mode.
  • Deterministic formatting: mergeway-cli fmt emits canonical structure and rewrites files in place (use --stdout to preview changes) to keep diffs clean.
  • Layered validation: Format, schema, and reference phases catch structural, typing, and cross-entity errors before they land in main.
  • Schema introspection: mergeway-cli entity show and mergeway-cli config export surface normalized schemas or derived JSON Schema for documentation and automation.

Why Teams Use Mergeway

  • Fast feedback: One command surfaces missing fields, enum mismatches, or invalid references.
  • Git-native: Changes live in branches and pull requests, making reviews trivial.
  • Lightweight: No server component—just a binary that runs locally or in CI.

Where to Go Next

  1. Install Mergeway (or build from source).
  2. Follow the Workspace set-up.
  3. Review the Basic Concepts and Schema Format when you define entities.
  4. Browse through the CLI Reference for command syntax.

Updates land in the Changelog. File GitHub issues for questions, bugs, or requests.

For a more general introduction to Mergeway, visit the homepage