glx add study

Create a study entity

Synopsis

Create a Study entity in the archive.

A study declares the scope of a research project: a one-place or one-name study, a family reconstruction, a brick wall. --title is required. --type and --status are validated against the study_types and study_statuses vocabularies. --place and --source are repeatable and must reference existing entities; repeated IDs are included once, in the order first supplied. --date-range is a GLX date string, usually "FROM YYYY TO YYYY".

glx add study [flags]

Examples

  # Brick-wall study
  glx add study --id study-lewis-little-parentage --type brick_wall --status active \
    --title "Parents of Lewis Little" --place place-rowan-nc \
    --date-range "FROM 1750 TO 1822" --archive ./archive

  # One-place study with sources in scope
  glx add study --title "Pohl-Göns One Place Study" --type one_place_study \
    --place place-pohl-goens --source source-pohl-goens-registers \
    --date-range "FROM 1610 TO 1875" --archive ./archive

Options

  -a, --archive string       Archive path (directory) (default ".")
      --date-range string    Temporal scope as a GLX date string, e.g. "FROM 1750 TO 1822"
      --dry-run              Print what would be created without writing files
      --force                Overwrite an existing entity with the chosen ID
  -h, --help                 help for study
      --id string            Override the derived entity ID
      --note stringArray     Free-text note (repeatable)
      --place stringArray    Place ID in scope (repeatable)
      --skip-validate        Skip whole-archive validation after adding (vocab and reference checks still run)
      --source stringArray   Source ID in scope (repeatable)
      --status string        Study status (vocabulary key in study_statuses)
      --title string         Study title (required)
      --type string          Study type (vocabulary key in study_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