Skip to content

GLX CLI Reference

The official command-line tool for working with GENEALOGIX (GLX) family archives. Use glx to initialize archives, import GEDCOM files, validate data quality, query entities, and analyze relationships.

The per-command pages linked below are auto-generated from the live Cobra command tree by make docs-cli. To change a command's documentation, edit its Use/Short/Long/Example strings in glx/cli_commands.go (or its *_runner.go file) and re-run the target. CI fails on any drift between the source command tree and the committed pages.

For installation instructions, see glx/README.md. For a guided walkthrough, see the Hands-On CLI Guide.

Commands

Archive Management

  • glx init — initialize a new archive
  • glx validate — validate files and cross-references
  • glx split — convert a single-file archive to multi-file
  • glx join — convert a multi-file archive to single-file
  • glx merge — combine two archives with duplicate detection
  • glx merge-persons — merge two person records into one
  • glx migrate — migrate an archive to the current format
  • glx rename — rename an entity by ID
  • glx cache — build, inspect, or clear the binary archive cache

Import & Export

  • glx import — import a GEDCOM file
  • glx export — export to GEDCOM or Schema.org-aligned JSON-LD
  • glx publish — generate a self-contained static HTML site from an archive

Exploration

Data Entry

  • glx census — census tooling (see subcommands)
  • glx census add — generate entities from a census template
  • glx add — create person, place, event, source, citation, relationship, or assertion entities from flags
  • glx link — create a FamilySearch citation (and source/repository scaffolding) from an ARK URL

Analysis

Shell completion

  • glx completion — generate shell completion scripts (bash, zsh, fish, powershell)

Licensed under Apache License 2.0