@ciphrix/cli 0.1.0 → 0.2.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,23 @@ 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
+ access Access inventory, reviewed imports and assigned
38
+ reviewer workflows
39
+ agent Agent activity, complete proposals and explicit human
40
+ decisions
41
+ task Your assigned stored work; discovery never completes
42
+ tasks
43
+ file Owned local-file staging and explicit processing; no
44
+ automatic downloads
45
+ onboarding [options] Learn organizational context, inspect optional setup
46
+ and explicitly complete the journey. Operating Context
47
+ does not block completion.
37
48
  Configuration:
38
49
  --api-url <url> override the API base URL for one command
39
50
  CIPHRIX_API_URL default API base URL for this process
@@ -172,7 +183,8 @@ Commands:
172
183
  to the current run)
173
184
  attach [options] <name> Attach evidence to a run (defaults to the current
174
185
  run)
175
- run Create, result and delete runs
186
+ run Run lifecycle, human results/notes, linked
187
+ evidence references and advisory assessments
176
188
  available [options] <name> List items available to attach to a run (defaults
177
189
  to the current run)
178
190
  links [options] <name> Show the controls and clauses a test covers
@@ -265,7 +277,8 @@ Options:
265
277
  ```text
266
278
  Usage: ciphrix test run [options] [command]
267
279
 
268
- Create, result and delete runs
280
+ Run lifecycle, human results/notes, linked evidence references and advisory
281
+ assessments
269
282
 
270
283
  Options:
271
284
  -h, --help display help for command
@@ -275,6 +288,10 @@ Commands:
275
288
  result [options] <name> Record a run result: passing | failing | skipped |
276
289
  pending (reopen)
277
290
  delete [options] <name> Delete a run
291
+ file [options] <name> Create a temporary reference for evidence linked to
292
+ this test/run; no automatic download.
293
+ assess [options] <name> Request advisory AI assessment; does not change the
294
+ human run result.
278
295
  help [command] display help for command
279
296
  ```
280
297
 
@@ -302,15 +319,18 @@ Usage: ciphrix test run result [options] <name>
302
319
  Record a run result: passing | failing | skipped | pending (reopen)
303
320
 
304
321
  Options:
305
- --status <status> passing | failing | skipped | pending
322
+ --status <status> human-decided result: passing | failing | skipped |
323
+ pending; omit for note-only changes
306
324
  --note <text> note for the run
325
+ --clear-note clear the note without changing the result; conflicts with
326
+ --note
307
327
  --run <id> a specific run
308
328
  --api-url <url> override the API base URL for this command
309
329
  --json output raw JSON
310
330
  -h, --help display help for command
311
331
  ```
312
332
 
313
- **Effect:** Records a formal test-run result; the CLI prompts if the API requests confirmation.
333
+ **Effect:** Records a human-decided result or changes/clears its note independently; a note-only update never changes the result.
314
334
 
315
335
  ## `ciphrix test run delete`
316
336
 
@@ -329,6 +349,53 @@ Options:
329
349
 
330
350
  **Effect:** Deletes the selected test run; the CLI asks for confirmation when required.
331
351
 
352
+ ## `ciphrix test run file`
353
+
354
+ ```text
355
+ Usage: ciphrix test run file [options] <name>
356
+
357
+ Create a temporary reference for evidence linked to this test/run; no automatic
358
+ download.
359
+
360
+ Options:
361
+ --attachment <value> evidence attachment ID belonging to the selected test
362
+ run
363
+ --run <value> existing run ID; omit to use the current run
364
+ --api-url <url> override the API base URL
365
+ --json emit one complete result/error envelope
366
+ --yes confirmed writes only: explicitly authorize without
367
+ prompting; rejected on reads/immediate writes
368
+ --idempotency-key <key> writes only: key for one logical operation; reuse
369
+ identical input, at most 256 characters
370
+ -h, --help display help for command
371
+
372
+ 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.
373
+ ```
374
+
375
+ **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.
376
+
377
+ ## `ciphrix test run assess`
378
+
379
+ ```text
380
+ Usage: ciphrix test run assess [options] <name>
381
+
382
+ Request advisory AI assessment; does not change the human run result.
383
+
384
+ Options:
385
+ --run <value> existing run ID; omit to use the current run
386
+ --api-url <url> override the API base URL
387
+ --json emit one complete result/error envelope
388
+ --yes confirmed writes only: explicitly authorize without
389
+ prompting; rejected on reads/immediate writes
390
+ --idempotency-key <key> writes only: key for one logical operation; reuse
391
+ identical input, at most 256 characters
392
+ -h, --help display help for command
393
+
394
+ 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.
395
+ ```
396
+
397
+ **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.
398
+
332
399
  ## `ciphrix test available`
333
400
 
334
401
  ```text
@@ -340,6 +407,8 @@ Options:
340
407
  --type <type> item type: native_doc or check
341
408
  --run <id> a specific run
342
409
  --search <text> filter by item name
410
+ --page <n> page number
411
+ --limit <n> page size
343
412
  --api-url <url> override the API base URL for this command
344
413
  --json output raw JSON
345
414
  -h, --help display help for command
@@ -485,6 +554,8 @@ List items that can be mapped to a clause
485
554
  Options:
486
555
  --type <type> item type: test or document
487
556
  --search <text> filter by item name
557
+ --page <n> page number
558
+ --limit <n> page size
488
559
  --api-url <url> override the API base URL for this command
489
560
  --json output raw JSON
490
561
  -h, --help display help for command
@@ -560,16 +631,20 @@ Usage: ciphrix asset list [options]
560
631
  List assets with their code, status and classification
561
632
 
562
633
  Options:
