mergeway-cli reference on Mergeway

mergeway-cli init

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli init`

Creates the configured entry file without overwriting an existing file.

Synopsis

mergeway-cli [global flags] init

There are no arguments or local flags. It inherits all global flags; --root selects the directory and --config may select a different entry filename.

Output and effects

The command creates missing parent directories and a starter v1 configuration, then prints Initialized repository at <root>. Re-running it leaves an existing entry file unchanged. Success exits 0; positional arguments or filesystem failures exit 1.

mergeway-cli validate

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli validate`

Synopsis

mergeway-cli [global flags] validate [--phase format|schema|references]...

--phase is repeatable; with no phase, the order is format, schema, references. Requesting references also runs schema. The inherited --fail-fast default is false; --format defaults to YAML. There are no arguments.

Output, effects, and exits

Success writes status: validation succeeded. Failures write structured errors with phase, entity, identifier, file, and message where available. It never changes repository files. A valid repository exits 0; any validation or loading error exits 1.

mergeway-cli version

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli version`

Synopsis

mergeway-cli [global flags] version

There are no arguments or local flags. --format (yaml by default, or json) controls the result; other inherited repository flags have no effect.

Output, effects, and exits

Prints version, commit, and buildDate. Values depend on the build. It changes no files and exits 0 unless output serialization fails.

mergeway-cli --format json version

Use this output to identify the binary behind validation or automation results. See the CLI overview.

mergeway-cli entity list

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli entity list`

Synopsis

mergeway-cli [global flags] entity list

There are no arguments or local flags. Repository-selection flags are inherited.

Output, effects, and exits

Prints one entity name per line in alphabetical order and changes no files. A successful load exits 0; configuration errors exit 1 on standard error.

mergeway-cli --root examples/full entity list
# Comment
# Post
# Tag
# User

Inspect one definition with entity show.

mergeway-cli entity show

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli entity show`

Synopsis

mergeway-cli [global flags] entity show <name>

<name> is required. There are no local flags; inherited --format defaults to YAML and may be json.

Output, effects, and exits

Prints the effective normalized entity, including inherited fields and source metadata. It changes no files. A known entity exits 0; a missing name, unknown entity, or load error exits 1.

mergeway-cli --root examples/full --format yaml entity show Post

Use entity list to discover names or config export for JSON Schema.

mergeway-cli fmt

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli fmt`

Synopsis

mergeway-cli [global flags] fmt [paths...] [--in-place|--stdout|--lint]

Local flag	Default	Effect
`--in-place`	effective default	Rewrite target files.
`--stdout`	`false`	Print one formatted file; do not write.
`--lint`	`false`	Check only; list files that differ.

The three modes are mutually exclusive. With no paths, all configured YAML data files are targets. Explicit paths may be files, directories, or globs, but every result must belong to the configured data set.

Output, effects, and exits

Default/--in-place rewrites canonical YAML and reports paths. --stdout changes nothing. --lint exits 1 when formatting differs and 0 when clean. Invalid combinations, unmatched/out-of-scope paths, or I/O failures exit 1.

mergeway-cli config lint

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli config lint`

Synopsis

mergeway-cli [global flags] config lint

There are no arguments or local flags; it inherits repository-selection flags.

Output, effects, and exits

Prints configuration valid when the entry file, includes, and normalized definitions load. It does not load record data and changes no files. Success exits 0; syntax, include, version, or normalization errors exit 1.

mergeway-cli --root examples/full config lint

Use validate for records and references, or read which validation to choose.

mergeway-cli config export

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli config export`

Synopsis

mergeway-cli [global flags] config export --type <entity>

--type is required and has no default. There are no arguments. Inherited --format controls whether the schema document is emitted as YAML (default) or JSON.

Output, effects, and exits

Prints a draft 2020-12 JSON Schema representation and changes no files. Reference fields use x-reference-type. Success exits 0; missing/unknown entities, load failures, and unsupported reference unions exit 1.

mergeway-cli --root examples/full --format json config export --type Post

See JSON Schema interoperability and entity show.

