@ciphrix/cli 0.1.1 → 0.3.0

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.
@@ -28,12 +28,24 @@ Commands:
28
28
  framework Applied frameworks
29
29
  asset The asset register
30
30
  vendor Manage vendors
31
- control Controls: status, applicability, owner and design
32
- requirements
31
+ control Controls: status, applicability, ownership, design
32
+ requirements and advisory assessments
33
33
  document Browse, read and change documents
34
34
  risk Manage risks
35
35
  check Monitoring checks
36
36
  job Check background jobs started by other commands
37
+ user Active tenant-user discovery; no account administration
38
+ access Access inventory, reviewed imports and assigned
39
+ reviewer workflows
40
+ agent Agent activity, complete proposals and explicit human
41
+ decisions
42
+ task Your assigned stored work; discovery never completes
43
+ tasks
44
+ file Owned local-file staging and explicit processing; no
45
+ automatic downloads
46
+ onboarding [options] Learn organizational context, inspect optional setup
47
+ and explicitly complete the journey. Operating Context
48
+ does not block completion.
37
49
  Configuration:
38
50
  --api-url <url> override the API base URL for one command
39
51
  CIPHRIX_API_URL default API base URL for this process
@@ -172,7 +184,8 @@ Commands:
172
184
  to the current run)
173
185
  attach [options] <name> Attach evidence to a run (defaults to the current
174
186
  run)
175
- run Create, result and delete runs
187
+ run Run lifecycle, human results/notes, linked
188
+ evidence references and advisory assessments
176
189
  available [options] <name> List items available to attach to a run (defaults
177
190
  to the current run)
178
191
  links [options] <name> Show the controls and clauses a test covers
@@ -265,7 +278,8 @@ Options:
265
278
  ```text
266
279
  Usage: ciphrix test run [options] [command]
267
280
 
268
- Create, result and delete runs
281
+ Run lifecycle, human results/notes, linked evidence references and advisory
282
+ assessments
269
283
 
270
284
  Options:
271
285
  -h, --help display help for command
@@ -275,6 +289,10 @@ Commands:
275
289
  result [options] <name> Record a run result: passing | failing | skipped |
276
290
  pending (reopen)
277
291
  delete [options] <name> Delete a run
292
+ file [options] <name> Create a temporary reference for evidence linked to
293
+ this test/run; no automatic download.
294
+ assess [options] <name> Request advisory AI assessment; does not change the
295
+ human run result.
278
296
  help [command] display help for command
279
297
  ```
280
298
 
@@ -302,15 +320,18 @@ Usage: ciphrix test run result [options] <name>
302
320
  Record a run result: passing | failing | skipped | pending (reopen)
303
321
 
304
322
  Options:
305
- --status <status> passing | failing | skipped | pending
323
+ --status <status> human-decided result: passing | failing | skipped |
324
+ pending; omit for note-only changes
306
325
  --note <text> note for the run
326
+ --clear-note clear the note without changing the result; conflicts with
327
+ --note
307
328
  --run <id> a specific run
308
329
  --api-url <url> override the API base URL for this command
309
330
  --json output raw JSON
310
331
  -h, --help display help for command
311
332
  ```
312
333
 
313
- **Effect:** Records a formal test-run result; the CLI prompts if the API requests confirmation.
334
+ **Effect:** Records a human-decided result or changes/clears its note independently; a note-only update never changes the result.
314
335
 
315
336
  ## `ciphrix test run delete`
316
337
 
@@ -329,6 +350,53 @@ Options:
329
350
 
330
351
  **Effect:** Deletes the selected test run; the CLI asks for confirmation when required.
331
352
 
353
+ ## `ciphrix test run file`
354
+
355
+ ```text
356
+ Usage: ciphrix test run file [options] <name>
357
+
358
+ Create a temporary reference for evidence linked to this test/run; no automatic
359
+ download.
360
+
361
+ Options:
362
+ --attachment <value> evidence attachment ID belonging to the selected test
363
+ run
364
+ --run <value> existing run ID; omit to use the current run
365
+ --api-url <url> override the API base URL
366
+ --json emit one complete result/error envelope
367
+ --yes confirmed writes only: explicitly authorize without
368
+ prompting; rejected on reads/immediate writes
369
+ --idempotency-key <key> writes only: key for one logical operation; reuse
370
+ identical input, at most 256 characters
371
+ -h, --help display help for command
372
+
373
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
374
+ ```
375
+
376
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
377
+
378
+ ## `ciphrix test run assess`
379
+
380
+ ```text
381
+ Usage: ciphrix test run assess [options] <name>
382
+
383
+ Request advisory AI assessment; does not change the human run result.
384
+
385
+ Options:
386
+ --run <value> existing run ID; omit to use the current run
387
+ --api-url <url> override the API base URL
388
+ --json emit one complete result/error envelope
389
+ --yes confirmed writes only: explicitly authorize without
390
+ prompting; rejected on reads/immediate writes
391
+ --idempotency-key <key> writes only: key for one logical operation; reuse
392
+ identical input, at most 256 characters
393
+ -h, --help display help for command
394
+
395
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
396
+ ```
397
+
398
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
399
+
332
400
  ## `ciphrix test available`
333
401
 
334
402
  ```text
@@ -880,7 +948,8 @@ Options:
880
948
  ```text
881
949
  Usage: ciphrix control [options] [command]
882
950
 
883
- Controls: status, applicability, owner and design requirements
951
+ Controls: status, applicability, ownership, design requirements and advisory
952
+ assessments
884
953
 
885
954
  Options:
886
955
  -h, --help display help for command
@@ -894,6 +963,10 @@ Commands:
894
963
  update [options] <control> Change owner, applicability, design
895
964
  requirements or notes
896
965
  link [options] <control> <itemId> Link a test or document to a control
966
+ assess [options] <name> Request/reuse advisory assessment. A cached
967
+ result may have no job ID.
968
+ assessment [options] <name> Read advisory assessment/progress; absence
969
+ means not assessed, not compliant.
897
970
  help [command] display help for command
898
971
  ```
899
972
 
@@ -905,6 +978,8 @@ Usage: ciphrix control list [options]
905
978
  List controls with their status, applicability and owner
906
979
 
907
980
  Options:
981
+ --framework <code> filter by catalogue framework code; repeat for
982
+ multiple values
908
983
  --search <text> filter by name or code
909
984
  --domain <value> filter by control domain
910
985
  --status <csv> filter by status
@@ -1005,6 +1080,48 @@ Options:
1005
1080
 
1006
1081
  **Effect:** Links or unlinks a test or document to a control; the CLI asks for confirmation when required.
1007
1082
 
1083
+ ## `ciphrix control assess`
1084
+
1085
+ ```text
1086
+ Usage: ciphrix control assess [options] <name>
1087
+
1088
+ Request/reuse advisory assessment. A cached result may have no job ID.
1089
+
1090
+ Options:
1091
+ --api-url <url> override the API base URL
1092
+ --json emit one complete result/error envelope
1093
+ --yes confirmed writes only: explicitly authorize without
1094
+ prompting; rejected on reads/immediate writes
1095
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1096
+ identical input, at most 256 characters
1097
+ -h, --help display help for command
1098
+
1099
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1100
+ ```
1101
+
1102
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1103
+
1104
+ ## `ciphrix control assessment`
1105
+
1106
+ ```text
1107
+ Usage: ciphrix control assessment [options] <name>
1108
+
1109
+ Read advisory assessment/progress; absence means not assessed, not compliant.
1110
+
1111
+ Options:
1112
+ --api-url <url> override the API base URL
1113
+ --json emit one complete result/error envelope
1114
+ --yes confirmed writes only: explicitly authorize without
1115
+ prompting; rejected on reads/immediate writes
1116
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1117
+ identical input, at most 256 characters
1118
+ -h, --help display help for command
1119
+
1120
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1121
+ ```
1122
+
1123
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1124
+
1008
1125
  ## `ciphrix document`