563
- --name <text> filter by name
564
- --category <value> filter by category
565
- --status <csv> filter by status
566
- --business-impact <value> filter by business impact
567
- --data-classification <value> filter by data classification
568
- --page <n> page number
569
- --limit <n> page size
570
- --api-url <url> override the API base URL for this command
571
- --json output raw JSON
572
- -h, --help display help for command
634
+ --name <text> filter by name
635
+ --category <csv> filter by category
636
+ --sub-category <csv> filter by sub-category
637
+ --status <csv> filter by status
638
+ --business-impact <csv> filter by business impact
639
+ --data-classification <csv> filter by data classification
640
+ --source <csv> filter by discovery source (provider, e.g.
641
+ aws, azure, gcp)
642
+ --technical-owner-email <email> filter by technical owner email
643
+ --page <n> page number
644
+ --limit <n> page size
645
+ --api-url <url> override the API base URL for this command
646
+ --json output raw JSON
647
+ -h, --help display help for command
573
648
  ```
574
649
 
575
650
  ## `ciphrix asset get`
@@ -766,13 +841,16 @@ Usage: ciphrix vendor create [options]
766
841
  Create a vendor
767
842
 
768
843
  Options:
769
- --name <name> vendor name
770
- --category <value> category
771
- --criticality <value> criticality
772
- --description <text> description
773
- --api-url <url> override the API base URL for this command
774
- --json output raw JSON
775
- -h, --help display help for command
844
+ --name <name> vendor name
845
+ --category <value> category
846
+ --subcategory <value> sub-category
847
+ --criticality <value> criticality
848
+ --data-sensitivity <value> data sensitivity
849
+ --service-availability <value> service availability
850
+ --description <text> description
851
+ --api-url <url> override the API base URL for this command
852
+ --json output raw JSON
853
+ -h, --help display help for command
776
854
  ```
777
855
 
778
856
  **Effect:** Creates a vendor; the CLI prompts if the API requests confirmation.
@@ -869,7 +947,8 @@ Options:
869
947
  ```text
870
948
  Usage: ciphrix control [options] [command]
871
949
 
872
- Controls: status, applicability, owner and design requirements
950
+ Controls: status, applicability, ownership, design requirements and advisory
951
+ assessments
873
952
 
874
953
  Options:
875
954
  -h, --help display help for command
@@ -883,6 +962,10 @@ Commands:
883
962
  update [options] <control> Change owner, applicability, design
884
963
  requirements or notes
885
964
  link [options] <control> <itemId> Link a test or document to a control
965
+ assess [options] <name> Request/reuse advisory assessment. A cached
966
+ result may have no job ID.
967
+ assessment [options] <name> Read advisory assessment/progress; absence
968
+ means not assessed, not compliant.
886
969
  help [command] display help for command
887
970
  ```
888
971
 
@@ -894,10 +977,13 @@ Usage: ciphrix control list [options]
894
977
  List controls with their status, applicability and owner
895
978
 
896
979
  Options:
980
+ --framework <code> filter by catalogue framework code; repeat for
981
+ multiple values
897
982
  --search <text> filter by name or code
898
983
  --domain <value> filter by control domain
899
984
  --status <csv> filter by status
900
985
  --applicability <value> filter by applicability (in_scope|out_of_scope)
986
+ --owner <csv> filter by owner user id
901
987
  --page <n> page number
902
988
  --limit <n> page size
903
989
  --api-url <url> override the API base URL for this command
@@ -965,6 +1051,7 @@ Options:
965
1051
  --design-requirements <state> not_assessed | not_needed | not_met | partial |
966
1052
  met
967
1053
  --notes <text> notes (Markdown)
1054
+ --description <text> description (custom controls only)
968
1055
  --rename <text> new name (custom controls only)
969
1056
  --yes apply without prompting
970
1057
  --api-url <url> override the API base URL for this command
@@ -992,6 +1079,48 @@ Options:
992
1079
 
993
1080
  **Effect:** Links or unlinks a test or document to a control; the CLI asks for confirmation when required.
994
1081
 
1082
+ ## `ciphrix control assess`
1083
+
1084
+ ```text
1085
+ Usage: ciphrix control assess [options] <name>
1086
+
1087
+ Request/reuse advisory assessment. A cached result may have no job ID.
1088
+
1089
+ Options:
1090
+ --api-url <url> override the API base URL
1091
+ --json emit one complete result/error envelope
1092
+ --yes confirmed writes only: explicitly authorize without
1093
+ prompting; rejected on reads/immediate writes
1094
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1095
+ identical input, at most 256 characters
1096
+ -h, --help display help for command
1097
+
1098
+ 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.
1099
+ ```
1100
+
1101
+ **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.
1102
+
1103
+ ## `ciphrix control assessment`
1104
+
1105
+ ```text
1106
+ Usage: ciphrix control assessment [options] <name>
1107
+
1108
+ Read advisory assessment/progress; absence means not assessed, not compliant.
1109
+
1110
+ Options:
1111
+ --api-url <url> override the API base URL
1112
+ --json emit one complete result/error envelope
1113
+ --yes confirmed writes only: explicitly authorize without
1114
+ prompting; rejected on reads/immediate writes
1115
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1116
+ identical input, at most 256 characters
1117
+ -h, --help display help for command
1118
+
1119
+ 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.
1120
+ ```
1121
+
1122
+ **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.
1123
+
995
1124
  ## `ciphrix document`
996
1125
 
997
1126
  ```text
@@ -1572,6 +1701,1114 @@ Options:
1572
1701
  -h, --help display help for command
1573
1702
  ```
1574
1703
 
