ipdid
v0.1.1
Published
IPDID cli - Need to run with a ipfs node. (http://ipfs.io)
Downloads
14
Readme
ipdid
The IPDID ecosystem
Usage
$ npm install -g ipdid
$ ipdid COMMAND
running command...
$ ipdid (-v|--version|version)
ipdid/0.1.1 darwin-arm64 node-v16.0.0
$ ipdid --help [COMMAND]
USAGE
$ ipdid COMMAND
...
Commands
ipdid did
register a PDID to SKALE network and IPFS (IPLD) - use pipe only
USAGE
$ ipdid did
OPTIONS
-d, --ddoc=ddoc DID document
-f, --force force to register on ipfs block
DESCRIPTION
...
you can pipe any DID document to generate and register a DID
See code: src/commands/did.js
ipdid help [COMMAND]
display help for ipdid
USAGE
$ ipdid help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
ipdid init
create a new IPDID ipfs (deprecated)
USAGE
$ ipdid init
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
don't use this init command any more.
See code: src/commands/init.js
ipdid mydid
return your current DID
USAGE
$ ipdid mydid
OPTIONS
-q, --qrcode generate and show DID QR code (default: false)
DESCRIPTION
...
show your current DID code
See code: src/commands/mydid.js
ipdid qrcode
to generate a QR-code from your context or stdin
USAGE
$ ipdid qrcode
OPTIONS
-c, --context=context the context for generating a QR-code
DESCRIPTION
...
--context string
for example: ipdid qrcode -c 'test string'
or: echo 'test string' | ipdid qrcode
See code: src/commands/qrcode.js
ipdid signer
create a singer's key pair and save on ~/.ipdid_keystore.json
USAGE
$ ipdid signer
OPTIONS
--help show CLI help
DESCRIPTION
...
return your DID for signer if ~/.ipdid_keystore.json exist
otherwise, create a new one.
See code: src/commands/signer.js
ipdid vc
create a verifiable claim for a DID document
USAGE
$ ipdid vc
OPTIONS
-s, --school=school [default: Example School] user's school
-w, --who=who user's DID
DESCRIPTION
example, ipdid vc -w 'did:ipdid:z6MkiYiav3GskEZWgv2ZkeeFt8kWqnWRahv9d7pb8X2iEDEv'
...
return a claim DID for alumni of
See code: src/commands/vc.js