1009
1126
 
1010
1127
  ```text
@@ -1027,6 +1144,16 @@ Commands:
1027
1144
  submit [options] <document> Submit a draft document for review
1028
1145
  approve [options] <document> Approve a document awaiting approval
1029
1146
  delete [options] <document> Delete a document
1147
+ workflow Configure workflow or explicitly return to
1148
+ draft
1149
+ reviewer Configure the review recipient; recall sent
1150
+ requests first
1151
+ approver Configure the approval recipient; recall sent
1152
+ requests first
1153
+ review Explicit review decisions and request recall;
1154
+ send with document submit
1155
+ approval Approval requests, explicit decisions and
1156
+ recall; ordinary decision with document approve
1030
1157
  help [command] display help for command
1031
1158
  ```
1032
1159
 
@@ -1196,6 +1323,379 @@ Options:
1196
1323
 
1197
1324
  **Effect:** Deletes a document; the CLI asks for confirmation when required.
1198
1325
 
1326
+ ## `ciphrix document workflow`
1327
+
1328
+ ```text
1329
+ Usage: ciphrix document workflow [options] [command]
1330
+
1331
+ Configure workflow or explicitly return to draft
1332
+
1333
+ Options:
1334
+ -h, --help display help for command
1335
+
1336
+ Commands:
1337
+ set [options] <document> Set workflow type in draft.
1338
+ return-to-draft [options] <document> Return eligible advanced approval-stage
1339
+ document to draft; clears assignments.
1340
+ help [command] display help for command
1341
+ ```
1342
+
1343
+ ## `ciphrix document workflow set`
1344
+
1345
+ ```text
1346
+ Usage: ciphrix document workflow set [options] <document>
1347
+
1348
+ Set workflow type in draft.
1349
+
1350
+ Options:
1351
+ --type <value> workflow type: simple or advanced
1352
+ --api-url <url> override the API base URL
1353
+ --json emit one complete result/error envelope
1354
+ --yes confirmed writes only: explicitly authorize without
1355
+ prompting; rejected on reads/immediate writes
1356
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1357
+ identical input, at most 256 characters
1358
+ -h, --help display help for command
1359
+
1360
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1361
+ ```
1362
+
1363
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1364
+
1365
+ ## `ciphrix document workflow return-to-draft`
1366
+
1367
+ ```text
1368
+ Usage: ciphrix document workflow return-to-draft [options] <document>
1369
+
1370
+ Return eligible advanced approval-stage document to draft; clears assignments.
1371
+
1372
+ Options:
1373
+ --api-url <url> override the API base URL
1374
+ --json emit one complete result/error envelope
1375
+ --yes confirmed writes only: explicitly authorize without
1376
+ prompting; rejected on reads/immediate writes
1377
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1378
+ identical input, at most 256 characters
1379
+ -h, --help display help for command
1380
+
1381
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1382
+ ```
1383
+
1384
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1385
+
1386
+ ## `ciphrix document reviewer`
1387
+
1388
+ ```text
1389
+ Usage: ciphrix document reviewer [options] [command]
1390
+
1391
+ Configure the review recipient; recall sent requests first
1392
+
1393
+ Options:
1394
+ -h, --help display help for command
1395
+
1396
+ Commands:
1397
+ set [options] <document> Set reviewer; sent requests must be recalled
1398
+ first.
1399
+ remove [options] <document> Remove the reviewer from a draft.
1400
+ help [command] display help for command
1401
+ ```
1402
+
1403
+ ## `ciphrix document reviewer set`
1404
+
1405
+ ```text
1406
+ Usage: ciphrix document reviewer set [options] <document>
1407
+
1408
+ Set reviewer; sent requests must be recalled first.
1409
+
1410
+ Options:
1411
+ --user <value> exact active user email or User ID; employees may be
1412
+ assigned
1413
+ --api-url <url> override the API base URL
1414
+ --json emit one complete result/error envelope
1415
+ --yes confirmed writes only: explicitly authorize without
1416
+ prompting; rejected on reads/immediate writes
1417
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1418
+ identical input, at most 256 characters
1419
+ -h, --help display help for command
1420
+
1421
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1422
+ ```
1423
+
1424
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1425
+
1426
+ ## `ciphrix document reviewer remove`
1427
+
1428
+ ```text
1429
+ Usage: ciphrix document reviewer remove [options] <document>
1430
+
1431
+ Remove the reviewer from a draft.
1432
+
1433
+ Options:
1434
+ --api-url <url> override the API base URL
1435
+ --json emit one complete result/error envelope
1436
+ --yes confirmed writes only: explicitly authorize without
1437
+ prompting; rejected on reads/immediate writes
1438
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1439
+ identical input, at most 256 characters
1440
+ -h, --help display help for command
1441
+
1442
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1443
+ ```
1444
+
1445
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1446
+
1447
+ ## `ciphrix document approver`
1448
+
1449
+ ```text
1450
+ Usage: ciphrix document approver [options] [command]
1451
+
1452
+ Configure the approval recipient; recall sent requests first
1453
+
1454
+ Options:
1455
+ -h, --help display help for command
1456
+
1457
+ Commands:
1458
+ set [options] <document> Set approver; sent requests must be recalled
1459
+ first.
1460
+ remove [options] <document> Remove approver; sent requests must be recalled
1461
+ first.
1462
+ help [command] display help for command
1463
+ ```
1464
+
1465
+ ## `ciphrix document approver set`
1466
+
1467
+ ```text
1468
+ Usage: ciphrix document approver set [options] <document>
1469
+
1470
+ Set approver; sent requests must be recalled first.
1471
+
1472
+ Options:
1473
+ --user <value> exact active user email or User ID; employees may be
1474
+ assigned
1475
+ --api-url <url> override the API base URL
1476
+ --json emit one complete result/error envelope
1477
+ --yes confirmed writes only: explicitly authorize without
1478
+ prompting; rejected on reads/immediate writes
1479
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1480
+ identical input, at most 256 characters
1481
+ -h, --help display help for command
1482
+
1483
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1484
+ ```
1485
+
1486
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1487
+
1488
+ ## `ciphrix document approver remove`
1489
+
1490
+ ```text
1491
+ Usage: ciphrix document approver remove [options] <document>
1492
+
1493
+ Remove approver; sent requests must be recalled first.
1494
+
1495
+ Options:
1496
+ --api-url <url> override the API base URL
1497
+ --json emit one complete result/error envelope
1498
+ --yes confirmed writes only: explicitly authorize without
1499
+ prompting; rejected on reads/immediate writes
1500
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1501
+ identical input, at most 256 characters
1502
+ -h, --help display help for command
1503
+
1504
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1505
+ ```
1506
+
1507
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1508
+
1509
+ ## `ciphrix document review`
1510
+
1511
+ ```text
1512
+ Usage: ciphrix document review [options] [command]
1513
+
1514
+ Explicit review decisions and request recall; send with document submit
1515
+
1516
+ Options:
1517
+ -h, --help display help for command
1518
+
1519
+ Commands:
1520
+ complete [options] <document> Record an explicitly authorized review
1521
+ decision; does not send approval.
1522
+ send-back [options] <document> Record an explicit negative review decision;
1523
+ clears reviewer.
1524
+ cancel [options] <document> Recall review request; clears reviewer.
1525
+ Configure and resend separately.
1526
+ help [command] display help for command
1527
+ ```
1528
+
1529
+ ## `ciphrix document review complete`
1530
+
1531
+ ```text
1532
+ Usage: ciphrix document review complete [options] <document>
1533
+
1534
+ Record an explicitly authorized review decision; does not send approval.
1535
+
1536
+ Options:
1537
+ --api-url <url> override the API base URL
1538
+ --json emit one complete result/error envelope
1539
+ --yes confirmed writes only: explicitly authorize without
1540
+ prompting; rejected on reads/immediate writes
1541
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1542
+ identical input, at most 256 characters
1543
+ -h, --help display help for command
1544
+
1545
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1546
+ ```
1547
+
1548
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1549
+
1550
+ ## `ciphrix document review send-back`
1551
+
1552
+ ```text
1553
+ Usage: ciphrix document review send-back [options] <document>
1554
+
1555
+ Record an explicit negative review decision; clears reviewer.
1556
+
1557
+ Options:
1558
+ --api-url <url> override the API base URL
1559
+ --json emit one complete result/error envelope
1560
+ --yes confirmed writes only: explicitly authorize without
1561
+ prompting; rejected on reads/immediate writes
1562
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1563
+ identical input, at most 256 characters
1564
+ -h, --help display help for command
1565
+
1566
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1567
+ ```
1568
+
1569
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1570
+
1571
+ ## `ciphrix document review cancel`
1572
+
1573
+ ```text
1574
+ Usage: ciphrix document review cancel [options] <document>
1575
+
1576
+ Recall review request; clears reviewer. Configure and resend separately.
1577
+
1578
+ Options:
1579
+ --api-url <url> override the API base URL
1580
+ --json emit one complete result/error envelope
1581
+ --yes confirmed writes only: explicitly authorize without
1582
+ prompting; rejected on reads/immediate writes
1583
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1584
+ identical input, at most 256 characters
1585
+ -h, --help display help for command
1586
+
1587
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1588
+ ```
1589
+
1590
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1591
+
1592
+ ## `ciphrix document approval`
1593
+
1594
+ ```text
1595
+ Usage: ciphrix document approval [options] [command]
1596
+
1597
+ Approval requests, explicit decisions and recall; ordinary decision with
1598
+ document approve
1599
+
1600
+ Options:
1601
+ -h, --help display help for command
1602
+
1603
+ Commands:
1604
+ send [options] <document> Send for approval after review; never
1605
+ completes review implicitly.
1606
+ send-back [options] <document> Record an explicit negative approval
1607
+ decision; clears approver.
1608
+ cancel [options] <document> Recall approval request; clears approver.
1609
+ Configure and resend separately.
1610
+ self-approve [options] <document> Explicit self-approval, separate from
1611
+ ordinary approve; no review bypass.
1612
+ help [command] display help for command
1613
+ ```
1614
+
1615
+ ## `ciphrix document approval send`
1616
+
1617
+ ```text
1618
+ Usage: ciphrix document approval send [options] <document>
1619
+
1620
+ Send for approval after review; never completes review implicitly.
1621
+
1622
+ Options:
1623
+ --api-url <url> override the API base URL
1624
+ --json emit one complete result/error envelope
1625
+ --yes confirmed writes only: explicitly authorize without
1626
+ prompting; rejected on reads/immediate writes
1627
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1628
+ identical input, at most 256 characters
1629
+ -h, --help display help for command
1630
+
1631
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1632
+ ```
1633
+
1634
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1635
+
1636
+ ## `ciphrix document approval send-back`
1637
+
1638
+ ```text
1639
+ Usage: ciphrix document approval send-back [options] <document>
1640
+
1641
+ Record an explicit negative approval decision; clears approver.
1642
+
1643
+ Options:
1644
+ --api-url <url> override the API base URL
1645
+ --json emit one complete result/error envelope
1646
+ --yes confirmed writes only: explicitly authorize without
1647
+ prompting; rejected on reads/immediate writes
1648
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1649
+ identical input, at most 256 characters
1650
+ -h, --help display help for command
1651
+
1652
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1653
+ ```
1654
+
1655
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1656
+
1657
+ ## `ciphrix document approval cancel`
1658
+
1659
+ ```text
1660
+ Usage: ciphrix document approval cancel [options] <document>
1661
+
1662
+ Recall approval request; clears approver. Configure and resend separately.
1663
+
1664
+ Options:
1665
+ --api-url <url> override the API base URL
1666
+ --json emit one complete result/error envelope
1667
+ --yes confirmed writes only: explicitly authorize without
1668
+ prompting; rejected on reads/immediate writes
1669
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1670
+ identical input, at most 256 characters
1671
+ -h, --help display help for command
1672
+
1673
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1674
+ ```
1675
+
1676
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1677
+
1678
+ ## `ciphrix document approval self-approve`
1679
+
1680
+ ```text
1681
+ Usage: ciphrix document approval self-approve [options] <document>
1682
+
1683
+ Explicit self-approval, separate from ordinary approve; no review bypass.
1684
+
1685
+ Options:
1686
+ --api-url <url> override the API base URL
1687
+ --json emit one complete result/error envelope
1688
+ --yes confirmed writes only: explicitly authorize without
1689
+ prompting; rejected on reads/immediate writes
1690
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1691
+ identical input, at most 256 characters
1692
+ -h, --help display help for command
1693
+
1694
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
1695
+ ```
1696
+
1697
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
1698
+
1199
1699
  ## `ciphrix risk`