mergeway-cli gen-erd

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli gen-erd`

Synopsis

mergeway-cli [global flags] gen-erd --path <output-file>

--path is required and has no default. The extension selects Graphviz output (for example .svg or .png); with no extension, PNG is used. dot must be on PATH.

Output, effects, and exits

Loads entity definitions, sends a generated graph to dot, and creates or replaces the requested file. It displays fields, data paths, references, and inheritance. Success exits 0; missing paths, configuration errors, or Graphviz failures exit 1.

mergeway-cli list

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli list`

Synopsis

mergeway-cli [global flags] list --type <entity> [--filter key=value]

--type is required. --filter has no default and performs simple field equality; path-derived fields are eligible. There are no arguments.

Output, effects, and exits

Prints sorted identifiers, one per line; parent-entity queries include descendants. It changes no files. Success (including no matches) exits 0; missing/unknown types, malformed filters, or load failures exit 1.

mergeway-cli --root examples/full list --type Post --filter author=user-alice

Fetch a result with get or follow the record lifecycle.

mergeway-cli files

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli files`

Synopsis

mergeway-cli [global flags] files [--type <entity>] [--group]

--type optionally restricts one entity; --group (default false) collapses one-record-per-file wildcard storage to its container pattern. There are no arguments. --format defaults to YAML.

Output, effects, and exits

Prints sorted {type, file} entries for YAML includes only; inline and JSON sources are excluded. It changes no files. Success exits 0; unknown entities, ambiguous configured files, or load/filesystem errors exit 1.

mergeway-cli --root examples/full --format json files --group

See split schemas and records and list.

mergeway-cli get

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli get`

Synopsis

mergeway-cli [global flags] get --type <entity> <id>

--type and <id> are required. Inherited --format defaults to YAML. $path identifiers use the workspace-relative file path and may include ../ for external read-only records.

Output, effects, and exits

Prints record fields, including declared path-derived fields, and changes no files. Parent types may resolve descendants. Success exits 0; missing arguments, unknown records/types, or load failures exit 1.

mergeway-cli --root examples/full --format json get --type Post post-001

Discover IDs with list or modify local records with update.

mergeway-cli create

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli create`

Synopsis

mergeway-cli [global flags] create --type <entity> [--file <payload>] [--id <id>]

--type is required. --file defaults to standard input. --id overrides a field identifier and is required for $path entities.

Output, effects, and exits

Creates a YAML record through the entity’s writable include pattern and prints <Entity> <id> created. Writes are restricted to the repository root; inline-only, grouped, ambiguous, duplicate, invalid, or external targets fail. Success exits 0; input, validation, resolution, or write errors exit 1.

mergeway-cli update

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli update`

Synopsis

mergeway-cli [global flags] update --type <entity> --id <id> [--file <payload>] [--merge]

--type and --id are required. --file defaults to standard input. --merge defaults to false: without it, the payload replaces the record; with it, supplied fields overlay existing fields.

Output, effects, and exits

Rewrites the backing YAML file and prints <Entity> <id> updated. External-root records are read-only. Success exits 0; missing/invalid input, unknown records, validation, or write failures exit 1.

printf '%s\n' 'title: Updated title' | mergeway-cli update --type Post --id post-001 --merge

See manage records and get.

mergeway-cli delete

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli delete`

Synopsis

mergeway-cli [global flags] delete --type <entity> <id>

--type and <id> are required. The command prompts on standard error; inherited --yes (default false) skips confirmation.

Output, effects, and exits

Deletes the local backing file and prints <Entity> <id> deleted. It will not delete an external-root record. Success exits 0; rejection (aborted), missing/unknown records, or filesystem failures exit 1.

mergeway-cli --yes delete --type User user-bob

Destructive examples belong on temporary copies; follow manage records and validate references afterward.

mergeway-cli export

Mon, 01 Jan 0001 00:00:00 +0000

`mergeway-cli export`

Synopsis

mergeway-cli [global flags] export [entities...] [--output <path>]

Entity arguments are optional; omitting them exports all entities. --output defaults to standard output. Inherited --format defaults to YAML.

Output, effects, and exits

Produces a map from entity names to ID-sorted record arrays, including derived fields. --output creates or truncates its destination; otherwise repository files are untouched. Success exits 0; unknown entities, load/serialization errors, or output-file failures exit 1.

mergeway-cli --root examples/full --format json export User Post --output snapshot.json

See export repository data and get.