genealogit

genealogit

Update since v1: works! GEDCOM and Homebrew to come…

• What's this?
• Quickstart
• Usage
• Commands
• Contributing
• License

What's this?

genealogit uses Git as a family tree modelling and visualization tool.

genealogit build <file> reads data from a file and for each person creates a single-commit branch.

genealogit visualize <file> shows the git log --graph for the branches (must run genealogit build <file> first).

genealogit relationship <file> <individual 1's id> <individual 2's id> reports the blood relationship between two individuals (must run genealogit build <file> first).

genealogit clean <file> deletes the branches created by genealogit build <file>.

The data file can be a .ged GEDCOM (.ged) file, (stayed tuned for GEDCOM support) or JSON or YAML. If making your own .json or .yaml, you can follow GEDCOM or take advantage of genealogit's support for the non-standard properties name and parentIds. For example, a simple YAML could look like

- individuals
  -
    id: 1
    name: child
    parentIds:
      - 2
      - 3
  -
    id: 2
    name: parent_1
  -
    id: 3
    name: parent_2

Branch names are

genealogit/<file>/<individual id>

Commit messages are

<individual's full name> (<individual's id>)

<individual's full record>

The commit author for all commits created by genealogit is genealogit <[e-mail]>.

Quickstart

Install, with one these:

yarn global add genealogit
npm install -g genealogit

brew install genealogit (stay tuned for Homebrew support)

Add autocompletion support

genealogit autocomplete

At a minimum, genealogit requires that you are in a Git repo with at least one commit. You Git repo can have a lot of other things going on too. The minimum setup is:

mkdir my-family-tree
cd my-family-tree
git init
git commit --allow-empty -m "empty"
[(npx|yarn)] genealogit build --format=yaml my-family-tree.yaml

 

Usage

$ npm install -g genealogit
$ genealogit COMMAND
running command...
$ genealogit (-v|--version|version)
genealogit/1.1.1 darwin-x64 node-v13.11.0
$ genealogit --help [COMMAND]
USAGE
  $ genealogit COMMAND
...

Commands

• genealogit autocomplete [SHELL]
• genealogit build [FILE]
• genealogit clean [FILE]
• genealogit help [COMMAND]
• genealogit relationship [FILE] [IND1] [IND2]
• genealogit visualize [FILE]

genealogit autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ genealogit autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ genealogit autocomplete
  $ genealogit autocomplete bash
  $ genealogit autocomplete zsh
  $ genealogit autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

genealogit build [FILE]

Build a family tree in Git from a GEDCOM file

USAGE
  $ genealogit build [FILE]

OPTIONS
  -v, --verbose
  --format=format  [default: gedcom]

See code: src/commands/build.ts

genealogit clean [FILE]

Delete a tree created by build

USAGE
  $ genealogit clean [FILE]

OPTIONS
  --format=format  [default: gedcom]

See code: src/commands/clean.ts

genealogit help [COMMAND]

display help for genealogit

USAGE
  $ genealogit help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

genealogit relationship [FILE] [IND1] [IND2]

Show the relationship between two individuals

USAGE
  $ genealogit relationship [FILE] [IND1] [IND2]

See code: src/commands/relationship.ts

genealogit visualize [FILE]

Show the Git log graph for the specified file

USAGE
  $ genealogit visualize [FILE]

See code: src/commands/visualize.ts

Contributing

Thanks for your interest. Contributions are welcome!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Check the Issues to see if your topic has been discussed before or if it is being worked on. You may also want to check the roadmap (see above). Discussing in an Issue before opening a Pull Request means future contributors only have to search in one place.

This project loosely follows the Angular commit message conventions.

License

This project is licensed under the MIT license. For the full text of the license, see the LICENSE file.