diff --git a/trustgraph-cli/scripts/tg-dump-msgpack b/trustgraph-cli/scripts/tg-dump-msgpack index 9f91394f..dc4a8139 100755 --- a/trustgraph-cli/scripts/tg-dump-msgpack +++ b/trustgraph-cli/scripts/tg-dump-msgpack @@ -1,5 +1,11 @@ #!/usr/bin/env python3 +"" +This utility reads a knowledge core in msgpack format and outputs its +contents in JSON form to standard output. This is useful only as a +diagnostic utility. +""" + import msgpack import sys import argparse @@ -16,7 +22,7 @@ def run(input_file): def main(): parser = argparse.ArgumentParser( - prog='tg-load-pdf', + prog='tg-dump-msgpack', description=__doc__, ) diff --git a/trustgraph-cli/scripts/tg-load-kg-core b/trustgraph-cli/scripts/tg-load-kg-core index 2469772d..13fac153 100755 --- a/trustgraph-cli/scripts/tg-load-kg-core +++ b/trustgraph-cli/scripts/tg-load-kg-core @@ -1,5 +1,10 @@ #!/usr/bin/env python3 +"""This utility takes a knowledge core and loads it into a running TrustGraph +through the API. The knowledge core should be in msgpack format, which is the +default format produce by tg-save-kg-core. +""" + import aiohttp import asyncio import msgpack @@ -133,7 +138,7 @@ async def run(**args): async def main(): parser = argparse.ArgumentParser( - prog='tg-load-pdf', + prog='tg-load-kg-core', description=__doc__, ) diff --git a/trustgraph-cli/scripts/tg-save-kg-core b/trustgraph-cli/scripts/tg-save-kg-core index feeea1ef..3c03383f 100755 --- a/trustgraph-cli/scripts/tg-save-kg-core +++ b/trustgraph-cli/scripts/tg-save-kg-core @@ -1,5 +1,14 @@ #!/usr/bin/env python3 +""" +This utility connects to a running TrustGraph through the API and creates +a knowledge core from the data streaming through the processing queues. +For completeness of data, tg-save-kg-core should be initiated before data +loading takes place. The default output format, msgpack should be used. +JSON output format is also available - msgpack produces a more compact +representation, which is also more performant to load. +""" + import aiohttp import asyncio import msgpack @@ -144,7 +153,7 @@ async def run(**args): async def main(): parser = argparse.ArgumentParser( - prog='tg-load-pdf', + prog='tg-save-kg-core', description=__doc__, )