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 --help
Usage
$ hypergraph <action> <input>
Actions
create <type> Create a module
read <hash> [key] Read a module's metadata
update <hash> [key value] Update a module's metadata
delete <hash> Delete a content module
open <hash> Open a module's folder
main <hash> Open a module's main file
path <hash> Print module path
list <type> List writable modules
edit <hash> Edit main file
publish <profile> <content> Publish content to a profile
unpublish <profile> <content> Unpublish content from a profile
config <key> [value] Change hypergraph configuration
logout Log out of Vault account
Options
--env, -e Dotfiles path (default ~/.p2pcommons)
--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
--parent, -p Module parent(s)
--yes, -y Confirm license for module creation
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
line.
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.
Please note we adhere to a Code of Conduct and any contributions not in line with it (tl;dr be an empathetic, considerate person) will not be accepted. Please notify @chartgerink if anything happens.
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.
npm run release
will 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):
Julian Gruber 🚧 💻 |
nehamoopen 🤔 |
Chris Hartgerink 🤔 |
This project follows the all-contributors specification. Contributions of any kind welcome!