{"version":"0.3.4","commands":{"load":{"id":"load","description":"Loads a DID from the directory using the friendly name.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion load FriendlyName","$ ion load FriendlyName -d d:/dids","$ ion load FriendlyName -d d:/dids --escape"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"to which the DID should be saved. Defaults to environment variable DID_PATH if set.","required":true},"what":{"name":"what","type":"option","description":"specify the objects from the specified package to load.","helpValue":"(All|InitialState|Keys)","options":["All","InitialState","Keys"],"default":"All"},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false}},"args":[{"name":"name","description":"name for the new DID. Name should not include spaces or special characters.","required":true}]},"new":{"id":"new","description":"Creates a new ION DID with either defaults or the specified input.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion new FriendlyName","$ ion new FriendlyName -d d:/dids","$ ion new FriendlyName -d d:/dids --curve secp256k1 --kid key-1","$ ion new FriendlyName -d d:/dids --input {ESCAPED JSON STRING} --jwk {ESCAPED PRIVATE KEY JWK}"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"to which the DID package should be saved. Defaults to environment variable DID_PATH if set."},"curve":{"name":"curve","type":"option","char":"c","description":"specify the elliptic curve to use for the keys.","helpValue":"(secp256k1|Ed25519)","options":["secp256k1","Ed25519"],"default":"secp256k1"},"kid":{"name":"kid","type":"option","description":" for the key pair.","default":"key-1"},"input":{"name":"input","type":"option","description":"specifies the input to use when generating the ION DID."},"jwk":{"name":"jwk","type":"option","description":"specifies the private key for the DID."},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false}},"args":[{"name":"name","description":"name for the new DID. Name should not include spaces or special characters.","required":true}]},"publish":{"id":"publish","description":"Publishes the specified DID to the ION network.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion publish {ESCAPED INITIAL STATE} --friendlyName={FRIENDLY_NAME}"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"to which the DID should be saved. Defaults to environment variable DID_PATH if set.","required":false},"friendlyName":{"name":"friendlyName","type":"option","description":"specifies the friendly name of the DID to load and publish.","required":false}},"args":[{"name":"initialState","description":"the initial state of the DID being published.","required":false}]},"resolve":{"id":"resolve","description":"Resolves the provided DID and outputs the document to the console, optionally caching the DID state.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion resolve did:ion:EiB29JB4R0mbLmJ6_BEYjr8bGZKEPABwFopSNsDJBh_Diw","$ ion resolve did:ion:EiB29JB4R0mbLmJ6_BEYjr8bGZKEPABwFopSNsDJBh_Diw --node https://some.node --escape","$ ion resolve did:ion:EiB29JB4R0mbLmJ6_BEYjr8bGZKEPABwFopSNsDJBh_Diw --node https://some.node --cache","$ ion resolve did:ion:EiB29JB4R0mbLmJ6_BEYjr8bGZKEPABwFopSNsDJBh_Diw --node https://some.node --cache --cacheTtl 60 --name SomeDID"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"to which the DID package should be saved. Defaults to environment variable DID_PATH if set."},"node":{"name":"node","type":"option","description":"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."},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false},"name":{"name":"name","type":"option","description":"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."},"cacheTtl":{"name":"cacheTtl","type":"option","description":"specifies the time to live (ttl) for a cached document in in seconds.","default":86400},"cache":{"name":"cache","type":"boolean","description":"specifies that the resolved document should be cached in the specified directory and if cached read from the directory.","allowNo":false}},"args":[{"name":"DID","description":"The DID to resolve","required":true}]},"sign":{"id":"sign","description":"Sign payload using the private key associated with the specified DID.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion sign 'Hello World' FriendlyName -d d:/dids","$ ion sign 'Hello World' FriendlyName -d d:/dids -k 'key-1'","$ ion sign 'Hello World' FriendlyName -d d:/dids -k 'key-1' -s","$ ion sign 'Hello World' FriendlyName -d d:/dids -k 'key-1' -s -n https://node.local/1.0/identifiers/"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"from which to read DID and key. Defaults to environment variable DID_PATH if set.","required":true},"kid":{"name":"kid","type":"option","char":"k","description":" of the private key to use for signing.","required":false,"default":"key-1"},"detached":{"name":"detached","type":"boolean","char":"s","description":"flag indicating a payload-detached JWS should be output. Default is false.","allowNo":false}},"args":[{"name":"payload","description":"to sign","required":true},{"name":"friendlyName","description":"of the DID to use to sign the payload","required":true}]},"verify":{"id":"verify","description":"Verify payload using the private key associated with the specified DID.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion verify '2tleS0xIiwiYWxnIjoiRVMyNTZLIn0..D7kXXnQmtSw1WX1RCW3IzA6T5-qivSOL2_6RVydIo1Z_wXKO00GEUl2xjwvRpHlr4B7jBy1_PZenCNP9_mWx1Q' '{ESCAPED DID DOCUMENT}' 'hello world' -k '#key-1'"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"kid":{"name":"kid","type":"option","description":" identifier of the public key to use for verifying.","required":false}},"args":[{"name":"jws","description":"signature to verify.","required":true},{"name":"document","description":"the escaped DID document of the entity that signed the payload.","required":true},{"name":"payload","description":"when verifying a payload-detached JWS","required":false}]},"cache:clear":{"id":"cache:clear","description":"Clears the DID cache, removing all previously resolved DIDs.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion cache:clear -d d:dids"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"that contains the cache. Defaults to environment variable DID_PATH if set.","required":true}},"args":[]},"cache:list":{"id":"cache:list","description":"Lists the cached DIDs.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion cache:list -d d:dids"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"directory":{"name":"directory","type":"option","char":"d","description":"that contains the cache. Defaults to environment variable DID_PATH if set.","required":true},"columns":{"name":"columns","type":"option","description":"only show provided columns (comma-separated)"},"sort":{"name":"sort","type":"option","description":"property to sort by (prepend '-' for descending)"},"filter":{"name":"filter","type":"option","description":"filter property by partial string matching, ex: name=foo"},"csv":{"name":"csv","type":"boolean","description":"output is csv format [alias: --output=csv]","allowNo":false},"output":{"name":"output","type":"option","description":"output in a more machine friendly format","options":["csv","json","yaml"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"show extra columns","allowNo":false},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false},"no-header":{"name":"no-header","type":"boolean","description":"hide table header from output","allowNo":false}},"args":[]},"key:new":{"id":"key:new","description":"Creates a new elliptic curve key for the specified curve, returning a JSON serialized and optionally escaped representation.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion key:new key-1","$ ion key:new key-1 --curve secp256k1","$ ion key:new key-1 --curve secp256k1 --escape"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"curve":{"name":"curve","type":"option","description":"specifies the elliptic curve to use for the keys.","helpValue":"(secp256k1|Ed25519)","options":["secp256k1","Ed25519"],"default":"secp256k1"},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false}},"args":[{"name":"kid","description":"identifier for the key (kid).","required":false,"default":"key-1"}]},"key:public":{"id":"key:public","description":"Returns the public key JWK.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion key:public {ESCAPED JSON STRING}","$ ion key:public {ESCAPED JSON STRING} --escape"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false}},"args":[{"name":"jwk","description":"an escaped JSON string containing the private key jwk.","required":true}]},"operation:create":{"id":"operation:create","description":"Creates a payload for generating a new ION DID.","pluginName":"@decentralized-identity/ion-cli","pluginType":"core","aliases":[],"examples":["$ ion operation:create {ESCAPED KEY}","$ ion operation:create {ESCAPED KEY} {ESCAPED SERVICES} --escape"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"escape":{"name":"escape","type":"boolean","description":"specifies that the output JSON string should be escaped. Use this when using the output as input to another command.","allowNo":false}},"args":[{"name":"key","description":"specifies the public key to use for the create operation.","required":true},{"name":"services","description":"specifies any services to be included in the create operation.","required":false}]}}}