reference · oto registry --help at v0.6.1

oto registry

the registries this machine fetches ontologies from

oto registry [-h] [--as AS_NAME] [--ref REF] [--out OUT] [--url URL]
                    [{add,list,remove,refresh,check,site}] [which ...]

Verbs

add <git url> registers one
list (default) shows them
remove <name> forgets one (what was fetched from it stays)
refresh [<name>] re-reads the index
check [<dir>] verifies a registry checkout: the index matches the directories
site [<dir>] generates the catalogue, a static site, from a registry checkout

which add: a git URL; remove and refresh: a registry name; check: the checkout (default .)

Options

Option	What it does
`--as AS_NAME`	for add: register it under this name instead of the name its index declares
`--ref REF`	for add: a branch or tag to read the index from
`--out OUT`	for site: the directory to write (default: <dir>/site)
`--url URL`	for site: what a person types to add this registry (default: the checkout's git remote)

Where to use it

Your company runs its own registry, or you want the public catalog.

oto registry add https://github.com/Cynergis/oto-registry

registers it under the name its index declares; ontology and pack list now show its entries

The index changed upstream.

oto registry refresh

re-reads every registry's index

In the registry's own CI.

oto registry check .

verifies that the index matches the directories

Publish a browsable catalog of the registry.

oto registry site . --out site --url "https://github.com/<org>/oto-registry"

a static site, one page per ontology and pack with its sample graph drawn; --url is what a person types to add it

As the terminal prints it

usage: oto registry [-h] [--as AS_NAME] [--ref REF] [--out OUT] [--url URL]
                    [{add,list,remove,refresh,check,site}] [which ...]

positional arguments:
  {add,list,remove,refresh,check,site}
                        add <git url> registers one; list (default) shows them; remove <name>
                        forgets one (what was fetched from it stays); refresh [<name>] re-reads
                        the index; check [<dir>] verifies a registry checkout: the index matches
                        the directories; site [<dir>] generates the catalogue, a static site, from
                        a registry checkout
  which                 add: a git URL; remove and refresh: a registry name; check: the checkout
                        (default .)

options:
  -h, --help            show this help message and exit
  --as AS_NAME          for add: register it under this name instead of the name its index
                        declares
  --ref REF             for add: a branch or tag to read the index from
  --out OUT             for site: the directory to write (default: <dir>/site)
  --url URL             for site: what a person types to add this registry (default: the
                        checkout's git remote)