Secret Store admin

Secret Store admin command-line tool called ssadmin, and JS package.

It was made for easier interaction with the Secret Store related permissioning and node-set contracts found here: https://github.com/energywebfoundation/secretstore-contracts.

Maintainers

Primary: Adam Nagy (@ngyam)

Quickstart

npm install -g secretstore-admin

Then just use the --help flag for further instructions.

ssadmin --help

> ssadmin <command>

Commands:
  ssadmin nodes <command>       Execute secret store node/cluster config
                                 related functions.
  ssadmin permission <command>  Execute permissioning (registry) related
                                 functions.

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

You can invoke --help for each command separately.

ssadmin permission --help

> ssadmin permission <command>

Execute permissioning (registry) related functions.

Commands:
  ssadmin permission create <contract>     Add new permission. Overwrites
  <documentID> [options]                    existing one if you are the owner.
  ssadmin permission entry <command>       Modify the values of an existing
                                            permissioning entry.
  ssadmin permission query <command>       Query info from a permissioning
                                            registry contract.
  ssadmin permission relay <command>       Interact with a permissioning relay
                                            contract.
  ssadmin permission remove <contract>     Remove an existing permission. You
  <documentID> [options]                    have the be the owner/entry owner.

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Contributing

Please read contributing and our code of conduct for details.

Getting started (as a dev)

Prerequisites

• node, npm

Installing

git clone https://github.com/energywebfoundation/secretstore-admin.git
cd secretstore-admin
npm install -D

Testing

Manually so far.

Versioning

We use SemVer for versioning.

License

This project is licensed under GPLv3 - see the LICENSE file for details.