erickuhn19 / ion-cli

ION Command Line Interface to make working with the ION network and using ION DIDs easy peasy lemon squeezy

@decentralized-identity/ion-cli

ION Command Line Interface to make working with the ION network and using ION DIDs easy peasy lemon squeezy

• Usage
• Commands

• Usage
• Commands

Usage

$ npm install -g @decentralized-identity/ion-cli
$ ion COMMAND
running command...
$ ion (-v|--version|version)
@decentralized-identity/ion-cli/0.1.0 win32-x64 node-v14.15.3
$ ion --help [COMMAND]
USAGE
  $ ion COMMAND
...

$ npm install -g @decentralized-identity/ion-cli
$ ion COMMAND
running command...
$ ion (-v|--version|version)
@decentralized-identity/ion-cli/0.1.0 win32-x64 node-v14.17.6
$ ion --help [COMMAND]
USAGE
  $ ion COMMAND
...

Commands

• ion help [COMMAND]
• ion new
• ion resolve DID

ion help [COMMAND]

display help for ion

USAGE
  $ ion help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ion new

Creates a new ION DID, optionally publishes to the network and writes the key pair to a *.jwk file and the DID to a *.json file.

USAGE
  $ ion new

OPTIONS
  -c, --curve=(secp256k1|Ed25519)  [default: secp256k1] specify the elliptic curve to use for the keys.
  -d, --directory=directory        to which to save the *jwk and *.json files.
  -h, --help                       show CLI help

  -n, --node=node                  URI of the node you desire to contact for resolution. If you are running your own
                                   node, use this to pass in your node's resolution endpoint.

  -p, --publish                    flag indicating whether the DID should be published to the ION network. Default is
                                   false.

EXAMPLES
  $ ion new
  $ ion new -d d:/dids
  $ ion new -d d:/dids -c secp256k1
  $ ion new -d d:/dids -c secp256k1 -p
  $ ion new -d d:/dids -c secp256k1 -p -n https://node.local/1.0/identifiers/

See code: src/commands/new.ts

ion resolve DID

Resolves the provided DID and outputs the document to the console.

USAGE
  $ ion resolve DID

ARGUMENTS
  DID  The DID to resolve

OPTIONS
  -h, --help       show CLI help

  -n, --node=node  URI of the node you desire to contact for resolution. If you are running your own node, use this to
                   pass in your node's resolution endpoint.

EXAMPLE
  $ ion resolve did:ion:EiB29JB4R0mbLmJ6_BEYjr8bGZKEPABwFopSNsDJBh_Diw

See code: src/commands/resolve.ts

• ion help [COMMAND]
• ion new
• ion resolve [DID]

ion help [COMMAND]

display help for ion

USAGE
  $ ion help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ion new

creates a new ION DID and optionally publishes and writes the key pair to a *.jwk file and the DID to a *.did file to a specified directory.

USAGE
  $ ion new

OPTIONS
  --help see all commands in CLI
  --curve specify the elliptic curve to use for the keys. Default is 'secp256k1'
  --publish flag indicating whether the DID should be published to the ION network. Default is false.
  --directory to which to save the files.
  --node URI of the node you desire to contact for resolution. If you are running your own node, use this to pass in your node's resolution endpoint.

See code: @oclif/plugin-help

ion resolve [DID]

resolves the provided DID and outputs the document to the console.

USAGE
  $ ion resolve [DID]

ARGUMENTS
  DID  The ION identifier to resolve

OPTIONS
  --help see all commands in CLI
  --node URI of the node you desire to contact for resolution. If you are running your own node, use this to pass in your node's resolution endpoint.

See code: @oclif/plugin-help