@twin.org/identity-cli 0.0.1-next.8 → 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/bin/index.js +0 -0
  2. package/dist/cjs/index.cjs +361 -272
  3. package/dist/esm/index.mjs +359 -275
  4. package/dist/locales/en.json +878 -779
  5. package/dist/types/commands/identityCreate.d.ts +6 -0
  6. package/dist/types/commands/identityResolve.d.ts +5 -0
  7. package/dist/types/commands/proofCreate.d.ts +6 -1
  8. package/dist/types/commands/proofVerify.d.ts +9 -7
  9. package/dist/types/commands/serviceAdd.d.ts +4 -0
  10. package/dist/types/commands/serviceRemove.d.ts +5 -0
  11. package/dist/types/commands/setupCommands.d.ts +31 -0
  12. package/dist/types/commands/verifiableCredentialCreate.d.ts +4 -0
  13. package/dist/types/commands/verifiableCredentialRevoke.d.ts +5 -0
  14. package/dist/types/commands/verifiableCredentialUnrevoke.d.ts +5 -0
  15. package/dist/types/commands/verifiableCredentialVerify.d.ts +4 -0
  16. package/dist/types/commands/verificationMethodAdd.d.ts +4 -0
  17. package/dist/types/commands/verificationMethodRemove.d.ts +5 -0
  18. package/dist/types/index.d.ts +3 -0
  19. package/dist/types/models/identityConnectorTypes.d.ts +13 -0
  20. package/dist/types/models/identityResolverConnectorTypes.d.ts +13 -0
  21. package/docs/changelog.md +308 -1
  22. package/docs/examples.md +14 -12
  23. package/docs/reference/classes/CLI.md +14 -8
  24. package/docs/reference/functions/actionCommandIdentityCreate.md +3 -1
  25. package/docs/reference/functions/actionCommandIdentityResolve.md +3 -1
  26. package/docs/reference/functions/actionCommandProofCreate.md +3 -1
  27. package/docs/reference/functions/actionCommandProofVerify.md +3 -1
  28. package/docs/reference/functions/actionCommandServiceAdd.md +3 -1
  29. package/docs/reference/functions/actionCommandServiceRemove.md +25 -5
  30. package/docs/reference/functions/actionCommandVerifiableCredentialCreate.md +3 -1
  31. package/docs/reference/functions/actionCommandVerifiableCredentialRevoke.md +25 -5
  32. package/docs/reference/functions/actionCommandVerifiableCredentialUnrevoke.md +25 -5
  33. package/docs/reference/functions/actionCommandVerifiableCredentialVerify.md +3 -1
  34. package/docs/reference/functions/actionCommandVerificationMethodAdd.md +3 -1
  35. package/docs/reference/functions/actionCommandVerificationMethodRemove.md +25 -5
  36. package/docs/reference/functions/setupIdentityConnector.md +47 -0
  37. package/docs/reference/functions/setupIdentityResolverConnector.md +35 -0
  38. package/docs/reference/functions/setupVault.md +9 -0
  39. package/docs/reference/index.md +13 -0
  40. package/docs/reference/type-aliases/IdentityConnectorTypes.md +5 -0
  41. package/docs/reference/type-aliases/IdentityResolverConnectorTypes.md +5 -0
  42. package/docs/reference/variables/IdentityConnectorTypes.md +13 -0
  43. package/docs/reference/variables/IdentityResolverConnectorTypes.md +13 -0
  44. package/locales/en.json +39 -27
  45. package/package.json +21 -21
package/docs/changelog.md CHANGED
@@ -1,5 +1,312 @@
1
1
  # @twin.org/identity-cli - Changelog
2
2
 
