Skip to content

glx init ​

Initialize a new GENEALOGIX archive in the specified directory

Synopsis ​

Initialize a new GENEALOGIX archive with the proper directory structure.

If a directory is provided, it will be created. If no directory is provided, the current directory will be used (but must be empty).

By default, creates a multi-file archive with separate directories for each entity type (persons/, events/, places/, etc.) along with standard vocabulary files and supporting documentation.

Use --single-file to create a single archive.glx file instead.

The new archive directory is made a Git repository (no files staged, no commit made) so the generated .gitignore takes effect and the archive is ready for version control. An archive created inside an existing repository is left to that repository. Use --no-git to skip this entirely.

glx init [directory] [flags]

Examples ​

  # Initialize in a new directory
  glx init my-family-archive

  # Initialize a single-file archive in a new directory
  glx init my-family-archive --single-file

  # Initialize with test data in a new directory
  glx init my-family-archive --create-test-data 10

  # Initialize without making the directory a Git repository
  glx init my-family-archive --no-git

Options ​

  -t, --create-test-data int   number of persons to generate test data for
  -h, --help                   help for init
      --no-git                 skip initializing a Git repository in the archive directory
  -s, --single-file            create a single-file archive instead of multi-file

Options inherited from parent commands ​

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

SEE ALSO ​

  • glx - GENEALOGIX CLI - Manage and validate genealogy archives

Licensed under Apache License 2.0