Skip to content
The Hypergraph Command Line Interface
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
.gitignore Add initial skeleton Jun 10, 2019
.travis.yml
CODE_OF_CONDUCT.md Update README, add CoC Jun 11, 2019
LICENSE
README.md
package-lock.json 0.2.0-beta Oct 17, 2019
package.json 0.2.0-beta Oct 17, 2019
test.js rename init->create, get->read Oct 17, 2019

README.md

Hypergraph CLI

NPM

Build Status JavaScript Style Guide Code Style Prettier Standard

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 🎹).

Installation

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 install node.

Usage

$ 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 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.

Contributing

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.

You can’t perform that action at this time.