Skip to content

glx add relationship

Create a relationship entity

Synopsis

Create a Relationship entity in the archive.

--type is required and is validated against the relationship_types vocabulary. At least two participants are required. Use --parent / --child (each repeatable) for parent-child relationships, --participant person-id:role for arbitrary roles. --start-event and --end-event must reference existing events.

glx add relationship [flags]

Examples

  # Biological parent-child
  glx add relationship --type biological_parent_child \
    --parent person-johann --child person-johann-jr --archive ./archive

  # Marriage tied to a marriage event
  glx add relationship --type marriage \
    --participant person-john:spouse --participant person-jane:spouse \
    --start-event event-marriage-1850 \
    --archive ./archive

Options

  -a, --archive string            Archive path (directory) (default ".")
      --child stringArray         Child person ID (repeatable; adds participant with role child)
      --dry-run                   Print what would be created without writing files
      --end-event string          Event ID marking the relationship's end
      --force                     Overwrite an existing entity with the chosen ID
  -h, --help                      help for relationship
      --id string                 Override the derived entity ID
      --note stringArray          Free-text note (repeatable)
      --parent stringArray        Parent person ID (repeatable; adds participant with role parent)
      --participant stringArray   Participant in the form person-id:role (repeatable)
      --skip-validate             Skip whole-archive validation after adding (vocab and reference checks still run)
      --spouse stringArray        Spouse person ID (repeatable; adds participant with role spouse)
      --start-event string        Event ID marking the relationship's start
      --type string               Relationship type (required, vocabulary key in relationship_types)

Options inherited from parent commands

  -q, --quiet   Suppress non-error output (where supported)

SEE ALSO

  • glx add - Create entities (person, place, event, …) from CLI flags

Licensed under Apache License 2.0