Command reference

Every command is hydra-ctl <command> [<dir>] [options]. Leave out <dir> and the command uses the active archive (see activate) or the current folder.

Run hydra-ctl alone for the list, or hydra-ctl <command> --help for one command's options.

hydra-ctl details                         # one-screen summary
hydra-ctl tree                            # the org chart
hydra-ctl tree person gus                 # start at a search
hydra-ctl positions                       # the position ladder and titles nothing takes
hydra-ctl claims "Walter Hartwell White"  # read the claims for "Walter Hartwell White"
hydra-ctl sources                         # which documents cite what
hydra-ctl hints                           # image and badge rules, with hit counts
hydra-ctl check                           # problems in the files
hydra-ctl todo                            # open questions
hydra-ctl review                          # answer them one by one

Commands and what they write

Command	Does	Writes
init	Creates an archive, or opens a .hydra file into one	The new folder
activate, deactivate	Set the archive to use when none is given	.hydra-activate in this folder
import	Loads FtM JSON (standard or Hydra's), or a CSV or GraphML export, as a collection	The collection file, then rebuilds
build	Compiles the collections and sources into a build	.hydra/parsed/ and collections/manifest.json
check	Lists the problems in the archive's files, without building	Nothing
details	One screen of records, types, tree size and open questions	Nothing
tree	Draws the record tree, from a type, a relationship or a search	Nothing
positions	Draws the position tree and the titles no position takes	Nothing
claims	Shows where each value of an entity came from	Nothing
node find	Lists the records closest to a value	Nothing
sources	Lists the sources, and which entities cite each	Nothing
todo	Counts what the last build needs a person to decide	Nothing
review	Asks the open questions one by one	verdicts.yaml, then rebuilds
answer	Records one decision, for scripts	verdicts.yaml, then rebuilds
reset	Removes decisions, after backing them up	verdicts.yaml and a backup, then rebuilds
stubs	Lists names that links point at but no record has, and graduates one	verdicts.yaml, then rebuilds
pack, unpack	Turn an archive into one .hydra file, and back	The .hydra file, or the folder
export	Writes the archive for other tools	The output file or folder
collections	Lists collections and their id prefixes, and changes one	collections/manifest.json, then rebuilds
defaults	Checks, switches off or restores the default config files	hydra.yaml, or the restored files
hints	Lists the image and badge rules, and links an image file by one	.hydra/resources/ and hints.yaml, then rebuilds