Command Line Interface (CLI) for a Public Collaborative Project (PCP) infrastructure.
This environment was developed initially for use in scholarly
communication but can be applied outside as well. Anything that can
benefit from a step-by-step approach with provenance pretty much
(@chartgerink also hopes to use it for music
npm install -g @hypergraph-xyz/cli
If you do not have NodeJS installed, please
install this first. If you are running Windows/Mac OS X it is easiest
to download the installer. If you are using a package manager, you can
$ hypergraph --help Usage $ hypergraph <action> <input> Actions create <type> Create a module read <type> <hash> [key] Read a module's metadata update <type> <hash> [key value] Update a module's metadata list <type> List writable modules Options --env, -e Custom dotfiles path in home directory (defaults to .p2pcommons) --help, -h Display help text --version, -v Display version Module types - content A content module - profile A user profile module Examples $ hypergraph [interactive mode]
This tool directly allows you to start using public collaborative infrastructure.
After installation, the
hypergraph command is exported to your command
We follow a simple format for the commands. However, we realize this
isn't easy to remember at first so you can also invoke interactive
mode by simply giving
hypergraph. You will be guided through all the
options one-by-one. :angel-tone4:
All commands are structured as
hypergraph <action> <input> <arguments>
You will always be provided with an interactive set of options if you omit an action, input, or argument(s) (if relevant).
Help is provided under
hypergraph --help and the maintainers will do
their best to answer your questions in the issues.
If you want to develop your own applications using this public collaborative infrastructure, we recommend you look at our Application Programmatic Interface (API). All data is portable between applications if it adheres to the specifications outlined in that repository.