Skip to content

glx add research-log ​

Create a research log entity

Synopsis ​

Create a ResearchLog entity in the archive.

A research log records what was searched, where, and with what result, including searches that found nothing (negative evidence). Create the log once, then append searches to it with "glx add search".

At most one of --subject-person, --subject-event, --subject-relationship, --subject-place may be given. --status is validated against the research_log_status_types vocabulary. The derived ID is "research-log-" plus the --title, else the subject, else the --objective; --id overrides it. Repeated --citation IDs are included once, in the order first supplied.

glx add research-log [flags]

Examples ​

  # Open a log about a person
  glx add research-log --id rl-death --subject-person person-lewis-little \
    --objective "Verify the reported 1826 intestate death" --status in_progress \
    --archive ./archive

  # Log with a title, researcher and date
  glx add research-log --title "1860 census, Jane Webb" --researcher "I. Schepp" \
    --date 2026-09-17 --status open --archive ./archive

Options ​

  -a, --archive string                Archive path (directory) (default ".")
      --citation stringArray          Citation ID produced by this log (repeatable)
      --conclusions string            Summary of findings
      --date string                   Date the research was performed (GLX date string)
      --dry-run                       Print what would be created without writing files
      --force                         Overwrite an existing entity with the chosen ID
  -h, --help                          help for research-log
      --id string                     Override the derived entity ID
      --note stringArray              Free-text note (repeatable)
      --objective string              Research question or goal
      --researcher string             Name or identifier of the researcher
      --skip-validate                 Skip whole-archive validation after adding (vocab and reference checks still run)
      --status string                 Status (vocabulary key in research_log_status_types)
      --subject-event string          Event ID the log investigates
      --subject-person string         Person ID the log investigates
      --subject-place string          Place ID the log investigates
      --subject-relationship string   Relationship ID the log investigates
      --title string                  Human-readable title

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