1704
+ ## `ciphrix access`
1705
+
1706
+ ```text
1707
+ Usage: ciphrix access [options] [command]
1708
+
1709
+ Access inventory, reviewed imports and assigned reviewer workflows
1710
+
1711
+ Options:
1712
+ -h, --help display help for command
1713
+
1714
+ Commands:
1715
+ resource Resources, owners and asset relationships
1716
+ entry Revisioned access inventory; inventory edits are not review
1717
+ decisions
1718
+ import Your import proposals, selected-row merges and explicit
1719
+ discard
1720
+ review Review campaigns, assigned decisions, completion and frozen
1721
+ outcomes
1722
+ help [command] display help for command
1723
+ ```
1724
+
1725
+ ## `ciphrix access resource`
1726
+
1727
+ ```text
1728
+ Usage: ciphrix access resource [options] [command]
1729
+
1730
+ Resources, owners and asset relationships
1731
+
1732
+ Options:
1733
+ -h, --help display help for command
1734
+
1735
+ Commands:
1736
+ list [options] List review inventory resources and owners.
1737
+ get [options] <resourceId> Read a resource and its current inventory context.
1738
+ create [options] Create manual inventory; reconcile active reviews.
1739
+ update [options] <resourceId> Update inventory. Inactivation also deactivates child access.
1740
+ link-asset [options] <resourceId> <assetId> Link or unlink an existing asset; reconcile reviews.
1741
+ bulk-update [options] Update selected resource owners/statuses; inspect per-row failures.
1742
+ help [command] display help for command
1743
+ ```
1744
+
1745
+ ## `ciphrix access resource list`
1746
+
1747
+ ```text
1748
+ Usage: ciphrix access resource list [options]
1749
+
1750
+ List review inventory resources and owners.
1751
+
1752
+ Options:
1753
+ --page <value> page number starting at 1
1754
+ --limit <value> page size; server limits apply
1755
+ --search <value> search visible records
1756
+ --sort-by <value> server-supported sort field
1757
+ --sort-order <value> sort direction: asc or desc
1758
+ --status <value> inventory status: active or inactive; review/agent
1759
+ operations use their own status vocabulary
1760
+ --owner-person <value> existing People ID for the resource owner
1761
+ --include-empty include resources with no access entries
1762
+ --api-url <url> override the API base URL
1763
+ --json emit one complete result/error envelope
1764
+ --yes confirmed writes only: explicitly authorize without
1765
+ prompting; rejected on reads/immediate writes
1766
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1767
+ identical input, at most 256 characters
1768
+ -h, --help display help for command
1769
+
1770
+ 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.
1771
+ ```
1772
+
1773
+ **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.
1774
+
1775
+ ## `ciphrix access resource get`
1776
+
1777
+ ```text
1778
+ Usage: ciphrix access resource get [options] <resourceId>
1779
+
1780
+ Read a resource and its current inventory context.
1781
+
1782
+ Options:
1783
+ --api-url <url> override the API base URL
1784
+ --json emit one complete result/error envelope
1785
+ --yes confirmed writes only: explicitly authorize without
1786
+ prompting; rejected on reads/immediate writes
1787
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1788
+ identical input, at most 256 characters
1789
+ -h, --help display help for command
1790
+
1791
+ 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.
1792
+ ```
1793
+
1794
+ **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.
1795
+
1796
+ ## `ciphrix access resource create`
1797
+
1798
+ ```text
1799
+ Usage: ciphrix access resource create [options]
1800
+
1801
+ Create manual inventory; reconcile active reviews.
1802
+
1803
+ Options:
1804
+ --name <value> record name
1805
+ --website <value> resource website
1806
+ --owner-person <value> existing People ID for the resource owner
1807
+ --api-url <url> override the API base URL
1808
+ --json emit one complete result/error envelope
1809
+ --yes confirmed writes only: explicitly authorize without
1810
+ prompting; rejected on reads/immediate writes
1811
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1812
+ identical input, at most 256 characters
1813
+ -h, --help display help for command
1814
+
1815
+ 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.
1816
+ ```
1817
+
1818
+ **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.
1819
+
1820
+ ## `ciphrix access resource update`
1821
+
1822
+ ```text
1823
+ Usage: ciphrix access resource update [options] <resourceId>
1824
+
1825
+ Update inventory. Inactivation also deactivates child access.
1826
+
1827
+ Options:
1828
+ --expected-updated-at <value> exact updatedAt timestamp from the latest read
1829
+ --name <value> record name
1830
+ --website <value> resource website
1831
+ --clear-website clear the website; conflicts with --website
1832
+ --owner-person <value> existing People ID for the resource owner
1833
+ --clear-owner clear the owner; conflicts with --owner-person
1834
+ --status <value> inventory status: active or inactive;
1835
+ review/agent operations use their own status
1836
+ vocabulary
1837
+ --api-url <url> override the API base URL
1838
+ --json emit one complete result/error envelope
1839
+ --yes confirmed writes only: explicitly authorize
1840
+ without prompting; rejected on reads/immediate
1841
+ writes
1842
+ --idempotency-key <key> writes only: key for one logical operation;
1843
+ reuse identical input, at most 256 characters
1844
+ -h, --help display help for command
1845
+
1846
+ 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.
1847
+ ```
1848
+
1849
+ **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.
1850
+
1851
+ ## `ciphrix access resource link-asset`
1852
+
1853
+ ```text
1854
+ Usage: ciphrix access resource link-asset [options] <resourceId> <assetId>
1855
+
1856
+ Link or unlink an existing asset; reconcile reviews.
1857
+
1858
+ Options:
1859
+ --action <value> explicit link or unlink action
1860
+ --api-url <url> override the API base URL
1861
+ --json emit one complete result/error envelope
1862
+ --yes confirmed writes only: explicitly authorize without
1863
+ prompting; rejected on reads/immediate writes
1864
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1865
+ identical input, at most 256 characters
1866
+ -h, --help display help for command
1867
+
1868
+ 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.
1869
+ ```
1870
+
1871
+ **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.
1872
+
1873
+ ## `ciphrix access resource bulk-update`
1874
+
1875
+ ```text
1876
+ Usage: ciphrix access resource bulk-update [options]
1877
+
1878
+ Update selected resource owners/statuses; inspect per-row failures.
1879
+
1880
+ Options:
1881
+ --resource <value> existing resource ID; repeat for multiple selections
1882
+ where supported
1883
+ --owner-person <value> existing People ID for the resource owner
1884
+ --clear-owner clear the owner; conflicts with --owner-person
1885
+ --status <value> inventory status: active or inactive; review/agent
1886
+ operations use their own status vocabulary
1887
+ --api-url <url> override the API base URL
1888
+ --json emit one complete result/error envelope
1889
+ --yes confirmed writes only: explicitly authorize without
1890
+ prompting; rejected on reads/immediate writes
1891
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1892
+ identical input, at most 256 characters
1893
+ -h, --help display help for command
1894
+
1895
+ 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.
1896
+ ```
1897
+
1898
+ **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.
1899
+
1900
+ ## `ciphrix access entry`
1901
+
1902
+ ```text
1903
+ Usage: ciphrix access entry [options] [command]
1904
+
1905
+ Revisioned access inventory; inventory edits are not review decisions
1906
+
1907
+ Options:
1908
+ -h, --help display help for command
1909
+
1910
+ Commands:
1911
+ list [options] List current access inventory; no review
1912
+ decisions are recorded.
1913
+ get [options] <accessId> Read current inventory revision and prior review
1914
+ outcome.
1915
+ create [options] Create manual access inventory, not a review
1916
+ decision.
1917
+ update [options] <accessId> Update revisioned inventory; integration-owned
1918
+ fields stay locked.
1919
+ bulk-update [options] Update one field on selected revisioned entries;
1920
+ inspect partial failures.
1921
+ help [command] display help for command
1922
+ ```
1923
+
1924
+ ## `ciphrix access entry list`
1925
+
1926
+ ```text
1927
+ Usage: ciphrix access entry list [options]
1928
+
1929
+ List current access inventory; no review decisions are recorded.
1930
+
1931
+ Options:
1932
+ --page <value> page number starting at 1
1933
+ --limit <value> page size; server limits apply
1934
+ --search <value> search visible records
1935
+ --sort-by <value> server-supported sort field
1936
+ --sort-order <value> sort direction: asc or desc
1937
+ --resource <value> existing resource ID; repeat for multiple
1938
+ selections where supported
1939
+ --person <value> existing People ID for the access identity
1940
+ --owner-person <value> existing People ID for the resource owner
1941
+ --status <value> inventory status: active or inactive; review/agent
1942
+ operations use their own status vocabulary
1943
+ --review-state <value> inventory: needs_review, pending, keep, revoke or
1944
+ inactive; reviewer task: pending or all
1945
+ --reviewed-before <value> ISO review-history cutoff
1946
+ --api-url <url> override the API base URL
1947
+ --json emit one complete result/error envelope
1948
+ --yes confirmed writes only: explicitly authorize without
1949
+ prompting; rejected on reads/immediate writes
1950
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1951
+ identical input, at most 256 characters
1952
+ -h, --help display help for command
1953
+
1954
+ 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.
1955
+ ```
1956
+
1957
+ **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.
1958
+
1959
+ ## `ciphrix access entry get`
1960
+
1961
+ ```text
1962
+ Usage: ciphrix access entry get [options] <accessId>
1963
+
1964
+ Read current inventory revision and prior review outcome.
1965
+
1966
+ Options:
1967
+ --api-url <url> override the API base URL
1968
+ --json emit one complete result/error envelope
1969
+ --yes confirmed writes only: explicitly authorize without
1970
+ prompting; rejected on reads/immediate writes
1971
+ --idempotency-key <key> writes only: key for one logical operation; reuse
1972
+ identical input, at most 256 characters
1973
+ -h, --help display help for command
1974
+
1975
+ 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.
1976
+ ```
1977
+
1978
+ **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.
1979
+
1980
+ ## `ciphrix access entry create`
1981
+
1982
+ ```text
1983
+ Usage: ciphrix access entry create [options]
1984
+
1985
+ Create manual access inventory, not a review decision.
1986
+
1987
+ Options:
1988
+ --resource <value> existing resource ID; repeat for multiple selections
1989
+ where supported
1990
+ --identity <value> reported account identity; does not change
1991
+ authentication
1992
+ --role <value> inventory access role; does not change product
1993
+ authorization
1994
+ --person <value> existing People ID for the access identity
1995
+ --status <value> inventory status: active or inactive; review/agent
1996
+ operations use their own status vocabulary
1997
+ --api-url <url> override the API base URL
1998
+ --json emit one complete result/error envelope
1999
+ --yes confirmed writes only: explicitly authorize without
2000
+ prompting; rejected on reads/immediate writes
2001
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2002
+ identical input, at most 256 characters
2003
+ -h, --help display help for command
2004
+
2005
+ 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.
2006
+ ```
2007
+
2008
+ **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.
2009
+
2010
+ ## `ciphrix access entry update`
2011
+
2012
+ ```text
2013
+ Usage: ciphrix access entry update [options] <accessId>
2014
+
2015
+ Update revisioned inventory; integration-owned fields stay locked.
2016
+
2017
+ Options:
2018
+ --expected-revision <value> current revision from the latest entry or
2019
+ reviewer-task read
2020
+ --identity <value> reported account identity; does not change
2021
+ authentication
2022
+ --role <value> inventory access role; does not change product
2023
+ authorization
2024
+ --person <value> existing People ID for the access identity
2025
+ --clear-person leave the identity unmatched; conflicts with
2026
+ --person
2027
+ --status <value> inventory status: active or inactive;
2028
+ review/agent operations use their own status
2029
+ vocabulary
2030
+ --api-url <url> override the API base URL
2031
+ --json emit one complete result/error envelope
2032
+ --yes confirmed writes only: explicitly authorize
2033
+ without prompting; rejected on reads/immediate
2034
+ writes
2035
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2036
+ identical input, at most 256 characters
2037
+ -h, --help display help for command
2038
+
2039
+ 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.
2040
+ ```
2041
+
2042
+ **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.
2043
+
2044
+ ## `ciphrix access entry bulk-update`
2045
+
2046
+ ```text
2047
+ Usage: ciphrix access entry bulk-update [options]
2048
+
2049
+ Update one field on selected revisioned entries; inspect partial failures.
2050
+
2051
+ Options:
2052
+ --rows-file <value> JSON array of explicitly selected rows; regular file,
2053
+ at most 1 MiB
2054
+ --field <value> single inventory field to update on every selected
2055
+ row
2056
+ --value <value> strict JSON value; quote strings as JSON and use null
2057
+ only where supported
2058
+ --api-url <url> override the API base URL
2059
+ --json emit one complete result/error envelope
2060
+ --yes confirmed writes only: explicitly authorize without
2061
+ prompting; rejected on reads/immediate writes
2062
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2063
+ identical input, at most 256 characters
2064
+ -h, --help display help for command
2065
+
2066
+ 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.
2067
+
2068
+
2069
+ 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.
2070
+ ```
2071
+
2072
+ **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.
2073
+
2074
+ ## `ciphrix access import`
2075
+
2076
+ ```text
2077
+ Usage: ciphrix access import [options] [command]
2078
+
2079
+ Your import proposals, selected-row merges and explicit discard
2080
+
2081
+ Options:
2082
+ -h, --help display help for command
2083
+
2084
+ Commands:
2085
+ start [options] Extract a proposal from owned register_import
2086
+ uploads; does not merge.
2087
+ list [options] List your unresolved imports using cursor
2088
+ pagination.
2089
+ get [options] <importId> Inspect proposal rows, matches, evidence and
2090
+ revisions before merging.
2091
+ merge [options] <importId> Merge only reviewed selected rows; preserve
2092
+ corrections and explicit confirmations.
2093
+ discard [options] <importId> Stop extraction/merge; retain successful merges
2094
+ and independent enrichment.
2095
+ help [command] display help for command
2096
+ ```
2097
+
2098
+ ## `ciphrix access import start`
2099
+
2100
+ ```text
2101
+ Usage: ciphrix access import start [options]
2102
+
2103
+ Extract a proposal from owned register_import uploads; does not merge.
2104
+
2105
+ Options:
2106
+ --upload <value> ready upload ID owned by the caller; repeat to select
2107
+ multiple files
2108
+ --api-url <url> override the API base URL
2109
+ --json emit one complete result/error envelope
2110
+ --yes confirmed writes only: explicitly authorize without
2111
+ prompting; rejected on reads/immediate writes
2112
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2113
+ identical input, at most 256 characters
2114
+ -h, --help display help for command
2115
+
2116
+ 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.
2117
+ ```
2118
+
2119
+ **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.
2120
+
2121
+ ## `ciphrix access import list`
2122
+
2123
+ ```text
2124
+ Usage: ciphrix access import list [options]
2125
+
2126
+ List your unresolved imports using cursor pagination.
2127
+
2128
+ Options:
2129
+ --cursor <value> continuation cursor returned by the preceding page
2130
+ --limit <value> page size; server limits apply
2131
+ --api-url <url> override the API base URL
2132
+ --json emit one complete result/error envelope
2133
+ --yes confirmed writes only: explicitly authorize without
2134
+ prompting; rejected on reads/immediate writes
2135
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2136
+ identical input, at most 256 characters
2137
+ -h, --help display help for command
2138
+
2139
+ 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.
2140
+ ```
2141
+
2142
+ **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.
2143
+
2144
+ ## `ciphrix access import get`
2145
+
2146
+ ```text
2147
+ Usage: ciphrix access import get [options] <importId>
2148
+
2149
+ Inspect proposal rows, matches, evidence and revisions before merging.
2150
+
2151
+ Options:
2152
+ --cursor <value> continuation cursor returned by the preceding page
2153
+ --limit <value> page size; server limits apply
2154
+ --filter <value> proposal-row filter: all, new, unchanged, update or
2155
+ conflict
2156
+ --search <value> search visible records
2157
+ --ids-only return proposal-row IDs instead of full details
2158
+ --api-url <url> override the API base URL
2159
+ --json emit one complete result/error envelope
2160
+ --yes confirmed writes only: explicitly authorize without
2161
+ prompting; rejected on reads/immediate writes
2162
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2163
+ identical input, at most 256 characters
2164
+ -h, --help display help for command
2165
+
2166
+ 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.
2167
+ ```
2168
+
2169
+ **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.
2170
+
2171
+ ## `ciphrix access import merge`
2172
+
2173
+ ```text
2174
+ Usage: ciphrix access import merge [options] <importId>
2175
+
2176
+ Merge only reviewed selected rows; preserve corrections and explicit
2177
+ confirmations.
2178
+
2179
+ Options:
2180
+ --rows-file <value> JSON array of explicitly selected rows; regular file,
2181
+ at most 1 MiB
2182
+ --api-url <url> override the API base URL
2183
+ --json emit one complete result/error envelope
2184
+ --yes confirmed writes only: explicitly authorize without
2185
+ prompting; rejected on reads/immediate writes
2186
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2187
+ identical input, at most 256 characters
2188
+ -h, --help display help for command
2189
+
2190
+ 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.
2191
+
2192
+
2193
+ 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.
2194
+ ```
2195
+
2196
+ **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.
2197
+
2198
+ ## `ciphrix access import discard`
2199
+
2200
+ ```text
2201
+ Usage: ciphrix access import discard [options] <importId>
2202
+
2203
+ Stop extraction/merge; retain successful merges and independent enrichment.
2204
+
2205
+ Options:
2206
+ --api-url <url> override the API base URL
2207
+ --json emit one complete result/error envelope
2208
+ --yes confirmed writes only: explicitly authorize without
2209
+ prompting; rejected on reads/immediate writes
2210
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2211
+ identical input, at most 256 characters
2212
+ -h, --help display help for command
2213
+
2214
+ 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.
2215
+ ```
2216
+
2217
+ **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.
2218
+
2219
+ ## `ciphrix access review`
2220
+
2221
+ ```text
2222
+ Usage: ciphrix access review [options] [command]
2223
+
2224
+ Review campaigns, assigned decisions, completion and frozen outcomes
2225
+
2226
+ Options:
2227
+ -h, --help display help for command
2228
+
2229
+ Commands:
2230
+ preview [options] Preview selected eligible owners and unresolved
2231
+ entries without creating work.
2232
+ start [options] Create a review, reviewer tasks and assignment
2233
+ notifications.
2234
+ list [options] Read active progress or closed/cancelled history.
2235
+ task [options] <taskId> Read your assigned reviewer task, current
2236
+ revisions and decisions.
2237
+ decide [options] <taskId> Record explicit keep/revoke decisions. Revoke is
2238
+ a removal request, not provider revocation.
2239
+ complete [options] <taskId> Complete your assigned task after all decisions;
2240
+ may close a fully reviewed campaign.
2241
+ result [options] <reviewId> Read frozen outcomes; pending/unresolved never
2242
+ imply approval.
2243
+ end [options] <reviewId> Explicitly close with current outcomes or cancel
2244
+ without a result; close reviewer tasks.
2245
+ export [options] <reviewId> Create a temporary signed CSV reference; no
2246
+ automatic download.
2247
+ help [command] display help for command
2248
+ ```
2249
+
2250
+ ## `ciphrix access review preview`
2251
+
2252
+ ```text
2253
+ Usage: ciphrix access review preview [options]
2254
+
2255
+ Preview selected eligible owners and unresolved entries without creating work.
2256
+
2257
+ Options:
2258
+ --resource <value> existing resource ID; repeat for multiple selections
2259
+ where supported
2260
+ --due-at <value> ISO due date/time; review creation defaults to 14
2261
+ days if omitted
2262
+ --api-url <url> override the API base URL
2263
+ --json emit one complete result/error envelope
2264
+ --yes confirmed writes only: explicitly authorize without
2265
+ prompting; rejected on reads/immediate writes
2266
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2267
+ identical input, at most 256 characters
2268
+ -h, --help display help for command
2269
+
2270
+ 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.
2271
+ ```
2272
+
2273
+ **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.
2274
+
2275
+ ## `ciphrix access review start`
2276
+
2277
+ ```text
2278
+ Usage: ciphrix access review start [options]
2279
+
2280
+ Create a review, reviewer tasks and assignment notifications.
2281
+
2282
+ Options:
2283
+ --name <value> record name
2284
+ --resource <value> existing resource ID; repeat for multiple selections
2285
+ where supported
2286
+ --due-at <value> ISO due date/time; review creation defaults to 14
2287
+ days if omitted
2288
+ --api-url <url> override the API base URL
2289
+ --json emit one complete result/error envelope
2290
+ --yes confirmed writes only: explicitly authorize without
2291
+ prompting; rejected on reads/immediate writes
2292
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2293
+ identical input, at most 256 characters
2294
+ -h, --help display help for command
2295
+
2296
+ 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.
2297
+ ```
2298
+
2299
+ **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.
2300
+
2301
+ ## `ciphrix access review list`
2302
+
2303
+ ```text
2304
+ Usage: ciphrix access review list [options]
2305
+
2306
+ Read active progress or closed/cancelled history.
2307
+
2308
+ Options:
2309
+ --status <value> review filter: active, closed, cancelled or history
2310
+ --page <value> page number starting at 1
2311
+ --limit <value> page size; server limits apply
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 review task`
2326
+
2327
+ ```text
2328
+ Usage: ciphrix access review task [options] <taskId>
2329
+
2330
+ Read your assigned reviewer task, current revisions and decisions.
2331
+
2332
+ Options:
2333
+ --page <value> page number starting at 1
2334
+ --limit <value> page size; server limits apply
2335
+ --search <value> search visible records
2336
+ --review-state <value> inventory: needs_review, pending, keep, revoke or
2337
+ inactive; reviewer task: pending or all
2338
+ --api-url <url> override the API base URL
2339
+ --json emit one complete result/error envelope
2340
+ --yes confirmed writes only: explicitly authorize without
2341
+ prompting; rejected on reads/immediate writes
2342
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2343
+ identical input, at most 256 characters
2344
+ -h, --help display help for command
2345
+
2346
+ 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.
2347
+ ```
2348
+
2349
+ **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.
2350
+
2351
+ ## `ciphrix access review decide`
2352
+
2353
+ ```text
2354
+ Usage: ciphrix access review decide [options] <taskId>
2355
+
2356
+ Record explicit keep/revoke decisions. Revoke is a removal request, not provider
2357
+ revocation.
2358
+
2359
+ Options:
2360
+ --items-file <value> JSON array of accessId, expectedRevision, decision
2361
+ and optional comment; at most 1 MiB
2362
+ --api-url <url> override the API base URL
2363
+ --json emit one complete result/error envelope
2364
+ --yes confirmed writes only: explicitly authorize without
2365
+ prompting; rejected on reads/immediate writes
2366
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2367
+ identical input, at most 256 characters
2368
+ -h, --help display help for command
2369
+
2370
+ 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.
2371
+
2372
+
2373
+ 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.
2374
+ ```
2375
+
2376
+ **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.
2377
+
2378
+ ## `ciphrix access review complete`
2379
+
2380
+ ```text
2381
+ Usage: ciphrix access review complete [options] <taskId>
2382
+
2383
+ Complete your assigned task after all decisions; may close a fully reviewed
2384
+ campaign.
2385
+
2386
+ Options:
2387
+ --api-url <url> override the API base URL
2388
+ --json emit one complete result/error envelope
2389
+ --yes confirmed writes only: explicitly authorize without
2390
+ prompting; rejected on reads/immediate writes
2391
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2392
+ identical input, at most 256 characters
2393
+ -h, --help display help for command
2394
+
2395
+ 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.
2396
+ ```
2397
+
2398
+ **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.
2399
+
2400
+ ## `ciphrix access review result`
2401
+
2402
+ ```text
2403
+ Usage: ciphrix access review result [options] <reviewId>
2404
+
2405
+ Read frozen outcomes; pending/unresolved never imply approval.
2406
+
2407
+ Options:
2408
+ --page <value> page number starting at 1
2409
+ --limit <value> page size; server limits apply
2410
+ --search <value> search visible records
2411
+ --resource <value> existing resource ID; repeat for multiple selections
2412
+ where supported
2413
+ --outcome <value> frozen outcome filter: keep, revoke, pending,
2414
+ unresolved or inactive
2415
+ --api-url <url> override the API base URL
2416
+ --json emit one complete result/error envelope
2417
+ --yes confirmed writes only: explicitly authorize without
2418
+ prompting; rejected on reads/immediate writes
2419
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2420
+ identical input, at most 256 characters
2421
+ -h, --help display help for command
2422
+
2423
+ 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.
2424
+ ```
2425
+
2426
+ **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.
2427
+
2428
+ ## `ciphrix access review end`
2429
+
2430
+ ```text
2431
+ Usage: ciphrix access review end [options] <reviewId>
2432
+
2433
+ Explicitly close with current outcomes or cancel without a result; close
2434
+ reviewer tasks.
2435
+
2436
+ Options:
2437
+ --status <value> closed freezes outcomes; cancelled creates no result
2438
+ --api-url <url> override the API base URL
2439
+ --json emit one complete result/error envelope
2440
+ --yes confirmed writes only: explicitly authorize without
2441
+ prompting; rejected on reads/immediate writes
2442
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2443
+ identical input, at most 256 characters
2444
+ -h, --help display help for command
2445
+
2446
+ 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.
2447
+ ```
2448
+
2449
+ **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.
2450
+
2451
+ ## `ciphrix access review export`
2452
+
2453
+ ```text
2454
+ Usage: ciphrix access review export [options] <reviewId>
2455
+
2456
+ Create a temporary signed CSV reference; no automatic download.
2457
+
2458
+ Options:
2459
+ --api-url <url> override the API base URL
2460
+ --json emit one complete result/error envelope
2461
+ --yes confirmed writes only: explicitly authorize without
2462
+ prompting; rejected on reads/immediate writes
2463
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2464
+ identical input, at most 256 characters
2465
+ -h, --help display help for command
2466
+
2467
+ 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.
2468
+ ```
2469
+
2470
+ **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.
2471
+
2472
+ ## `ciphrix agent`
2473
+
2474
+ ```text
2475
+ Usage: ciphrix agent [options] [command]
2476
+
2477
+ Agent activity, complete proposals and explicit human decisions
2478
+
2479
+ Options:
2480
+ -h, --help display help for command
2481
+
2482
+ Commands:
2483
+ run Grouped agent activity; findings are not completed assessments
2484
+ action Findings, reviewed proposals and declared
2485
+ approve/reject/choose options
2486
+ help [command] display help for command
2487
+ ```
2488
+
2489
+ ## `ciphrix agent run`
2490
+
2491
+ ```text
2492
+ Usage: ciphrix agent run [options] [command]
2493
+
2494
+ Grouped agent activity; findings are not completed assessments
2495
+
2496
+ Options:
2497
+ -h, --help display help for command
2498
+
2499
+ Commands:
2500
+ list [options] List grouped agent activity; counts are not completed
2501
+ assessments.
2502
+ help [command] display help for command
2503
+ ```
2504
+
2505
+ ## `ciphrix agent run list`
2506
+
2507
+ ```text
2508
+ Usage: ciphrix agent run list [options]
2509
+
2510
+ List grouped agent activity; counts are not completed assessments.
2511
+
2512
+ Options:
2513
+ --agent <value> agent filter; repeat for multiple values
2514
+ --action-type <value> action-type filter; repeat for multiple values
2515
+ --status <value> status filter; repeat for multiple values
2516
+ --initiator-type <value> initiator-type filter; repeat for multiple values
2517
+ --from <value> ISO lower date/time bound
2518
+ --to <value> ISO upper date/time bound
2519
+ --search <value> search visible records
2520
+ --limit <value> page size; server limits apply
2521
+ --offset <value> number of grouped results to skip
2522
+ --api-url <url> override the API base URL
2523
+ --json emit one complete result/error envelope
2524
+ --yes confirmed writes only: explicitly authorize without
2525
+ prompting; rejected on reads/immediate writes
2526
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2527
+ identical input, at most 256 characters
2528
+ -h, --help display help for command
2529
+
2530
+ 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.
2531
+ ```
2532
+
2533
+ **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.
2534
+
2535
+ ## `ciphrix agent action`
2536
+
2537
+ ```text
2538
+ Usage: ciphrix agent action [options] [command]
2539
+
2540
+ Findings, reviewed proposals and declared approve/reject/choose options
2541
+
2542
+ Options:
2543
+ -h, --help display help for command
2544
+
2545
+ Commands:
2546
+ list [options] Inspect agent findings or current review
2547
+ work; preserve truncation and cursors.
2548
+ get [options] <agentActionId> Read a proposal and its declared options
2549
+ before deciding.
2550
+ decide [options] <agentActionId> Apply an explicit reviewed decision;
2551
+ unsupported, delete and truncated approvals
2552
+ are refused.
2553
+ help [command] display help for command
2554
+ ```
2555
+
2556
+ ## `ciphrix agent action list`
2557
+
2558
+ ```text
2559
+ Usage: ciphrix agent action list [options]
2560
+
2561
+ Inspect agent findings or current review work; preserve truncation and cursors.
2562
+
2563
+ Options:
2564
+ --agent <value> agent filter; repeat for multiple values
2565
+ --action-type <value> action-type filter; repeat for multiple values
2566
+ --status <value> status filter; repeat for multiple values
2567
+ --initiator-type <value> initiator-type filter; repeat for multiple values
2568
+ --from <value> ISO lower date/time bound
2569
+ --to <value> ISO upper date/time bound
2570
+ --search <value> search visible records
2571
+ --limit <value> page size; server limits apply
2572
+ --job <value> existing background job ID
2573
+ --cursor <value> continuation cursor returned by the preceding page
2574
+ --review-only read the current human-review queue
2575
+ --api-url <url> override the API base URL
2576
+ --json emit one complete result/error envelope
2577
+ --yes confirmed writes only: explicitly authorize without
2578
+ prompting; rejected on reads/immediate writes
2579
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2580
+ identical input, at most 256 characters
2581
+ -h, --help display help for command
2582
+
2583
+ 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.
2584
+ ```
2585
+
2586
+ **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.
2587
+
2588
+ ## `ciphrix agent action get`
2589
+
2590
+ ```text
2591
+ Usage: ciphrix agent action get [options] <agentActionId>
2592
+
2593
+ Read a proposal and its declared options before deciding.
2594
+
2595
+ Options:
2596
+ --api-url <url> override the API base URL
2597
+ --json emit one complete result/error envelope
2598
+ --yes confirmed writes only: explicitly authorize without
2599
+ prompting; rejected on reads/immediate writes
2600
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2601
+ identical input, at most 256 characters
2602
+ -h, --help display help for command
2603
+
2604
+ 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.
2605
+ ```
2606
+
2607
+ **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.
2608
+
2609
+ ## `ciphrix agent action decide`
2610
+
2611
+ ```text
2612
+ Usage: ciphrix agent action decide [options] <agentActionId>
2613
+
2614
+ Apply an explicit reviewed decision; unsupported, delete and truncated approvals
2615
+ are refused.
2616
+
2617
+ Options:
2618
+ --decision <value> explicit human decision: approve, reject or
2619
+ choose
2620
+ --expected-updated-at <value> exact updatedAt timestamp from the latest read
2621
+ --option <value> exact declared option for choose only; no
2622
+ delete options
2623
+ --reason <value> human explanation for the decision
2624
+ --api-url <url> override the API base URL
2625
+ --json emit one complete result/error envelope
2626
+ --yes confirmed writes only: explicitly authorize
2627
+ without prompting; rejected on reads/immediate
2628
+ writes
2629
+ --idempotency-key <key> writes only: key for one logical operation;
2630
+ reuse identical input, at most 256 characters
2631
+ -h, --help display help for command
2632
+
2633
+ 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.
2634
+ ```
2635
+
2636
+ **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.
2637
+
2638
+ ## `ciphrix task`
2639
+
2640
+ ```text
2641
+ Usage: ciphrix task [options] [command]
2642
+
2643
+ Your assigned stored work; discovery never completes tasks
2644
+
2645
+ Options:
2646
+ -h, --help display help for command
2647
+
2648
+ Commands:
2649
+ list [options] Read your assigned stored tasks; does not refresh
2650
+ assignments or complete work.
2651
+ get [options] <taskId> Read your task and its supported next capability;
2652
+ unsupported actions remain in the app.
2653
+ help [command] display help for command
2654
+ ```
2655
+
2656
+ ## `ciphrix task list`
2657
+
2658
+ ```text
2659
+ Usage: ciphrix task list [options]
2660
+
2661
+ Read your assigned stored tasks; does not refresh assignments or complete work.
2662
+
2663
+ Options:
2664
+ --state <value> active or history
2665
+ --task-type <value> active-task filter: all, todo, assignment or action;
2666
+ omit with history
2667
+ --page <value> page number starting at 1
2668
+ --limit <value> page size; server limits apply
2669
+ --api-url <url> override the API base URL
2670
+ --json emit one complete result/error envelope
2671
+ --yes confirmed writes only: explicitly authorize without
2672
+ prompting; rejected on reads/immediate writes
2673
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2674
+ identical input, at most 256 characters
2675
+ -h, --help display help for command
2676
+
2677
+ 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.
2678
+ ```
2679
+
2680
+ **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.
2681
+
2682
+ ## `ciphrix task get`
2683
+
2684
+ ```text
2685
+ Usage: ciphrix task get [options] <taskId>
2686
+
2687
+ Read your task and its supported next capability; unsupported actions remain in
2688
+ the app.
2689
+
2690
+ Options:
2691
+ --api-url <url> override the API base URL
2692
+ --json emit one complete result/error envelope
2693
+ --yes confirmed writes only: explicitly authorize without
2694
+ prompting; rejected on reads/immediate writes
2695
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2696
+ identical input, at most 256 characters
2697
+ -h, --help display help for command
2698
+
2699
+ 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.
2700
+ ```
2701
+
2702
+ **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.
2703
+
2704
+ ## `ciphrix file`
2705
+
2706
+ ```text
2707
+ Usage: ciphrix file [options] [command]
2708
+
2709
+ Owned local-file staging and explicit processing; no automatic downloads
2710
+
2711
+ Options:
2712
+ -h, --help display help for command
2713
+
2714
+ Commands:
2715
+ stage [options] <path> Stage a local regular file as your current identity;
2716
+ at most 25 MiB, no automatic processing.
2717
+ process [options] Process owned documents-purpose uploads. May update
2718
+ context or create vendors; starts background work.
2719
+ help [command] display help for command
2720
+ ```
2721
+
2722
+ ## `ciphrix file stage`
2723
+
2724
+ ```text
2725
+ Usage: ciphrix file stage [options] <path>
2726
+
2727
+ Stage a local regular file as your current identity; at most 25 MiB, no
2728
+ automatic processing.
2729
+
2730
+ Options:
2731
+ --purpose <value> staging purpose advertised by the server; does not
2732
+ process the file
2733
+ --api-url <url> override the API base URL
2734
+ --json emit one complete result/error envelope
2735
+ --yes confirmed writes only: explicitly authorize without
2736
+ prompting; rejected on reads/immediate writes
2737
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2738
+ identical input, at most 256 characters
2739
+ -h, --help display help for command
2740
+
2741
+ 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.
2742
+ ```
2743
+
2744
+ **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.
2745
+
2746
+ ## `ciphrix file process`
2747
+
2748
+ ```text
2749
+ Usage: ciphrix file process [options]
2750
+
2751
+ Process owned documents-purpose uploads. May update context or create vendors;
2752
+ starts background work.
2753
+
2754
+ Options:
2755
+ --upload <value> ready upload ID owned by the caller; repeat to select
2756
+ multiple files
2757
+ --api-url <url> override the API base URL
2758
+ --json emit one complete result/error envelope
2759
+ --yes confirmed writes only: explicitly authorize without
2760
+ prompting; rejected on reads/immediate writes
2761
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2762
+ identical input, at most 256 characters
2763
+ -h, --help display help for command
2764
+
2765
+ 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.
2766
+ ```
2767
+
2768
+ **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.
2769
+
2770
+ ## `ciphrix onboarding`
2771
+
2772
+ ```text
2773
+ Usage: ciphrix onboarding [options]
2774
+
2775
+ Learn organizational context, inspect optional setup and explicitly complete the
2776
+ journey. Operating Context does not block completion.
2777
+
2778
+ Options:
2779
+ --status read current journey and separate context
2780
+ readiness
2781
+ --help-onboarding read authenticated server help, all options and
2782
+ current status
2783
+ --get-context <value> read business/operating schema and answers
2784
+ --set-context <value> save one agreed business/operating answer without
2785
+ completing the journey
2786
+ --run-vendor-agent start vendor discovery; may create vendors;
2787
+ requires Business Context 100%
2788
+ --run-risk-agent start initial risk generation; requires Business
2789
+ Context 100%
2790
+ --init-framework <value> initialize a selected framework; may consume
2791
+ quota and notify administrators
2792
+ --complete explicitly complete with Business Context 100%;
2793
+ operating/setup remain optional
2794
+ --question <id> questionId from the selected schema
2795
+ --value <json> strict JSON answer, including quoted JSON strings
2796
+ --additional-context <text> answer explanation; explanation-only answers are
2797
+ supported
2798
+ --api-url <url> override the API base URL
2799
+ --json emit one complete result/error envelope
2800
+ --yes confirmed writes only: explicitly authorize
2801
+ without prompting; rejected on reads/immediate
2802
+ writes
2803
+ --idempotency-key <key> writes only: key for one logical operation; reuse
2804
+ identical input, at most 256 characters
2805
+ -h, --help display help for command
2806
+
2807
+ 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.
2808
+ ```
2809
+
2810
+ **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.
2811
+
1575
2812
  ## Behavioral defaults
1576
2813
 
1577
2814
  - 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`.