vyges metadata

Generated from vyges-metadata --help. Do not edit by hand — run scripts/gen-cli-reference.sh.

vyges-metadata — work with an IP's vyges-metadata.json

usage:
  vyges-metadata reconcile <path> [options]   check metadata against its RTL
  vyges-metadata update    <path> [options]   reconcile + WRITE: fill gaps AND
                                              resolve drift (destructive)
  vyges-metadata validate  <path> [options]   check metadata against the schema
  vyges-metadata create    <path> [options]   generate a metadata skeleton from RTL
  vyges-metadata schema    [field] [--json]   describe the schema's required/optional
                                              fields (introspection; no file needed)

create options:
  --rtl <dir>          RTL source directory (default: <path>/rtl)
  --name <name>        IP name (default: the directory name)
  --metadata <file>    output filename (default: vyges-metadata.json)
  --force              overwrite an existing metadata file

validate options:
  --metadata <file>   metadata filename to read (default: vyges-metadata.json)
  --json / --quiet     machine-readable / only invalid IPs
  --fail-on-error      exit non-zero if any IP fails the schema (CI gate)

reconcile options:
  --rtl <dir>         RTL source directory (default: <path>/rtl)
  --rtl-test <dir>    testbench directory (reserved — used by `create`)
  --metadata <file>   metadata filename to read in each IP dir
                      (default: vyges-metadata.json; point at e.g.
                      my_test_metadata.json to compare an alternative for drift)
  --json              machine-readable output
  --quiet, -q         only report IPs that have issues
  --fail-on-drift     exit non-zero if any metadata/RTL drift is found (CI gate)
  --write             merge the proposed additions (clock/reset/top_module) into
                      the metadata file; refreshes 'updated'. Asks before writing.
                      Refuses an IP if the change introduces NEW schema errors.
  --yes, -y           with --write, skip the per-IP confirmation prompt
  --no-schema-gate    with --write, skip the schema delta check

<path> is a single IP directory (with the metadata file) or a directory of
cached IPs (each subdir an IP). Reports per dimension: ok / GAP (RTL has it,
metadata omits it) / DRIFT (metadata claims it, the RTL doesn't).