3
- ## v0.0.1-next.8
3
+ ## 0.0.1 (2025-07-08)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([8450ad7](https://github.com/twinfoundation/identity/commit/8450ad727e0c4d665f2ce483e41798c2ff5b7d55))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/identity-models bumped from ^0.0.0 to ^0.0.1
16
+ * @twin.org/identity-connector-iota bumped from ^0.0.0 to ^0.0.1
17
+
18
+ ## [0.0.1-next.57](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.56...identity-cli-v0.0.1-next.57) (2025-07-08)
19
+
20
+
21
+ ### Miscellaneous Chores
22
+
23
+ * **identity-cli:** Synchronize repo versions
24
+
25
+
26
+ ### Dependencies
27
+
28
+ * The following workspace dependencies were updated
29
+ * dependencies
30
+ * @twin.org/identity-models bumped from 0.0.1-next.56 to 0.0.1-next.57
31
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.56 to 0.0.1-next.57
32
+
33
+ ## [0.0.1-next.56](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.55...identity-cli-v0.0.1-next.56) (2025-06-30)
34
+
35
+
36
+ ### Miscellaneous Chores
37
+
38
+ * **identity-cli:** Synchronize repo versions
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/identity-models bumped from 0.0.1-next.55 to 0.0.1-next.56
46
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.55 to 0.0.1-next.56
47
+
48
+ ## [0.0.1-next.55](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.54...identity-cli-v0.0.1-next.55) (2025-06-26)
49
+
50
+
51
+ ### Features
52
+
53
+ * add mainnet support ([af56a38](https://github.com/twinfoundation/identity/commit/af56a382837896cd4e13d5814c0924c46658b99c))
54
+ * identity key separator use slash ([1319d0d](https://github.com/twinfoundation/identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
55
+ * iota rebased release ([5d14674](https://github.com/twinfoundation/identity/commit/5d146744ca9eed622ef7eb34a7fa935216f9e975))
56
+ * support mainnet for alias extraction ([1114e0f](https://github.com/twinfoundation/identity/commit/1114e0f518070ef930d7d6ed73a616cce647206c))
57
+ * use new generateKid method ([f0fe779](https://github.com/twinfoundation/identity/commit/f0fe779323b675575bb9f80aa74f1957dc57a094))
58
+ * use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
59
+ * verification method output JWK and hex on CLI ([49db9da](https://github.com/twinfoundation/identity/commit/49db9da2371eafdcd7176ce44303961b9b8b8380))
60
+
61
+
62
+ ### Bug Fixes
63
+
64
+ * explorer urls in CLI ([82a745d](https://github.com/twinfoundation/identity/commit/82a745d536e8fe42554e7ad92a7468a653fc0cfb))
65
+ * Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
66
+ * Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
67
+
68
+
69
+ ### Dependencies
70
+
71
+ * The following workspace dependencies were updated
72
+ * dependencies
73
+ * @twin.org/identity-models bumped from 0.0.1-next.54 to 0.0.1-next.55
74
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.54 to 0.0.1-next.55
75
+
76
+ ## [0.0.1-next.54](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.53...identity-cli-v0.0.1-next.54) (2025-06-26)
77
+
78
+
79
+ ### Miscellaneous Chores
80
+
81
+ * **identity-cli:** Synchronize repo versions
82
+
83
+
84
+ ### Dependencies
85
+
86
+ * The following workspace dependencies were updated
87
+ * dependencies
88
+ * @twin.org/identity-models bumped from 0.0.1-next.53 to 0.0.1-next.54
89
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.53 to 0.0.1-next.54
90
+
91
+ ## [0.0.1-next.53](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.52...identity-cli-v0.0.1-next.53) (2025-06-23)
92
+
93
+
94
+ ### Miscellaneous Chores
95
+
96
+ * **identity-cli:** Synchronize repo versions
97
+
98
+
99
+ ### Dependencies
100
+
101
+ * The following workspace dependencies were updated
102
+ * dependencies
103
+ * @twin.org/identity-models bumped from 0.0.1-next.52 to 0.0.1-next.53
104
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.52 to 0.0.1-next.53
105
+
106
+ ## [0.0.1-next.52](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.51...identity-cli-v0.0.1-next.52) (2025-06-20)
107
+
108
+
109
+ ### Miscellaneous Chores
110
+
111
+ * **identity-cli:** Synchronize repo versions
112
+
113
+
114
+ ### Dependencies
115
+
116
+ * The following workspace dependencies were updated
117
+ * dependencies
118
+ * @twin.org/identity-models bumped from 0.0.1-next.51 to 0.0.1-next.52
119
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.51 to 0.0.1-next.52
120
+
121
+ ## [0.0.1-next.51](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.50...identity-cli-v0.0.1-next.51) (2025-06-19)
122
+
123
+
124
+ ### Features
125
+
126
+ * support mainnet for alias extraction ([1114e0f](https://github.com/twinfoundation/identity/commit/1114e0f518070ef930d7d6ed73a616cce647206c))
127
+
128
+
129
+ ### Dependencies
130
+
131
+ * The following workspace dependencies were updated
132
+ * dependencies
133
+ * @twin.org/identity-models bumped from 0.0.1-next.50 to 0.0.1-next.51
134
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.50 to 0.0.1-next.51
135
+
136
+ ## [0.0.1-next.50](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.49...identity-cli-v0.0.1-next.50) (2025-06-19)
137
+
138
+
139
+ ### Features
140
+
141
+ * use new generateKid method ([f0fe779](https://github.com/twinfoundation/identity/commit/f0fe779323b675575bb9f80aa74f1957dc57a094))
142
+
143
+
144
+ ### Dependencies
145
+
146
+ * The following workspace dependencies were updated
147
+ * dependencies
148
+ * @twin.org/identity-models bumped from 0.0.1-next.49 to 0.0.1-next.50
149
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.49 to 0.0.1-next.50
150
+
151
+ ## [0.0.1-next.49](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.48...identity-cli-v0.0.1-next.49) (2025-06-18)
152
+
153
+
154
+ ### Features
155
+
156
+ * verification method output JWK and hex on CLI ([49db9da](https://github.com/twinfoundation/identity/commit/49db9da2371eafdcd7176ce44303961b9b8b8380))
157
+
158
+
159
+ ### Dependencies
160
+
161
+ * The following workspace dependencies were updated
162
+ * dependencies
163
+ * @twin.org/identity-models bumped from 0.0.1-next.48 to 0.0.1-next.49
164
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.48 to 0.0.1-next.49
165
+
166
+ ## [0.0.1-next.48](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.47...identity-cli-v0.0.1-next.48) (2025-06-17)
167
+
168
+
169
+ ### Features
170
+
171
+ * add mainnet support ([af56a38](https://github.com/twinfoundation/identity/commit/af56a382837896cd4e13d5814c0924c46658b99c))
172
+
173
+
174
+ ### Dependencies
175
+
176
+ * The following workspace dependencies were updated
177
+ * dependencies
178
+ * @twin.org/identity-models bumped from 0.0.1-next.47 to 0.0.1-next.48
179
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.47 to 0.0.1-next.48
180
+
181
+ ## [0.0.1-next.47](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.46...identity-cli-v0.0.1-next.47) (2025-06-12)
182
+
183
+
184
+ ### Features
185
+
186
+ * identity key separator use slash ([1319d0d](https://github.com/twinfoundation/identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
187
+
188
+
189
+ ### Dependencies
190
+
191
+ * The following workspace dependencies were updated
192
+ * dependencies
193
+ * @twin.org/identity-models bumped from 0.0.1-next.46 to 0.0.1-next.47
194
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.46 to 0.0.1-next.47
195
+
196
+ ## [0.0.1-next.46](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.45...identity-cli-v0.0.1-next.46) (2025-05-20)
197
+
198
+
199
+ ### Features
200
+
201
+ * iota rebased release ([5d14674](https://github.com/twinfoundation/identity/commit/5d146744ca9eed622ef7eb34a7fa935216f9e975))
202
+ * use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
203
+
204
+
205
+ ### Bug Fixes
206
+
207
+ * explorer urls in CLI ([82a745d](https://github.com/twinfoundation/identity/commit/82a745d536e8fe42554e7ad92a7468a653fc0cfb))
208
+ * Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
209
+ * Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
210
+
211
+
212
+ ### Dependencies
213
+
214
+ * The following workspace dependencies were updated
215
+ * dependencies
216
+ * @twin.org/identity-models bumped from 0.0.1-next.45 to 0.0.1-next.46
217
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.45 to 0.0.1-next.46
218
+
219
+ ## [0.0.1-next.45](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.44...identity-cli-v0.0.1-next.45) (2025-05-06)
220
+
221
+
222
+ ### Features
223
+
224
+ * iota rebased release ([5d14674](https://github.com/twinfoundation/identity/commit/5d146744ca9eed622ef7eb34a7fa935216f9e975))
225
+
226
+
227
+ ### Dependencies
228
+
229
+ * The following workspace dependencies were updated
230
+ * dependencies
231
+ * @twin.org/identity-models bumped from 0.0.1-next.44 to 0.0.1-next.45
232
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.44 to 0.0.1-next.45
233
+
234
+ ## [0.0.1-next.44](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.43...identity-cli-v0.0.1-next.44) (2025-04-30)
235
+
236
+
237
+ ### Miscellaneous Chores
238
+
239
+ * **identity-cli:** Synchronize repo versions
240
+
241
+
242
+ ### Dependencies
243
+
244
+ * The following workspace dependencies were updated
245
+ * dependencies
246
+ * @twin.org/identity-models bumped from 0.0.1-next.43 to 0.0.1-next.44
247
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.43 to 0.0.1-next.44
248
+
249
+ ## [0.0.1-next.43](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.42...identity-cli-v0.0.1-next.43) (2025-04-25)
250
+
251
+
252
+ ### Bug Fixes
253
+
254
+ * explorer urls in CLI ([82a745d](https://github.com/twinfoundation/identity/commit/82a745d536e8fe42554e7ad92a7468a653fc0cfb))
255
+
256
+
257
+ ### Dependencies
258
+
259
+ * The following workspace dependencies were updated
260
+ * dependencies
261
+ * @twin.org/identity-models bumped from 0.0.1-next.42 to 0.0.1-next.43
262
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.42 to 0.0.1-next.43
263
+
264
+ ## [0.0.1-next.42](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.41...identity-cli-v0.0.1-next.42) (2025-04-17)
265
+
266
+
267
+ ### Features
268
+
269
+ * use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
270
+
271
+
272
+ ### Dependencies
273
+
274
+ * The following workspace dependencies were updated
275
+ * dependencies
276
+ * @twin.org/identity-models bumped from 0.0.1-next.41 to 0.0.1-next.42
277
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.41 to 0.0.1-next.42
278
+
279
+ ## [0.0.1-next.41](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.40...identity-cli-v0.0.1-next.41) (2025-04-09)
280
+
281
+
282
+ ### Miscellaneous Chores
283
+
284
+ * **identity-cli:** Synchronize repo versions
285
+
286
+
287
+ ### Dependencies
288
+
289
+ * The following workspace dependencies were updated
290
+ * dependencies
291
+ * @twin.org/identity-models bumped from 0.0.1-next.40 to 0.0.1-next.41
292
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.40 to 0.0.1-next.41
293
+
294
+ ## [0.0.1-next.40](https://github.com/twinfoundation/identity/compare/identity-cli-v0.0.1-next.39...identity-cli-v0.0.1-next.40) (2025-03-28)
295
+
296
+
297
+ ### Bug Fixes
298
+
299
+ * Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
300
+ * Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
301
+
302
+
303
+ ### Dependencies
304
+
305
+ * The following workspace dependencies were updated
306
+ * dependencies
307
+ * @twin.org/identity-models bumped from 0.0.1-next.39 to 0.0.1-next.40
308
+ * @twin.org/identity-connector-iota bumped from 0.0.1-next.39 to 0.0.1-next.40
309
+
310
+ ## v0.0.1-next.39
4
311
 
5
312
  - Initial Release
package/docs/examples.md CHANGED
@@ -64,7 +64,7 @@ Creates a Decentralized Identifier (DID).
64
64
 
65
65
  Options:
66
66
  --seed <seed> The seed for the controller address in hex or base64 used to create the DID, or start with ! to read environment variable.
67
- --controller <controller> The address which controls the identity in bech32 format, or start with ! to read environment variable.
67
+ --address-index <index> The address index to use for the creation. (default: "0")
68
68
  --no-console Hides the output in the console.
69
69
  --json <filename> Creates a JSON file containing the output.
70
70
  --merge-json If the JSON file already exists merge the data instead of overwriting.
@@ -81,7 +81,7 @@ The commands `mnemonic`, `address`, `faucet` and `transfer` are described in mor
81
81
 
82
82
  ### identity-create
83
83
 
84
- Use this command to create a new DID, the controller address must have sufficient funds to store the identity. The seed and the funds can be generated using the `mnemonic` and `faucet` commands.
84
+ Use this command to create a new DID, the wallet address must have sufficient funds to store the identity. The seed and the funds can be generated using the `mnemonic` and `faucet` commands.
85
85
 
86
86
  ```shell
87
87
  # Generate a seed and mnemonic and store it in the env file
@@ -93,18 +93,20 @@ twin-identity address --load-env wallet.env --hrp tst --seed !SEED --count 4 --e
93
93
  To run this on the IOTA testnet you will need an env file with the following settings. Store the following config as config.env
94
94
 
95
95
  ```shell
96
- NODE_URL="https://api.testnet.iotaledger.net"
97
- FAUCET_URL="https://faucet.testnet.iotaledger.net/api/enqueue"
98
- EXPLORER_URL="https://explorer.iota.org/iota-testnet/"
96
+ NODE_URL="https://api.devnet.iota.cafe"
97
+ FAUCET_URL="https://faucet.devnet.iota.cafe"
98
+ COIN_TYPE="4218"
99
+ NETWORK="devnet"
100
+ EXPLORER_URL="https://explorer.iota.org/"
99
101
  ```
100
102
 
101
103
  To then request some funds and generate the identity you can issue the following commands:
102
104
 
103
105
  ```shell
104
- # Fund the controller address from the faucet loading the config and wallet env files
105
- twin-identity faucet --load-env config.env wallet.env --address !ADDRESS_0_BECH32
106
+ # Fund the wallet address from the faucet loading the config and wallet env files
107
+ twin-identity faucet --load-env config.env wallet.env --address !ADDRESS_0
106
108
  # Create an identity
107
- twin-identity identity-create --load-env config.env wallet.env --seed !SEED --controller !ADDRESS_0_BECH32 --env identity.env
109
+ twin-identity identity-create --load-env config.env wallet.env --seed !SEED --env identity.env
108
110
  ```
109
111
 
110
112
  ### identity-resolve
@@ -197,15 +199,15 @@ twin-identity verifiable-credential-unrevoke --load-env config.env wallet.env id
197
199
  This command will generate a proof using the specified verification method.
198
200
 
199
201
  ```shell
200
- twin-identity proof-create --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --private-key !DID_VERIFICATION_METHOD_PRIVATE_KEY --data aGVsbG8gd29ybGQ=
202
+ twin-identity proof-create --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --private-key !DID_VERIFICATION_METHOD_PRIVATE_KEY --document-filename unsecured.json --json data-proof.json
201
203
  ```
202
204
 
203
- This will output the proof as a set of data containing the type and a value in base64.
205
+ This will output the proof.
204
206
 
205
207
  ## proof-verify
206
208
 
207
- This command will verify a proof using the specified verification method.
209
+ This command will verify a proof for a document.
208
210
 
209
211
  ```shell
210
- twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --data aGVsbG8gd29ybGQ= --type Ed25519 --value lrPdZ+Gfgc8w/ha2YU7hil8s+gykFHAdmIEdJdraWeRkkb8nHHF1PLKs4gGPXCT1mqBIwiwOgz5V0JKIg00UDg==
212
+ twin-identity proof-verify --load-env config.env verification-method.env --id !DID_VERIFICATION_METHOD_ID --document-filename unsecured.json --proof-filename data-proof.json
211
213
  ```
@@ -8,13 +8,13 @@ The main entry point for the CLI.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new CLI()
11
+ ### Constructor
12
12
 
13
- > **new CLI**(): [`CLI`](CLI.md)
13
+ > **new CLI**(): `CLI`
14
14
 
15
15
  #### Returns
16
16
 
17
- [`CLI`](CLI.md)
17
+ `CLI`
18
18
 
19
19
  #### Inherited from
20
20
 
@@ -24,25 +24,31 @@ The main entry point for the CLI.
24
24
 
25
25
  ### run()
26
26
 
27
- > **run**(`argv`, `localesDirectory`?, `options`?): `Promise`\<`number`\>
27
+ > **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
28
28
 
29
29
  Run the app.
30
30
 
31
31
  #### Parameters
32
32
 
33
- **argv**: `string`[]
33
+ ##### argv
34
+
35
+ `string`[]
34
36
 
35
37
  The process arguments.
36
38
 
37
- **localesDirectory?**: `string`
39
+ ##### localesDirectory?
40
+
41
+ `string`
38
42
 
39
43
  The directory for the locales, default to relative to the script.
40
44
 
41
- **options?**
45
+ ##### options?
42
46
 
43
47
  Additional options for the CLI.
44
48
 
45
- **options.overrideOutputWidth?**: `number`
49
+ ###### overrideOutputWidth?
50
+
51
+ `number`
46
52
 
47
53
  The override output width.
48
54
 
@@ -6,7 +6,9 @@ Action the identity create command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,7 +6,9 @@ Action the identity resolve command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,7 +6,9 @@ Action the proof create command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,7 +6,9 @@ Action the proof verify command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,7 +6,9 @@ Action the service add command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,23 +6,43 @@ Action the service remove command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**
9
+ ### opts
10
10
 
11
11
  The options for the command.
12
12
 
13
- **opts.seed**: `string`
13
+ #### seed
14
+
15
+ `string`
14
16
 
15
17
  The private key for the controller.
16
18
 
17
- **opts.id**: `string`
19
+ #### id
20
+
21
+ `string`
18
22
 
19
23
  The id of the service to remove.
20
24
 
21
- **opts.node**: `string`
25
+ #### connector?
26
+
27
+ `"iota"`
28
+
29
+ The connector to perform the operations with.
30
+
31
+ #### node
32
+
33
+ `string`
22
34
 
23
35
  The node URL.
24
36
 
25
- **opts.explorer**: `string`
37
+ #### network?
38
+
39
+ `string`
40
+
41
+ The network to use for connector.
42
+
43
+ #### explorer
44
+
45
+ `string`
26
46
 
27
47
  The explorer URL.
28
48
 
@@ -6,7 +6,9 @@ Action the verifiable credential create command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,26 +6,46 @@ Action the verifiable credential revoke command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**
9
+ ### opts
10
10
 
11
11
  The options for the command.
12
12
 
13
- **opts.seed**: `string`
13
+ #### seed
14
+
15
+ `string`
14
16
 
15
17
  The seed to generate the private key for the controller.
16
18
 
17
- **opts.did**: `string`
19
+ #### did
20
+
21
+ `string`
18
22
 
19
23
  The id of the document to revoke the index.
20
24
 
21
- **opts.revocationIndex**: `string`
25
+ #### revocationIndex
26
+
27
+ `string`
22
28
 
23
29
  The revocation index for the credential.
24
30
 
25
- **opts.node**: `string`
31
+ #### connector?
32
+
33
+ `"iota"`
34
+
35
+ The connector to perform the operations with.
36
+
37
+ #### node
38
+
39
+ `string`
26
40
 
27
41
  The node URL.
28
42
 
43
+ #### network?
44
+
45
+ `string`
46
+
47
+ The network to use for connector.
48
+
29
49
  ## Returns
30
50
 
31
51
  `Promise`\<`void`\>
@@ -6,26 +6,46 @@ Action the verifiable credential unrevoke command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**
9
+ ### opts
10
10
 
11
11
  The options for the command.
12
12
 
13
- **opts.seed**: `string`
13
+ #### seed
14
+
15
+ `string`
14
16
 
15
17
  The seed to generate the private key for the controller.
16
18
 
17
- **opts.did**: `string`
19
+ #### did
20
+
21
+ `string`
18
22
 
19
23
  The id of the document to unrevoke the index.
20
24
 
21
- **opts.revocationIndex**: `string`
25
+ #### revocationIndex
26
+
27
+ `string`
22
28
 
23
29
  The revocation index for the credential.
24
30
 
25
- **opts.node**: `string`
31
+ #### connector?
32
+
33
+ `"iota"`
34
+
35
+ The connector to perform the operations with.
36
+
37
+ #### node
38
+
39
+ `string`
26
40
 
27
41
  The node URL.
28
42
 
43
+ #### network?
44
+
45
+ `string`
46
+
47
+ The network to use for connector.
48
+
29
49
  ## Returns
30
50
 
31
51
  `Promise`\<`void`\>
@@ -6,7 +6,9 @@ Action the verifiable credential verify command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14
 
@@ -6,7 +6,9 @@ Action the verification method add command.
6
6
 
7
7
  ## Parameters
8
8
 
9
- **opts**: `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
9
+ ### opts
10
+
11
+ `object` & `ICliOutputOptionsConsole` & `ICliOutputOptionsEnv` & `ICliOutputOptionsJson`
10
12
 
11
13
  The options for the command.
12
14