Skip to content

Commit 587e940

Browse files
authored
Update README.md
1 parent 481ff00 commit 587e940

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ export INDEXING_RETRY_INTERVAL='3000'
8787
export AVOID_LOOP_RUN='true/false'
8888
```
8989

90+
- Optional, set SSI_WALLET_API and SSI_WALLET_ID to support v5 DDOs (assets using credentialSubject and SSI policy flows).
91+
92+
```
93+
export SSI_WALLET_API="https://your-ssi-wallet.example/api"
94+
export SSI_WALLET_ID="did:example:your-wallet-did-or-id"
95+
```
96+
9097

9198

9299
### Build the TypeScript code
@@ -183,23 +190,29 @@ npm run cli <command> [options] <arguments>
183190
**Download:**
184191

185192
- **Positional:**
186-
`npm run cli download did:op:123 ./custom-folder`
193+
`npm run cli download did:op:123 ./custom-folder serviceId`
187194

188195
- **Named Options:**
189-
`npm run cli download --did did:op:123 --folder ./custom-folder`
196+
`npm run cli download --did did:op:123 --folder ./custom-folder --service serviceId`
190197
(Order of `--did` and `--folder` does not matter.)
191198

199+
- **Rules:**
200+
serviceId is optional. If omitted, the CLI defaults to the first available download service.
201+
192202
---
193203

194204
**Start Compute:**
195205

196206
- **Positional:**
197-
`npm run cli startCompute -- did1,did2 algoDid env1 maxJobDuration paymentToken resources --accept true`
207+
`npm run cli startCompute -- did1,did2 algoDid env1 maxJobDuration paymentToken resources svc1,svc2 algoServiceId`
198208

199209
- **Named Options:**
200-
`npm run cli startCompute --datasets did1,did2 --algo algoDid --env env1 --maxJobDuration maxJobDuration --token paymentToken --resources resources --accept true`
210+
`npm run cli startCompute --datasets did1,did2 --algo algoDid --env env1 --maxJobDuration maxJobDuration --token paymentToken --resources resources --accept true --services svc1,svc2 ----algo-service algoServiceId`
201211
(Options can be provided in any order.)
202212

213+
- **Rules:**
214+
serviceIds and algoServiceId are optional. If omitted, the CLI defaults to the first available service.
215+
203216

204217
- `maxJobDuration` is a required parameter an represents the time measured in seconds for job maximum execution, the payment is based on this maxJobDuration value, user needs to provide this.
205218
- `paymentToken` is required and represents the address of the token that is supported by the environment for processing the compute job payment. It can be retrieved from `getComputeEnvironments` command output.
@@ -215,7 +228,11 @@ e.g.: `'[{"id":"cpu","amount":3},{"id":"ram","amount":16772672536},{"id":"disk",
215228
`npm run cli startFreeCompute did1,did2 algoDid env1`
216229

217230
- **Named Options:**
218-
`npm run cli startFreeCompute --datasets did1,did2 --algo algoDid --env env1`
231+
`npm run cli startFreeCompute --datasets did1,did2 --algo algoDid --env env1 --services svc1,svc2 ----algo-service algoServiceId`
232+
(Options can be provided in any order.)
233+
234+
- **Rules:**
235+
serviceIds and algoServiceId are optional. If omitted, the CLI defaults to the first available service.`
219236
(Options can be provided in any order.)
220237

221238
---
@@ -293,6 +310,8 @@ e.g.: `'[{"id":"cpu","amount":3},{"id":"ram","amount":16772672536},{"id":"disk",
293310
- **download:**
294311
`-d, --did <did>`
295312
`-f, --folder [destinationFolder]` (Default: `.`)
313+
`-s, --service <serviceId>` (Optional, target a specific service)
314+
296315

297316
- **startCompute:**
298317
`-d, --datasets <datasetDids>`
@@ -303,11 +322,15 @@ e.g.: `'[{"id":"cpu","amount":3},{"id":"ram","amount":16772672536},{"id":"disk",
303322
`-t, --token <paymentToken>`
304323
`--resources <resources>`
305324
`--amountToDeposit <amountToDeposit>` (Id `''`, it will fallback to initialize compute payment amount.)
325+
`-s, --services [serviceIds]` (Optional, comma-separated; must match datasetDids length, positional 1–1)
326+
`-x, --algo-service [algoServiceId]` (Optional, override algorithm service)
306327

307328
- **startFreeCompute:**
308329
`-d, --datasets <datasetDids>`
309330
`-a, --algo <algoDid>`
310331
`-e, --env <computeEnvId>`
332+
`-s, --services [serviceIds]` (Optional, comma-separated; must match datasetDids length, positional 1–1)
333+
`-x, --algo-service [algoServiceId]` (Optional, override algorithm service)
311334

312335
- **getComputeEnvironments:**
313336

0 commit comments

Comments
 (0)