Command Line Interface (CLI) utilising the peer-to-peer commons.
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. Some additional instructions follow.
Directly download the NodeJS installer, or install it through the Chocolatey package manager.
Install Homebrew and install NodeJS and the Hypergraph dependencies from the Terminal
brew install node libtool autoconf automake
Using your package manager, install NodeJS.
apt install nodejs
$ hypergraph --helpUsage$ hypergraph <action> <input>Actionscreate <type> Create a moduleread <hash> [key] Read a module's metadataupdate <hash> [key value] Update a module's metadataopen <hash> Open a module's foldermain <hash> Open a module's main filepath <hash> Print module pathlist <type> List writable modulesedit <hash> Edit main fileregister <content> <profile> Register content to a profileOptions--env, -e Dotfiles path--help, -h Display help text--version, -v Display version--title, -t A content module's title--name, -n A profile module's name--subtype, -s A content module's subtype--description, -d Module description--yes, -y Confirm license for module creationModule types- content A content module- profile A user profile moduleExamples$ 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.
How to release
npm run releasewill guide you through the node module process and create a GitHub release
- Write release notes and publish the GitHub release
- Tell your Hypergraph friends about it
Thanks goes to these wonderful people (emoji key):
🚧 💻 ⚠️
🤔 ⚠️ 💻
This project follows the all-contributors specification. Contributions of any kind welcome!