1200
1700
 
1201
1701
  ```text
@@ -1585,6 +2085,1155 @@ Options:
1585
2085
  -h, --help display help for command
1586
2086
  ```
1587
2087
 
2088
+ ## `ciphrix user`
2089
+
2090
+ ```text
2091
+ Usage: ciphrix user [options] [command]
2092
+
2093
+ Active tenant-user discovery; no account administration
2094
+
2095
+ Options:
2096
+ -h, --help display help for command
2097
+
2098
+ Commands:
2099
+ list [options] List active tenant users, including employees; discovery does
2100
+ not change accounts.
2101
+ help [command] display help for command
2102
+ ```
2103
+
2104
+ ## `ciphrix user list`
2105
+
2106
+ ```text
2107
+ Usage: ciphrix user list [options]
2108
+
2109
+ List active tenant users, including employees; discovery does not change
2110
+ accounts.
2111
+
2112
+ Options:
2113
+ --search <value> optional name/email search, at least three characters
2114
+ --page <value> page number starting at 1
2115
+ --limit <value> page size; server limits apply
2116
+ --api-url <url> override the API base URL
2117
+ --json emit one complete result/error envelope
2118
+ --yes confirmed writes only: explicitly authorize without
2119
+ prompting; rejected on reads/immediate writes
2120
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2121
+ identical input, at most 256 characters
2122
+ -h, --help display help for command
2123
+
2124
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2125
+ ```
2126
+
2127
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2128
+
2129
+ ## `ciphrix access`
2130
+
2131
+ ```text
2132
+ Usage: ciphrix access [options] [command]
2133
+
2134
+ Access inventory, reviewed imports and assigned reviewer workflows
2135
+
2136
+ Options:
2137
+ -h, --help display help for command
2138
+
2139
+ Commands:
2140
+ resource Resources, owners and asset relationships
2141
+ entry Revisioned access inventory; inventory edits are not review
2142
+ decisions
2143
+ import Your import proposals, selected-row merges and explicit
2144
+ discard
2145
+ review Review campaigns, assigned decisions, completion and frozen
2146
+ outcomes
2147
+ help [command] display help for command
2148
+ ```
2149
+
2150
+ ## `ciphrix access resource`
2151
+
2152
+ ```text
2153
+ Usage: ciphrix access resource [options] [command]
2154
+
2155
+ Resources, owners and asset relationships
2156
+
2157
+ Options:
2158
+ -h, --help display help for command
2159
+
2160
+ Commands:
2161
+ list [options] List review inventory resources and owners.
2162
+ get [options] <resourceId> Read a resource and its current inventory context.
2163
+ create [options] Create manual inventory; reconcile active reviews.
2164
+ update [options] <resourceId> Update inventory. Inactivation also deactivates child access.
2165
+ link-asset [options] <resourceId> <assetId> Link or unlink an existing asset; reconcile reviews.
2166
+ bulk-update [options] Update selected resource owners/statuses; inspect per-row failures.
2167
+ help [command] display help for command
2168
+ ```
2169
+
2170
+ ## `ciphrix access resource list`
2171
+
2172
+ ```text
2173
+ Usage: ciphrix access resource list [options]
2174
+
2175
+ List review inventory resources and owners.
2176
+
2177
+ Options:
2178
+ --page <value> page number starting at 1
2179
+ --limit <value> page size; server limits apply
2180
+ --search <value> search visible records
2181
+ --sort-by <value> server-supported sort field
2182
+ --sort-order <value> sort direction: asc or desc
2183
+ --status <value> inventory status: active or inactive; review/agent
2184
+ operations use their own status vocabulary
2185
+ --owner-person <value> existing People ID for the resource owner
2186
+ --include-empty include resources with no access entries
2187
+ --api-url <url> override the API base URL
2188
+ --json emit one complete result/error envelope
2189
+ --yes confirmed writes only: explicitly authorize without
2190
+ prompting; rejected on reads/immediate writes
2191
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2192
+ identical input, at most 256 characters
2193
+ -h, --help display help for command
2194
+
2195
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2196
+ ```
2197
+
2198
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2199
+
2200
+ ## `ciphrix access resource get`
2201
+
2202
+ ```text
2203
+ Usage: ciphrix access resource get [options] <resourceId>
2204
+
2205
+ Read a resource and its current inventory context.
2206
+
2207
+ Options:
2208
+ --api-url <url> override the API base URL
2209
+ --json emit one complete result/error envelope
2210
+ --yes confirmed writes only: explicitly authorize without
2211
+ prompting; rejected on reads/immediate writes
2212
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2213
+ identical input, at most 256 characters
2214
+ -h, --help display help for command
2215
+
2216
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2217
+ ```
2218
+
2219
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2220
+
2221
+ ## `ciphrix access resource create`
2222
+
2223
+ ```text
2224
+ Usage: ciphrix access resource create [options]
2225
+
2226
+ Create manual inventory; reconcile active reviews.
2227
+
2228
+ Options:
2229
+ --name <value> record name
2230
+ --website <value> resource website
2231
+ --owner-person <value> existing People ID for the resource owner
2232
+ --api-url <url> override the API base URL
2233
+ --json emit one complete result/error envelope
2234
+ --yes confirmed writes only: explicitly authorize without
2235
+ prompting; rejected on reads/immediate writes
2236
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2237
+ identical input, at most 256 characters
2238
+ -h, --help display help for command
2239
+
2240
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2241
+ ```
2242
+
2243
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2244
+
2245
+ ## `ciphrix access resource update`
2246
+
2247
+ ```text
2248
+ Usage: ciphrix access resource update [options] <resourceId>
2249
+
2250
+ Update inventory. Inactivation also deactivates child access.
2251
+
2252
+ Options:
2253
+ --expected-updated-at <value> exact updatedAt timestamp from the latest read
2254
+ --name <value> record name
2255
+ --website <value> resource website
2256
+ --clear-website clear the website; conflicts with --website
2257
+ --owner-person <value> existing People ID for the resource owner
2258
+ --clear-owner clear the owner; conflicts with --owner-person
2259
+ --status <value> inventory status: active or inactive;
2260
+ review/agent operations use their own status
2261
+ vocabulary
2262
+ --api-url <url> override the API base URL
2263
+ --json emit one complete result/error envelope
2264
+ --yes confirmed writes only: explicitly authorize
2265
+ without prompting; rejected on reads/immediate
2266
+ writes
2267
+ --idempotency-key <key> writes only: key for one logical operation;
2268
+ reuse identical input, at most 256 characters
2269
+ -h, --help display help for command
2270
+
2271
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2272
+ ```
2273
+
2274
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2275
+
2276
+ ## `ciphrix access resource link-asset`
2277
+
2278
+ ```text
2279
+ Usage: ciphrix access resource link-asset [options] <resourceId> <assetId>
2280
+
2281
+ Link or unlink an existing asset; reconcile reviews.
2282
+
2283
+ Options:
2284
+ --action <value> explicit link or unlink action
2285
+ --api-url <url> override the API base URL
2286
+ --json emit one complete result/error envelope
2287
+ --yes confirmed writes only: explicitly authorize without
2288
+ prompting; rejected on reads/immediate writes
2289
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2290
+ identical input, at most 256 characters
2291
+ -h, --help display help for command
2292
+
2293
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2294
+ ```
2295
+
2296
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2297
+
2298
+ ## `ciphrix access resource bulk-update`
2299
+
2300
+ ```text
2301
+ Usage: ciphrix access resource bulk-update [options]
2302
+
2303
+ Update selected resource owners/statuses; inspect per-row failures.
2304
+
2305
+ Options:
2306
+ --resource <value> existing resource ID; repeat for multiple selections
2307
+ where supported
2308
+ --owner-person <value> existing People ID for the resource owner
2309
+ --clear-owner clear the owner; conflicts with --owner-person
2310
+ --status <value> inventory status: active or inactive; review/agent
2311
+ operations use their own status vocabulary
2312
+ --api-url <url> override the API base URL
2313
+ --json emit one complete result/error envelope
2314
+ --yes confirmed writes only: explicitly authorize without
2315
+ prompting; rejected on reads/immediate writes
2316
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2317
+ identical input, at most 256 characters
2318
+ -h, --help display help for command
2319
+
2320
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2321
+ ```
2322
+
2323
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2324
+
2325
+ ## `ciphrix access entry`
2326
+
2327
+ ```text
2328
+ Usage: ciphrix access entry [options] [command]
2329
+
2330
+ Revisioned access inventory; inventory edits are not review decisions
2331
+
2332
+ Options:
2333
+ -h, --help display help for command
2334
+
2335
+ Commands:
2336
+ list [options] List current access inventory; no review
2337
+ decisions are recorded.
2338
+ get [options] <accessId> Read current inventory revision and prior review
2339
+ outcome.
2340
+ create [options] Create manual access inventory, not a review
2341
+ decision.
2342
+ update [options] <accessId> Update revisioned inventory; integration-owned
2343
+ fields stay locked.
2344
+ bulk-update [options] Update one field on selected revisioned entries;
2345
+ inspect partial failures.
2346
+ help [command] display help for command
2347
+ ```
2348
+
2349
+ ## `ciphrix access entry list`
2350
+
2351
+ ```text
2352
+ Usage: ciphrix access entry list [options]
2353
+
2354
+ List current access inventory; no review decisions are recorded.
2355
+
2356
+ Options:
2357
+ --page <value> page number starting at 1
2358
+ --limit <value> page size; server limits apply
2359
+ --search <value> search visible records
2360
+ --sort-by <value> server-supported sort field
2361
+ --sort-order <value> sort direction: asc or desc
2362
+ --resource <value> existing resource ID; repeat for multiple
2363
+ selections where supported
2364
+ --person <value> existing People ID for the access identity
2365
+ --owner-person <value> existing People ID for the resource owner
2366
+ --status <value> inventory status: active or inactive; review/agent
2367
+ operations use their own status vocabulary
2368
+ --review-state <value> inventory: needs_review, pending, keep, revoke or
2369
+ inactive; reviewer task: pending or all
2370
+ --reviewed-before <value> ISO review-history cutoff
2371
+ --api-url <url> override the API base URL
2372
+ --json emit one complete result/error envelope
2373
+ --yes confirmed writes only: explicitly authorize without
2374
+ prompting; rejected on reads/immediate writes
2375
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2376
+ identical input, at most 256 characters
2377
+ -h, --help display help for command
2378
+
2379
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2380
+ ```
2381
+
2382
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2383
+
2384
+ ## `ciphrix access entry get`
2385
+
2386
+ ```text
2387
+ Usage: ciphrix access entry get [options] <accessId>
2388
+
2389
+ Read current inventory revision and prior review outcome.
2390
+
2391
+ Options:
2392
+ --api-url <url> override the API base URL
2393
+ --json emit one complete result/error envelope
2394
+ --yes confirmed writes only: explicitly authorize without
2395
+ prompting; rejected on reads/immediate writes
2396
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2397
+ identical input, at most 256 characters
2398
+ -h, --help display help for command
2399
+
2400
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2401
+ ```
2402
+
2403
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2404
+
2405
+ ## `ciphrix access entry create`
2406
+
2407
+ ```text
2408
+ Usage: ciphrix access entry create [options]
2409
+
2410
+ Create manual access inventory, not a review decision.
2411
+
2412
+ Options:
2413
+ --resource <value> existing resource ID; repeat for multiple selections
2414
+ where supported
2415
+ --identity <value> reported account identity; does not change
2416
+ authentication
2417
+ --role <value> inventory access role; does not change product
2418
+ authorization
2419
+ --person <value> existing People ID for the access identity
2420
+ --status <value> inventory status: active or inactive; review/agent
2421
+ operations use their own status vocabulary
2422
+ --api-url <url> override the API base URL
2423
+ --json emit one complete result/error envelope
2424
+ --yes confirmed writes only: explicitly authorize without
2425
+ prompting; rejected on reads/immediate writes
2426
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2427
+ identical input, at most 256 characters
2428
+ -h, --help display help for command
2429
+
2430
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2431
+ ```
2432
+
2433
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2434
+
2435
+ ## `ciphrix access entry update`
2436
+
2437
+ ```text
2438
+ Usage: ciphrix access entry update [options] <accessId>
2439
+
2440
+ Update revisioned inventory; integration-owned fields stay locked.
2441
+
2442
+ Options:
2443
+ --expected-revision <value> current revision from the latest entry or
2444
+ reviewer-task read
2445
+ --identity <value> reported account identity; does not change
2446
+ authentication
2447
+ --role <value> inventory access role; does not change product
2448
+ authorization
2449
+ --person <value> existing People ID for the access identity
2450
+ --clear-person leave the identity unmatched; conflicts with
2451
+ --person
2452
+ --status <value> inventory status: active or inactive;
2453
+ review/agent operations use their own status
2454
+ vocabulary
2455
+ --api-url <url> override the API base URL
2456
+ --json emit one complete result/error envelope
2457
+ --yes confirmed writes only: explicitly authorize
2458
+ without prompting; rejected on reads/immediate
2459
+ writes
2460
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2461
+ identical input, at most 256 characters
2462
+ -h, --help display help for command
2463
+
2464
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2465
+ ```
2466
+
2467
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2468
+
2469
+ ## `ciphrix access entry bulk-update`
2470
+
2471
+ ```text
2472
+ Usage: ciphrix access entry bulk-update [options]
2473
+
2474
+ Update one field on selected revisioned entries; inspect partial failures.
2475
+
2476
+ Options:
2477
+ --rows-file <value> JSON array of explicitly selected rows; regular file,
2478
+ at most 1 MiB
2479
+ --field <value> single inventory field to update on every selected
2480
+ row
2481
+ --value <value> strict JSON value; quote strings as JSON and use null
2482
+ only where supported
2483
+ --api-url <url> override the API base URL
2484
+ --json emit one complete result/error envelope
2485
+ --yes confirmed writes only: explicitly authorize without
2486
+ prompting; rejected on reads/immediate writes
2487
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2488
+ identical input, at most 256 characters
2489
+ -h, --help display help for command
2490
+
2491
+ Rows: [{accessId, expectedRevision}]. Only update is exposed. field selects identity, personId, role or status; value is a JSON string, or null to clear personId. Each row can fail independently.
2492
+
2493
+
2494
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2495
+ ```
2496
+
2497
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2498
+
2499
+ ## `ciphrix access import`
2500
+
2501
+ ```text
2502
+ Usage: ciphrix access import [options] [command]
2503
+
2504
+ Your import proposals, selected-row merges and explicit discard
2505
+
2506
+ Options:
2507
+ -h, --help display help for command
2508
+
2509
+ Commands:
2510
+ start [options] Extract a proposal from owned register_import
2511
+ uploads; does not merge.
2512
+ list [options] List your unresolved imports using cursor
2513
+ pagination.
2514
+ get [options] <importId> Inspect proposal rows, matches, evidence and
2515
+ revisions before merging.
2516
+ merge [options] <importId> Merge only reviewed selected rows; preserve
2517
+ corrections and explicit confirmations.
2518
+ discard [options] <importId> Stop extraction/merge; retain successful merges
2519
+ and independent enrichment.
2520
+ help [command] display help for command
2521
+ ```
2522
+
2523
+ ## `ciphrix access import start`
2524
+
2525
+ ```text
2526
+ Usage: ciphrix access import start [options]
2527
+
2528
+ Extract a proposal from owned register_import uploads; does not merge.
2529
+
2530
+ Options:
2531
+ --upload <value> ready upload ID owned by the caller; repeat to select
2532
+ multiple files
2533
+ --api-url <url> override the API base URL
2534
+ --json emit one complete result/error envelope
2535
+ --yes confirmed writes only: explicitly authorize without
2536
+ prompting; rejected on reads/immediate writes
2537
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2538
+ identical input, at most 256 characters
2539
+ -h, --help display help for command
2540
+
2541
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2542
+ ```
2543
+
2544
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2545
+
2546
+ ## `ciphrix access import list`
2547
+
2548
+ ```text
2549
+ Usage: ciphrix access import list [options]
2550
+
2551
+ List your unresolved imports using cursor pagination.
2552
+
2553
+ Options:
2554
+ --cursor <value> continuation cursor returned by the preceding page
2555
+ --limit <value> page size; server limits apply
2556
+ --api-url <url> override the API base URL
2557
+ --json emit one complete result/error envelope
2558
+ --yes confirmed writes only: explicitly authorize without
2559
+ prompting; rejected on reads/immediate writes
2560
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2561
+ identical input, at most 256 characters
2562
+ -h, --help display help for command
2563
+
2564
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2565
+ ```
2566
+
2567
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2568
+
2569
+ ## `ciphrix access import get`
2570
+
2571
+ ```text
2572
+ Usage: ciphrix access import get [options] <importId>
2573
+
2574
+ Inspect proposal rows, matches, evidence and revisions before merging.
2575
+
2576
+ Options:
2577
+ --cursor <value> continuation cursor returned by the preceding page
2578
+ --limit <value> page size; server limits apply
2579
+ --filter <value> proposal-row filter: all, new, unchanged, update or
2580
+ conflict
2581
+ --search <value> search visible records
2582
+ --ids-only return proposal-row IDs instead of full details
2583
+ --api-url <url> override the API base URL
2584
+ --json emit one complete result/error envelope
2585
+ --yes confirmed writes only: explicitly authorize without
2586
+ prompting; rejected on reads/immediate writes
2587
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2588
+ identical input, at most 256 characters
2589
+ -h, --help display help for command
2590
+
2591
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2592
+ ```
2593
+
2594
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2595
+
2596
+ ## `ciphrix access import merge`
2597
+
2598
+ ```text
2599
+ Usage: ciphrix access import merge [options] <importId>
2600
+
2601
+ Merge only reviewed selected rows; preserve corrections and explicit
2602
+ confirmations.
2603
+
2604
+ Options:
2605
+ --rows-file <value> JSON array of explicitly selected rows; regular file,
2606
+ at most 1 MiB
2607
+ --api-url <url> override the API base URL
2608
+ --json emit one complete result/error envelope
2609
+ --yes confirmed writes only: explicitly authorize without
2610
+ prompting; rejected on reads/immediate writes
2611
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2612
+ identical input, at most 256 characters
2613
+ -h, --help display help for command
2614
+
2615
+ Rows require proposal_row_id. Optional reviewed corrections: resource_id, resource_name, website, identity, role, person_id, resource_owner_person_id, confirm_person_match, confirm_visual_evidence, expected_revision, access_id. Preserve snake_case. Never infer match/evidence confirmations or merge all rows implicitly. Read the proposal before selecting rows.
2616
+
2617
+
2618
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2619
+ ```
2620
+
2621
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2622
+
2623
+ ## `ciphrix access import discard`
2624
+
2625
+ ```text
2626
+ Usage: ciphrix access import discard [options] <importId>
2627
+
2628
+ Stop extraction/merge; retain successful merges and independent enrichment.
2629
+
2630
+ Options:
2631
+ --api-url <url> override the API base URL
2632
+ --json emit one complete result/error envelope
2633
+ --yes confirmed writes only: explicitly authorize without
2634
+ prompting; rejected on reads/immediate writes
2635
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2636
+ identical input, at most 256 characters
2637
+ -h, --help display help for command
2638
+
2639
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2640
+ ```
2641
+
2642
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2643
+
2644
+ ## `ciphrix access review`
2645
+
2646
+ ```text
2647
+ Usage: ciphrix access review [options] [command]
2648
+
2649
+ Review campaigns, assigned decisions, completion and frozen outcomes
2650
+
2651
+ Options:
2652
+ -h, --help display help for command
2653
+
2654
+ Commands:
2655
+ preview [options] Preview selected eligible owners and unresolved
2656
+ entries without creating work.
2657
+ start [options] Create a review, reviewer tasks and assignment
2658
+ notifications.
2659
+ list [options] Read active progress or closed/cancelled history.
2660
+ task [options] <taskId> Read your assigned reviewer task, current
2661
+ revisions and decisions.
2662
+ decide [options] <taskId> Record explicit keep/revoke decisions. Revoke is
2663
+ a removal request, not provider revocation.
2664
+ complete [options] <taskId> Complete your assigned task after all decisions;
2665
+ may close a fully reviewed campaign.
2666
+ result [options] <reviewId> Read frozen outcomes; pending/unresolved never
2667
+ imply approval.
2668
+ end [options] <reviewId> Explicitly close with current outcomes or cancel
2669
+ without a result; close reviewer tasks.
2670
+ export [options] <reviewId> Create a temporary signed CSV reference; no
2671
+ automatic download.
2672
+ help [command] display help for command
2673
+ ```
2674
+
2675
+ ## `ciphrix access review preview`
2676
+
2677
+ ```text
2678
+ Usage: ciphrix access review preview [options]
2679
+
2680
+ Preview selected eligible owners and unresolved entries without creating work.
2681
+
2682
+ Options:
2683
+ --resource <value> existing resource ID; repeat for multiple selections
2684
+ where supported
2685
+ --due-at <value> ISO due date/time; review creation defaults to 14
2686
+ days if omitted
2687
+ --api-url <url> override the API base URL
2688
+ --json emit one complete result/error envelope
2689
+ --yes confirmed writes only: explicitly authorize without
2690
+ prompting; rejected on reads/immediate writes
2691
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2692
+ identical input, at most 256 characters
2693
+ -h, --help display help for command
2694
+
2695
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2696
+ ```
2697
+
2698
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2699
+
2700
+ ## `ciphrix access review start`
2701
+
2702
+ ```text
2703
+ Usage: ciphrix access review start [options]
2704
+
2705
+ Create a review, reviewer tasks and assignment notifications.
2706
+
2707
+ Options:
2708
+ --name <value> record name
2709
+ --resource <value> existing resource ID; repeat for multiple selections
2710
+ where supported
2711
+ --due-at <value> ISO due date/time; review creation defaults to 14
2712
+ days if omitted
2713
+ --api-url <url> override the API base URL
2714
+ --json emit one complete result/error envelope
2715
+ --yes confirmed writes only: explicitly authorize without
2716
+ prompting; rejected on reads/immediate writes
2717
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2718
+ identical input, at most 256 characters
2719
+ -h, --help display help for command
2720
+
2721
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2722
+ ```
2723
+
2724
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2725
+
2726
+ ## `ciphrix access review list`
2727
+
2728
+ ```text
2729
+ Usage: ciphrix access review list [options]
2730
+
2731
+ Read active progress or closed/cancelled history.
2732
+
2733
+ Options:
2734
+ --status <value> review filter: active, closed, cancelled or history
2735
+ --page <value> page number starting at 1
2736
+ --limit <value> page size; server limits apply
2737
+ --api-url <url> override the API base URL
2738
+ --json emit one complete result/error envelope
2739
+ --yes confirmed writes only: explicitly authorize without
2740
+ prompting; rejected on reads/immediate writes
2741
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2742
+ identical input, at most 256 characters
2743
+ -h, --help display help for command
2744
+
2745
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2746
+ ```
2747
+
2748
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2749
+
2750
+ ## `ciphrix access review task`
2751
+
2752
+ ```text
2753
+ Usage: ciphrix access review task [options] <taskId>
2754
+
2755
+ Read your assigned reviewer task, current revisions and decisions.
2756
+
2757
+ Options:
2758
+ --page <value> page number starting at 1
2759
+ --limit <value> page size; server limits apply
2760
+ --search <value> search visible records
2761
+ --review-state <value> inventory: needs_review, pending, keep, revoke or
2762
+ inactive; reviewer task: pending or all
2763
+ --api-url <url> override the API base URL
2764
+ --json emit one complete result/error envelope
2765
+ --yes confirmed writes only: explicitly authorize without
2766
+ prompting; rejected on reads/immediate writes
2767
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2768
+ identical input, at most 256 characters
2769
+ -h, --help display help for command
2770
+
2771
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2772
+ ```
2773
+
2774
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2775
+
2776
+ ## `ciphrix access review decide`
2777
+
2778
+ ```text
2779
+ Usage: ciphrix access review decide [options] <taskId>
2780
+
2781
+ Record explicit keep/revoke decisions. Revoke is a removal request, not provider
2782
+ revocation.
2783
+
2784
+ Options:
2785
+ --items-file <value> JSON array of accessId, expectedRevision, decision
2786
+ and optional comment; at most 1 MiB
2787
+ --api-url <url> override the API base URL
2788
+ --json emit one complete result/error envelope
2789
+ --yes confirmed writes only: explicitly authorize without
2790
+ prompting; rejected on reads/immediate writes
2791
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2792
+ identical input, at most 256 characters
2793
+ -h, --help display help for command
2794
+
2795
+ Items: [{accessId, expectedRevision, decision, comment?}]. decision is keep or revoke; comment may be null. Revoke records a removal request, not provider revocation. Complete the assigned task separately after all decisions.
2796
+
2797
+
2798
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2799
+ ```
2800
+
2801
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2802
+
2803
+ ## `ciphrix access review complete`
2804
+
2805
+ ```text
2806
+ Usage: ciphrix access review complete [options] <taskId>
2807
+
2808
+ Complete your assigned task after all decisions; may close a fully reviewed
2809
+ campaign.
2810
+
2811
+ Options:
2812
+ --api-url <url> override the API base URL
2813
+ --json emit one complete result/error envelope
2814
+ --yes confirmed writes only: explicitly authorize without
2815
+ prompting; rejected on reads/immediate writes
2816
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2817
+ identical input, at most 256 characters
2818
+ -h, --help display help for command
2819
+
2820
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2821
+ ```
2822
+
2823
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2824
+
2825
+ ## `ciphrix access review result`
2826
+
2827
+ ```text
2828
+ Usage: ciphrix access review result [options] <reviewId>
2829
+
2830
+ Read frozen outcomes; pending/unresolved never imply approval.
2831
+
2832
+ Options:
2833
+ --page <value> page number starting at 1
2834
+ --limit <value> page size; server limits apply
2835
+ --search <value> search visible records
2836
+ --resource <value> existing resource ID; repeat for multiple selections
2837
+ where supported
2838
+ --outcome <value> frozen outcome filter: keep, revoke, pending,
2839
+ unresolved or inactive
2840
+ --api-url <url> override the API base URL
2841
+ --json emit one complete result/error envelope
2842
+ --yes confirmed writes only: explicitly authorize without
2843
+ prompting; rejected on reads/immediate writes
2844
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2845
+ identical input, at most 256 characters
2846
+ -h, --help display help for command
2847
+
2848
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2849
+ ```
2850
+
2851
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2852
+
2853
+ ## `ciphrix access review end`
2854
+
2855
+ ```text
2856
+ Usage: ciphrix access review end [options] <reviewId>
2857
+
2858
+ Explicitly close with current outcomes or cancel without a result; close
2859
+ reviewer tasks.
2860
+
2861
+ Options:
2862
+ --status <value> closed freezes outcomes; cancelled creates no result
2863
+ --api-url <url> override the API base URL
2864
+ --json emit one complete result/error envelope
2865
+ --yes confirmed writes only: explicitly authorize without
2866
+ prompting; rejected on reads/immediate writes
2867
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2868
+ identical input, at most 256 characters
2869
+ -h, --help display help for command
2870
+
2871
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2872
+ ```
2873
+
2874
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2875
+
2876
+ ## `ciphrix access review export`
2877
+
2878
+ ```text
2879
+ Usage: ciphrix access review export [options] <reviewId>
2880
+
2881
+ Create a temporary signed CSV reference; no automatic download.
2882
+
2883
+ Options:
2884
+ --api-url <url> override the API base URL
2885
+ --json emit one complete result/error envelope
2886
+ --yes confirmed writes only: explicitly authorize without
2887
+ prompting; rejected on reads/immediate writes
2888
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2889
+ identical input, at most 256 characters
2890
+ -h, --help display help for command
2891
+
2892
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2893
+ ```
2894
+
2895
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2896
+
2897
+ ## `ciphrix agent`
2898
+
2899
+ ```text
2900
+ Usage: ciphrix agent [options] [command]
2901
+
2902
+ Agent activity, complete proposals and explicit human decisions
2903
+
2904
+ Options:
2905
+ -h, --help display help for command
2906
+
2907
+ Commands:
2908
+ run Grouped agent activity; findings are not completed assessments
2909
+ action Findings, reviewed proposals and declared
2910
+ approve/reject/choose options
2911
+ help [command] display help for command
2912
+ ```
2913
+
2914
+ ## `ciphrix agent run`
2915
+
2916
+ ```text
2917
+ Usage: ciphrix agent run [options] [command]
2918
+
2919
+ Grouped agent activity; findings are not completed assessments
2920
+
2921
+ Options:
2922
+ -h, --help display help for command
2923
+
2924
+ Commands:
2925
+ list [options] List grouped agent activity; counts are not completed
2926
+ assessments.
2927
+ help [command] display help for command
2928
+ ```
2929
+
2930
+ ## `ciphrix agent run list`
2931
+
2932
+ ```text
2933
+ Usage: ciphrix agent run list [options]
2934
+
2935
+ List grouped agent activity; counts are not completed assessments.
2936
+
2937
+ Options:
2938
+ --agent <value> agent filter; repeat for multiple values
2939
+ --action-type <value> action-type filter; repeat for multiple values
2940
+ --status <value> status filter; repeat for multiple values
2941
+ --initiator-type <value> initiator-type filter; repeat for multiple values
2942
+ --from <value> ISO lower date/time bound
2943
+ --to <value> ISO upper date/time bound
2944
+ --search <value> search visible records
2945
+ --limit <value> page size; server limits apply
2946
+ --offset <value> number of grouped results to skip
2947
+ --api-url <url> override the API base URL
2948
+ --json emit one complete result/error envelope
2949
+ --yes confirmed writes only: explicitly authorize without
2950
+ prompting; rejected on reads/immediate writes
2951
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2952
+ identical input, at most 256 characters
2953
+ -h, --help display help for command
2954
+
2955
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
2956
+ ```
2957
+
2958
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
2959
+
2960
+ ## `ciphrix agent action`
2961
+
2962
+ ```text
2963
+ Usage: ciphrix agent action [options] [command]
2964
+
2965
+ Findings, reviewed proposals and declared approve/reject/choose options
2966
+
2967
+ Options:
2968
+ -h, --help display help for command
2969
+
2970
+ Commands:
2971
+ list [options] Inspect agent findings or current review
2972
+ work; preserve truncation and cursors.
2973
+ get [options] <agentActionId> Read a proposal and its declared options
2974
+ before deciding.
2975
+ decide [options] <agentActionId> Apply an explicit reviewed decision;
2976
+ unsupported, delete and truncated approvals
2977
+ are refused.
2978
+ help [command] display help for command
2979
+ ```
2980
+
2981
+ ## `ciphrix agent action list`
2982
+
2983
+ ```text
2984
+ Usage: ciphrix agent action list [options]
2985
+
2986
+ Inspect agent findings or current review work; preserve truncation and cursors.
2987
+
2988
+ Options:
2989
+ --agent <value> agent filter; repeat for multiple values
2990
+ --action-type <value> action-type filter; repeat for multiple values
2991
+ --status <value> status filter; repeat for multiple values
2992
+ --initiator-type <value> initiator-type filter; repeat for multiple values
2993
+ --from <value> ISO lower date/time bound
2994
+ --to <value> ISO upper date/time bound
2995
+ --search <value> search visible records
2996
+ --limit <value> page size; server limits apply
2997
+ --job <value> existing background job ID
2998
+ --cursor <value> continuation cursor returned by the preceding page
2999
+ --review-only read the current human-review queue
3000
+ --api-url <url> override the API base URL
3001
+ --json emit one complete result/error envelope
3002
+ --yes confirmed writes only: explicitly authorize without
3003
+ prompting; rejected on reads/immediate writes
3004
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3005
+ identical input, at most 256 characters
3006
+ -h, --help display help for command
3007
+
3008
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3009
+ ```
3010
+
3011
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3012
+
3013
+ ## `ciphrix agent action get`
3014
+
3015
+ ```text
3016
+ Usage: ciphrix agent action get [options] <agentActionId>
3017
+
3018
+ Read a proposal and its declared options before deciding.
3019
+
3020
+ Options:
3021
+ --api-url <url> override the API base URL
3022
+ --json emit one complete result/error envelope
3023
+ --yes confirmed writes only: explicitly authorize without
3024
+ prompting; rejected on reads/immediate writes
3025
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3026
+ identical input, at most 256 characters
3027
+ -h, --help display help for command
3028
+
3029
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3030
+ ```
3031
+
3032
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3033
+
3034
+ ## `ciphrix agent action decide`
3035
+
3036
+ ```text
3037
+ Usage: ciphrix agent action decide [options] <agentActionId>
3038
+
3039
+ Apply an explicit reviewed decision; unsupported, delete and truncated approvals
3040
+ are refused.
3041
+
3042
+ Options:
3043
+ --decision <value> explicit human decision: approve, reject or
3044
+ choose
3045
+ --expected-updated-at <value> exact updatedAt timestamp from the latest read
3046
+ --option <value> exact declared option for choose only; no
3047
+ delete options
3048
+ --reason <value> human explanation for the decision
3049
+ --api-url <url> override the API base URL
3050
+ --json emit one complete result/error envelope
3051
+ --yes confirmed writes only: explicitly authorize
3052
+ without prompting; rejected on reads/immediate
3053
+ writes
3054
+ --idempotency-key <key> writes only: key for one logical operation;
3055
+ reuse identical input, at most 256 characters
3056
+ -h, --help display help for command
3057
+
3058
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3059
+ ```
3060
+
3061
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3062
+
3063
+ ## `ciphrix task`
3064
+
3065
+ ```text
3066
+ Usage: ciphrix task [options] [command]
3067
+
3068
+ Your assigned stored work; discovery never completes tasks
3069
+
3070
+ Options:
3071
+ -h, --help display help for command
3072
+
3073
+ Commands:
3074
+ list [options] Read your assigned stored tasks; does not refresh
3075
+ assignments or complete work.
3076
+ get [options] <taskId> Read your task and its supported next capability;
3077
+ unsupported actions remain in the app.
3078
+ help [command] display help for command
3079
+ ```
3080
+
3081
+ ## `ciphrix task list`
3082
+
3083
+ ```text
3084
+ Usage: ciphrix task list [options]
3085
+
3086
+ Read your assigned stored tasks; does not refresh assignments or complete work.
3087
+
3088
+ Options:
3089
+ --state <value> active or history
3090
+ --task-type <value> active-task filter: all, todo, assignment or action;
3091
+ omit with history
3092
+ --page <value> page number starting at 1
3093
+ --limit <value> page size; server limits apply
3094
+ --api-url <url> override the API base URL
3095
+ --json emit one complete result/error envelope
3096
+ --yes confirmed writes only: explicitly authorize without
3097
+ prompting; rejected on reads/immediate writes
3098
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3099
+ identical input, at most 256 characters
3100
+ -h, --help display help for command
3101
+
3102
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3103
+ ```
3104
+
3105
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3106
+
3107
+ ## `ciphrix task get`
3108
+
3109
+ ```text
3110
+ Usage: ciphrix task get [options] <taskId>
3111
+
3112
+ Read your task and its supported next capability; unsupported actions remain in
3113
+ the app.
3114
+
3115
+ Options:
3116
+ --api-url <url> override the API base URL
3117
+ --json emit one complete result/error envelope
3118
+ --yes confirmed writes only: explicitly authorize without
3119
+ prompting; rejected on reads/immediate writes
3120
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3121
+ identical input, at most 256 characters
3122
+ -h, --help display help for command
3123
+
3124
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3125
+ ```
3126
+
3127
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3128
+
3129
+ ## `ciphrix file`
3130
+
3131
+ ```text
3132
+ Usage: ciphrix file [options] [command]
3133
+
3134
+ Owned local-file staging and explicit processing; no automatic downloads
3135
+
3136
+ Options:
3137
+ -h, --help display help for command
3138
+
3139
+ Commands:
3140
+ stage [options] <path> Stage a local regular file as your current identity;
3141
+ at most 25 MiB, no automatic processing.
3142
+ process [options] Process owned documents-purpose uploads. May update
3143
+ context or create vendors; starts background work.
3144
+ help [command] display help for command
3145
+ ```
3146
+
3147
+ ## `ciphrix file stage`
3148
+
3149
+ ```text
3150
+ Usage: ciphrix file stage [options] <path>
3151
+
3152
+ Stage a local regular file as your current identity; at most 25 MiB, no
3153
+ automatic processing.
3154
+
3155
+ Options:
3156
+ --purpose <value> staging purpose advertised by the server; does not
3157
+ process the file
3158
+ --api-url <url> override the API base URL
3159
+ --json emit one complete result/error envelope
3160
+ --yes confirmed writes only: explicitly authorize without
3161
+ prompting; rejected on reads/immediate writes
3162
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3163
+ identical input, at most 256 characters
3164
+ -h, --help display help for command
3165
+
3166
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3167
+ ```
3168
+
3169
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3170
+
3171
+ ## `ciphrix file process`
3172
+
3173
+ ```text
3174
+ Usage: ciphrix file process [options]
3175
+
3176
+ Process owned documents-purpose uploads. May update context or create vendors;
3177
+ starts background work.
3178
+
3179
+ Options:
3180
+ --upload <value> ready upload ID owned by the caller; repeat to select
3181
+ multiple files
3182
+ --api-url <url> override the API base URL
3183
+ --json emit one complete result/error envelope
3184
+ --yes confirmed writes only: explicitly authorize without
3185
+ prompting; rejected on reads/immediate writes
3186
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3187
+ identical input, at most 256 characters
3188
+ -h, --help display help for command
3189
+
3190
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3191
+ ```
3192
+
3193
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3194
+
3195
+ ## `ciphrix onboarding`
3196
+
3197
+ ```text
3198
+ Usage: ciphrix onboarding [options]
3199
+
3200
+ Learn organizational context, inspect optional setup and explicitly complete the
3201
+ journey. Operating Context does not block completion.
3202
+
3203
+ Options:
3204
+ --status read current journey and separate context
3205
+ readiness
3206
+ --help-onboarding read authenticated server help, all options and
3207
+ current status
3208
+ --get-context <value> read business/operating schema and answers
3209
+ --set-context <value> save one agreed business/operating answer without
3210
+ completing the journey
3211
+ --run-vendor-agent start vendor discovery; may create vendors;
3212
+ requires Business Context 100%
3213
+ --run-risk-agent start initial risk generation; requires Business
3214
+ Context 100%
3215
+ --init-framework <value> initialize a selected framework; may consume
3216
+ quota and notify administrators
3217
+ --complete explicitly complete with Business Context 100%;
3218
+ operating/setup remain optional
3219
+ --question <id> questionId from the selected schema
3220
+ --value <json> strict JSON answer, including quoted JSON strings
3221
+ --additional-context <text> answer explanation; explanation-only answers are
3222
+ supported
3223
+ --api-url <url> override the API base URL
3224
+ --json emit one complete result/error envelope
3225
+ --yes confirmed writes only: explicitly authorize
3226
+ without prompting; rejected on reads/immediate
3227
+ writes
3228
+ --idempotency-key <key> writes only: key for one logical operation; reuse
3229
+ identical input, at most 256 characters
3230
+ -h, --help display help for command
3231
+
3232
+ Writes use one idempotency key per operation. Reuse that key/input for retries; never bypass an unknown outcome with a new key. Confirmed calls also require valid confirmation: a fresh invocation re-preflights and may be blocked by changed state or expiry. Inspect current state/jobs when uncertain. Replayed status packs and signed URLs are snapshots, not refreshed reads.
3233
+ ```
3234
+
3235
+ **Effect:** Write controls apply only when advertised by the server: reads reject them, immediate writes do not accept --yes, and confirmed writes require valid explicit consent. Inspect uncertain outcomes rather than bypassing them with a new key.
3236
+
1588
3237
  ## Behavioral defaults
1589
3238
 
1590
3239
  - API URL selection uses `--api-url`, then `CIPHRIX_API_URL`, then the production API default. API URLs must use HTTPS unless plaintext HTTP is explicitly enabled with `--allow-insecure-http` or `CIPHRIX_ALLOW_INSECURE_HTTP=true`.