@ciphrix/cli 0.1.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.
Files changed (63) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +201 -0
  3. package/dist/actions.d.ts +19 -0
  4. package/dist/actions.js +30 -0
  5. package/dist/api.d.ts +27 -0
  6. package/dist/api.js +180 -0
  7. package/dist/banner.d.ts +2 -0
  8. package/dist/banner.js +12 -0
  9. package/dist/browser.d.ts +2 -0
  10. package/dist/browser.js +44 -0
  11. package/dist/cli.d.ts +14 -0
  12. package/dist/cli.js +1579 -0
  13. package/dist/commands/asset.d.ts +59 -0
  14. package/dist/commands/asset.js +237 -0
  15. package/dist/commands/check.d.ts +30 -0
  16. package/dist/commands/check.js +182 -0
  17. package/dist/commands/context.d.ts +23 -0
  18. package/dist/commands/context.js +102 -0
  19. package/dist/commands/control.d.ts +44 -0
  20. package/dist/commands/control.js +189 -0
  21. package/dist/commands/framework.d.ts +40 -0
  22. package/dist/commands/framework.js +181 -0
  23. package/dist/commands/job.d.ts +16 -0
  24. package/dist/commands/job.js +30 -0
  25. package/dist/commands/login.d.ts +12 -0
  26. package/dist/commands/login.js +54 -0
  27. package/dist/commands/logout.d.ts +9 -0
  28. package/dist/commands/logout.js +56 -0
  29. package/dist/commands/policy.d.ts +23 -0
  30. package/dist/commands/policy.js +112 -0
  31. package/dist/commands/policyActions.d.ts +37 -0
  32. package/dist/commands/policyActions.js +177 -0
  33. package/dist/commands/risk.d.ts +51 -0
  34. package/dist/commands/risk.js +289 -0
  35. package/dist/commands/test.d.ts +54 -0
  36. package/dist/commands/test.js +331 -0
  37. package/dist/commands/vendor.d.ts +45 -0
  38. package/dist/commands/vendor.js +218 -0
  39. package/dist/config.d.ts +12 -0
  40. package/dist/config.js +56 -0
  41. package/dist/constants.d.ts +7 -0
  42. package/dist/constants.js +7 -0
  43. package/dist/credentials.d.ts +19 -0
  44. package/dist/credentials.js +182 -0
  45. package/dist/deviceFlow.d.ts +32 -0
  46. package/dist/deviceFlow.js +115 -0
  47. package/dist/deviceInfo.d.ts +11 -0
  48. package/dist/deviceInfo.js +25 -0
  49. package/dist/index.d.ts +2 -0
  50. package/dist/index.js +4 -0
  51. package/dist/io.d.ts +46 -0
  52. package/dist/io.js +99 -0
  53. package/dist/output.d.ts +14 -0
  54. package/dist/output.js +37 -0
  55. package/dist/theme.d.ts +25 -0
  56. package/dist/theme.js +39 -0
  57. package/dist/toolSurface.d.ts +20 -0
  58. package/dist/toolSurface.js +49 -0
  59. package/dist/upload.d.ts +18 -0
  60. package/dist/upload.js +115 -0
  61. package/package.json +71 -0
  62. package/skills/ciphrix/SKILL.md +169 -0
  63. package/skills/ciphrix/references/commands.md +1592 -0
@@ -0,0 +1,1592 @@
1
+ # Ciphrix CLI command reference
2
+
3
+ > Generated from the Commander command tree and help output. Regenerate with `npm run commands:generate`; CI checks for drift with `npm run commands:check`.
4
+ >
5
+ > Live `ciphrix --help` and `ciphrix <command> --help` output is authoritative for the installed version.
6
+
7
+ The sections below are captured from the CLI help implementation. Positional arguments in `<angle brackets>` are required; `[square brackets]` are optional. `Options` lists flags accepted by that command. Commander defaults are shown when defined in the command tree; descriptions also call out defaults that are part of the public interface.
8
+
9
+ ## `ciphrix`
10
+
11
+ ```text
12
+ Usage: ciphrix [options] [command]
13
+
14
+ Ciphrix compliance platform CLI
15
+
16
+ Options:
17
+ -v, --version output the version number
18
+ --allow-insecure-http allow plaintext HTTP for intentional local or
19
+ non-production testing only
20
+ -h, --help display help for command
21
+
22
+ Commands:
23
+ login [options] [url] Sign in to Ciphrix with device authorization
24
+ logout [options] Revoke the remote session and remove the stored
25
+ credential
26
+ context Read and update Business / Operating Context
27
+ test Tests, their runs, items and ownership
28
+ framework Applied frameworks
29
+ asset The asset register
30
+ vendor Manage vendors
31
+ control Controls: status, applicability, owner and design
32
+ requirements
33
+ document Browse, read and change documents
34
+ risk Manage risks
35
+ check Monitoring checks
36
+ job Check background jobs started by other commands
37
+ Configuration:
38
+ --api-url <url> override the API base URL for one command
39
+ CIPHRIX_API_URL default API base URL for this process
40
+ CIPHRIX_CREDENTIAL_STORE=file use plaintext file credentials for local/headless testing
41
+ CIPHRIX_ALLOW_INSECURE_HTTP=true
42
+ permit HTTP for intentional local testing
43
+
44
+ Production and the OS keychain are used by default. No general config file is read.
45
+ See the README Configuration section for precedence and security details.
46
+ ```
47
+
48
+ ## `ciphrix login`
49
+
50
+ ```text
51
+ Usage: ciphrix login [options] [url]
52
+
53
+ Sign in to Ciphrix with device authorization
54
+
55
+ Options:
56
+ --api-url <url> override the API base URL for this command
57
+ --device-name <name> a name for this device (defaults to the machine name)
58
+ --no-open do not open the verification link in a browser
59
+ -h, --help display help for command
60
+ ```
61
+
62
+ **Effect:** Starts device authorization and stores the credential after sign-in succeeds; opens the verification link by default unless --no-open is supplied.
63
+
64
+ ## `ciphrix logout`
65
+
66
+ ```text
67
+ Usage: ciphrix logout [options]
68
+
69
+ Revoke the remote session and remove the stored credential
70
+
71
+ Options:
72
+ --api-url <url> override the API base URL for this command
73
+ --local-only remove the local credential without revoking the remote
74
+ session
75
+ -h, --help display help for command
76
+ ```
77
+
78
+ **Effect:** Revokes the remote session before removing the stored credential; use --local-only to remove the local credential without remote revocation.
79
+
80
+ ## `ciphrix context`
81
+
82
+ ```text
83
+ Usage: ciphrix context [options] [command]
84
+
85
+ Read and update Business / Operating Context
86
+
87
+ Options:
88
+ -h, --help display help for command
89
+
90
+ Commands:
91
+ get [options] <store> Print a context digest (business | operating)
92
+ status [options] <store> Show context completion and unanswered
93
+ questions
94
+ set [options] <target> <value> Set one answer, for example
95
+ business.company_size "50-200"
96
+ reset [options] Reset Business Context (asks to confirm)
97
+ help [command] display help for command
98
+ ```
99
+
100
+ ## `ciphrix context get`
101
+
102
+ ```text
103
+ Usage: ciphrix context get [options] <store>
104
+
105
+ Print a context digest (business | operating)
106
+
107
+ Options:
108
+ --api-url <url> override the API base URL for this command
109
+ --json output raw JSON
110
+ -h, --help display help for command
111
+ ```
112
+
113
+ ## `ciphrix context status`
114
+
115
+ ```text
116
+ Usage: ciphrix context status [options] <store>
117
+
118
+ Show context completion and unanswered questions
119
+
120
+ Options:
121
+ --api-url <url> override the API base URL for this command
122
+ --json output raw JSON
123
+ -h, --help display help for command
124
+ ```
125
+
126
+ ## `ciphrix context set`
127
+
128
+ ```text
129
+ Usage: ciphrix context set [options] <target> <value>
130
+
131
+ Set one answer, for example business.company_size "50-200"
132
+
133
+ Options:
134
+ --api-url <url> override the API base URL for this command
135
+ --json output raw JSON
136
+ -h, --help display help for command
137
+ ```
138
+
139
+ **Effect:** Changes a Business or Operating Context answer through the direct API write path.
140
+
141
+ ## `ciphrix context reset`
142
+
143
+ ```text
144
+ Usage: ciphrix context reset [options]
145
+
146
+ Reset Business Context (asks to confirm)
147
+
148
+ Options:
149
+ --yes apply without prompting
150
+ --api-url <url> override the API base URL for this command
151
+ --json output raw JSON
152
+ -h, --help display help for command
153
+ ```
154
+
155
+ **Effect:** Resets Business Context. The CLI asks for confirmation when required; --yes skips that prompt.
156
+
157
+ ## `ciphrix test`
158
+
159
+ ```text
160
+ Usage: ciphrix test [options] [command]
161
+
162
+ Tests, their runs, items and ownership
163
+
164
+ Options:
165
+ -h, --help display help for command
166
+
167
+ Commands:
168
+ list [options] List tests with their latest run status
169
+ get [options] <name> Show a test, its runs and AI assurance
170
+ runs [options] <name> List a test’s runs with AI assurance
171
+ items [options] <name> List a run’s evidence with AI relevance (defaults
172
+ to the current run)
173
+ attach [options] <name> Attach evidence to a run (defaults to the current
174
+ run)
175
+ run Create, result and delete runs
176
+ available [options] <name> List items available to attach to a run (defaults
177
+ to the current run)
178
+ links [options] <name> Show the controls and clauses a test covers
179
+ update [options] <name> Change applicability, responsibility, assignee,
180
+ frequency or auto-pass
181
+ delete [options] <name> Delete a custom test
182
+ help [command] display help for command
183
+ ```
184
+
185
+ ## `ciphrix test list`
186
+
187
+ ```text
188
+ Usage: ciphrix test list [options]
189
+
190
+ List tests with their latest run status
191
+
192
+ Options:
193
+ --search <text> filter by name
194
+ --status <csv> filter by latest run status
195
+ --page <n> page number
196
+ --limit <n> page size
197
+ --api-url <url> override the API base URL for this command
198
+ --json output raw JSON
199
+ -h, --help display help for command
200
+ ```
201
+
202
+ ## `ciphrix test get`
203
+
204
+ ```text
205
+ Usage: ciphrix test get [options] <name>
206
+
207
+ Show a test, its runs and AI assurance
208
+
209
+ Options:
210
+ --api-url <url> override the API base URL for this command
211
+ --json output raw JSON
212
+ -h, --help display help for command
213
+ ```
214
+
215
+ ## `ciphrix test runs`
216
+
217
+ ```text
218
+ Usage: ciphrix test runs [options] <name>
219
+
220
+ List a test’s runs with AI assurance
221
+
222
+ Options:
223
+ --api-url <url> override the API base URL for this command
224
+ --json output raw JSON
225
+ -h, --help display help for command
226
+ ```
227
+
228
+ ## `ciphrix test items`
229
+
230
+ ```text
231
+ Usage: ciphrix test items [options] <name>
232
+
233
+ List a run’s evidence with AI relevance (defaults to the current run)
234
+
235
+ Options:
236
+ --run <id> a specific run
237
+ --api-url <url> override the API base URL for this command
238
+ --json output raw JSON
239
+ -h, --help display help for command
240
+ ```
241
+
242
+ ## `ciphrix test attach`
243
+
244
+ ```text
245
+ Usage: ciphrix test attach [options] <name>
246
+
247
+ Attach evidence to a run (defaults to the current run)
248
+
249
+ Options:
250
+ --check <id> link a check
251
+ --native-doc <id> link a native document
252
+ --upload <id> link a staged upload id
253
+ --file <path> upload a local file and attach it
254
+ --run <id> a specific run
255
+ --unlink unlink instead of link
256
+ --api-url <url> override the API base URL for this command
257
+ --json output raw JSON
258
+ -h, --help display help for command
259
+ ```
260
+
261
+ **Effect:** Attaches or unlinks evidence. A local --file is uploaded and attached in the same command; the command can return a background job id.
262
+
263
+ ## `ciphrix test run`
264
+
265
+ ```text
266
+ Usage: ciphrix test run [options] [command]
267
+
268
+ Create, result and delete runs
269
+
270
+ Options:
271
+ -h, --help display help for command
272
+
273
+ Commands:
274
+ create [options] <name> Create a new pending run
275
+ result [options] <name> Record a run result: passing | failing | skipped |
276
+ pending (reopen)
277
+ delete [options] <name> Delete a run
278
+ help [command] display help for command
279
+ ```
280
+
281
+ ## `ciphrix test run create`
282
+
283
+ ```text
284
+ Usage: ciphrix test run create [options] <name>
285
+
286
+ Create a new pending run
287
+
288
+ Options:
289
+ --run-at <date> run date (ISO); defaults to now
290
+ --api-url <url> override the API base URL for this command
291
+ --json output raw JSON
292
+ -h, --help display help for command
293
+ ```
294
+
295
+ **Effect:** Creates a pending test run; the CLI prompts if the API requests confirmation.
296
+
297
+ ## `ciphrix test run result`
298
+
299
+ ```text
300
+ Usage: ciphrix test run result [options] <name>
301
+
302
+ Record a run result: passing | failing | skipped | pending (reopen)
303
+
304
+ Options:
305
+ --status <status> passing | failing | skipped | pending
306
+ --note <text> note for the run
307
+ --run <id> a specific run
308
+ --api-url <url> override the API base URL for this command
309
+ --json output raw JSON
310
+ -h, --help display help for command
311
+ ```
312
+
313
+ **Effect:** Records a formal test-run result; the CLI prompts if the API requests confirmation.
314
+
315
+ ## `ciphrix test run delete`
316
+
317
+ ```text
318
+ Usage: ciphrix test run delete [options] <name>
319
+
320
+ Delete a run
321
+
322
+ Options:
323
+ --run <id> the run to delete
324
+ --yes apply without prompting
325
+ --api-url <url> override the API base URL for this command
326
+ --json output raw JSON
327
+ -h, --help display help for command
328
+ ```
329
+
330
+ **Effect:** Deletes the selected test run; the CLI asks for confirmation when required.
331
+
332
+ ## `ciphrix test available`
333
+
334
+ ```text
335
+ Usage: ciphrix test available [options] <name>
336
+
337
+ List items available to attach to a run (defaults to the current run)
338
+
339
+ Options:
340
+ --type <type> item type: native_doc or check
341
+ --run <id> a specific run
342
+ --search <text> filter by item name
343
+ --api-url <url> override the API base URL for this command
344
+ --json output raw JSON
345
+ -h, --help display help for command
346
+ ```
347
+
348
+ ## `ciphrix test links`
349
+
350
+ ```text
351
+ Usage: ciphrix test links [options] <name>
352
+
353
+ Show the controls and clauses a test covers
354
+
355
+ Options:
356
+ --api-url <url> override the API base URL for this command
357
+ --json output raw JSON
358
+ -h, --help display help for command
359
+ ```
360
+
361
+ ## `ciphrix test update`
362
+
363
+ ```text
364
+ Usage: ciphrix test update [options] <name>
365
+
366
+ Change applicability, responsibility, assignee, frequency or auto-pass
367
+
368
+ Options:
369
+ --applicability <value> in_scope or out_of_scope
370
+ --responsibility <value> internal, third_party or shared
371
+ --assigned-to <id> owner user id
372
+ --frequency <value> none, monthly, quarterly, half-yearly or yearly
373
+ --next-run-at <date> ISO date for the next run
374
+ --auto-pass <on|off> auto-pass from checks
375
+ --rename <text> new name (custom tests only)
376
+ --guidance <text> new guidance (custom tests only)
377
+ --yes apply without prompting
378
+ --api-url <url> override the API base URL for this command
379
+ --json output raw JSON
380
+ -h, --help display help for command
381
+ ```
382
+
383
+ **Effect:** Changes test settings; the CLI asks for confirmation when required.
384
+
385
+ ## `ciphrix test delete`
386
+
387
+ ```text
388
+ Usage: ciphrix test delete [options] <name>
389
+
390
+ Delete a custom test
391
+
392
+ Options:
393
+ --yes apply without prompting
394
+ --api-url <url> override the API base URL for this command
395
+ --json output raw JSON
396
+ -h, --help display help for command
397
+ ```
398
+
399
+ **Effect:** Deletes a custom test; the CLI asks for confirmation when required.
400
+
401
+ ## `ciphrix framework`
402
+
403
+ ```text
404
+ Usage: ciphrix framework [options] [command]
405
+
406
+ Applied frameworks
407
+
408
+ Options:
409
+ -h, --help display help for command
410
+
411
+ Commands:
412
+ list [options] List applied frameworks with status and available frameworks
413
+ clauses [options] <framework> List a framework’s clauses
414
+ clause [options] <framework> <clause> Show one clause by code or name
415
+ items [options] <framework> <clause> List the items mapped to a clause
416
+ available [options] <framework> <clause> List items that can be mapped to a clause
417
+ update [options] <framework> <clause> Change a clause’s applicability or design-requirement assessment
418
+ link [options] <framework> <clause> <itemId> Map a test or document to a clause
419
+ help [command] display help for command
420
+ ```
421
+
422
+ ## `ciphrix framework list`
423
+
424
+ ```text
425
+ Usage: ciphrix framework list [options]
426
+
427
+ List applied frameworks with status and available frameworks
428
+
429
+ Options:
430
+ --api-url <url> override the API base URL for this command
431
+ --json output raw JSON
432
+ -h, --help display help for command
433
+ ```
434
+
435
+ ## `ciphrix framework clauses`
436
+
437
+ ```text
438
+ Usage: ciphrix framework clauses [options] <framework>
439
+
440
+ List a framework’s clauses
441
+
442
+ Options:
443
+ --search <text> filter by clause code or name
444
+ --applicability <value> in_scope or out_of_scope
445
+ --page <n> page number
446
+ --limit <n> page size
447
+ --api-url <url> override the API base URL for this command
448
+ --json output raw JSON
449
+ -h, --help display help for command
450
+ ```
451
+
452
+ ## `ciphrix framework clause`
453
+
454
+ ```text
455
+ Usage: ciphrix framework clause [options] <framework> <clause>
456
+
457
+ Show one clause by code or name
458
+
459
+ Options:
460
+ --api-url <url> override the API base URL for this command
461
+ --json output raw JSON
462
+ -h, --help display help for command
463
+ ```
464
+
465
+ ## `ciphrix framework items`
466
+
467
+ ```text
468
+ Usage: ciphrix framework items [options] <framework> <clause>
469
+
470
+ List the items mapped to a clause
471
+
472
+ Options:
473
+ --api-url <url> override the API base URL for this command
474
+ --json output raw JSON
475
+ -h, --help display help for command
476
+ ```
477
+
478
+ ## `ciphrix framework available`
479
+
480
+ ```text
481
+ Usage: ciphrix framework available [options] <framework> <clause>
482
+
483
+ List items that can be mapped to a clause
484
+
485
+ Options:
486
+ --type <type> item type: test or document
487
+ --search <text> filter by item name
488
+ --api-url <url> override the API base URL for this command
489
+ --json output raw JSON
490
+ -h, --help display help for command
491
+ ```
492
+
493
+ ## `ciphrix framework update`
494
+
495
+ ```text
496
+ Usage: ciphrix framework update [options] <framework> <clause>
497
+
498
+ Change a clause’s applicability or design-requirement assessment
499
+
500
+ Options:
501
+ --applicability <value> in_scope or out_of_scope
502
+ --justification <text> why the applicability changed
503
+ --design-requirements <state> not_assessed | not_needed | not_met | partial |
504
+ met
505
+ --yes apply without prompting
506
+ --api-url <url> override the API base URL for this command
507
+ --json output raw JSON
508
+ -h, --help display help for command
509
+ ```
510
+
511
+ **Effect:** Changes a clause assessment; the CLI asks for confirmation when required.
512
+
513
+ ## `ciphrix framework link`
514
+
515
+ ```text
516
+ Usage: ciphrix framework link [options] <framework> <clause> <itemId>
517
+
518
+ Map a test or document to a clause
519
+
520
+ Options:
521
+ --type <type> item type: test or document
522
+ --unlink unlink instead of link
523
+ --yes apply without prompting
524
+ --api-url <url> override the API base URL for this command
525
+ --json output raw JSON
526
+ -h, --help display help for command
527
+ ```
528
+
529
+ **Effect:** Links or unlinks a test or document to a clause; the CLI asks for confirmation when required.
530
+
531
+ ## `ciphrix asset`
532
+
533
+ ```text
534
+ Usage: ciphrix asset [options] [command]
535
+
536
+ The asset register
537
+
538
+ Options:
539
+ -h, --help display help for command
540
+
541
+ Commands:
542
+ list [options] List assets with their code, status and
543
+ classification
544
+ get [options] <asset> Show one asset by code, customer key or name
545
+ links [options] <asset> List the controls, risks, tests or checks mapped to
546
+ an asset
547
+ update [options] <asset> Change asset fields
548
+ create [options] Create an asset
549
+ delete [options] <asset> Delete an asset
550
+ tags [options] <asset> List an asset’s tags
551
+ tag [options] <asset> Assign a key/value tag to an asset, or remove one
552
+ help [command] display help for command
553
+ ```
554
+
555
+ ## `ciphrix asset list`
556
+
557
+ ```text
558
+ Usage: ciphrix asset list [options]
559
+
560
+ List assets with their code, status and classification
561
+
562
+ 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
573
+ ```
574
+
575
+ ## `ciphrix asset get`
576
+
577
+ ```text
578
+ Usage: ciphrix asset get [options] <asset>
579
+
580
+ Show one asset by code, customer key or name
581
+
582
+ Options:
583
+ --api-url <url> override the API base URL for this command
584
+ --json output raw JSON
585
+ -h, --help display help for command
586
+ ```
587
+
588
+ ## `ciphrix asset links`
589
+
590
+ ```text
591
+ Usage: ciphrix asset links [options] <asset>
592
+
593
+ List the controls, risks, tests or checks mapped to an asset
594
+
595
+ Options:
596
+ --type <type> controls, risks, tests or checks
597
+ --page <n> page number
598
+ --limit <n> page size
599
+ --api-url <url> override the API base URL for this command
600
+ --json output raw JSON
601
+ -h, --help display help for command
602
+ ```
603
+
604
+ ## `ciphrix asset update`
605
+
606
+ ```text
607
+ Usage: ciphrix asset update [options] <asset>
608
+
609
+ Change asset fields
610
+
611
+ Options:
612
+ --name <text> rename
613
+ --description <text> description
614
+ --category <value> category
615
+ --sub-category <value> sub-category
616
+ --status <value> status
617
+ --data-classification <value> data classification
618
+ --business-impact <value> business impact
619
+ --technical-owner <id> technical owner user id
620
+ --business-owner <value> business owner
621
+ --customer-asset-key <value> the tenant’s own key for this asset
622
+ --external-ref <value> external reference id
623
+ --location <value> location
624
+ --yes apply without prompting
625
+ --api-url <url> override the API base URL for this command
626
+ --json output raw JSON
627
+ -h, --help display help for command
628
+ ```
629
+
630
+ **Effect:** Changes asset fields; the CLI asks for confirmation when required.
631
+
632
+ ## `ciphrix asset create`
633
+
634
+ ```text
635
+ Usage: ciphrix asset create [options]
636
+
637
+ Create an asset
638
+
639
+ Options:
640
+ --name <name> asset name
641
+ --category <value> category
642
+ --sub-category <value> sub-category
643
+ --customer-key <value> the tenant’s own key for this asset
644
+ --external-ref <value> external reference id
645
+ --description <text> description
646
+ --status <value> status
647
+ --business-impact <value> business impact
648
+ --data-classification <value> data classification
649
+ --technical-owner <id> technical owner user id
650
+ --business-owner <value> business owner
651
+ --location <value> location
652
+ --api-url <url> override the API base URL for this command
653
+ --json output raw JSON
654
+ -h, --help display help for command
655
+ ```
656
+
657
+ **Effect:** Creates an asset; the CLI prompts if the API requests confirmation.
658
+
659
+ ## `ciphrix asset delete`
660
+
661
+ ```text
662
+ Usage: ciphrix asset delete [options] <asset>
663
+
664
+ Delete an asset
665
+
666
+ Options:
667
+ --yes apply without prompting
668
+ --api-url <url> override the API base URL for this command
669
+ --json output raw JSON
670
+ -h, --help display help for command
671
+ ```
672
+
673
+ **Effect:** Deletes an asset; the CLI asks for confirmation when required.
674
+
675
+ ## `ciphrix asset tags`
676
+
677
+ ```text
678
+ Usage: ciphrix asset tags [options] <asset>
679
+
680
+ List an asset’s tags
681
+
682
+ Options:
683
+ --api-url <url> override the API base URL for this command
684
+ --json output raw JSON
685
+ -h, --help display help for command
686
+ ```
687
+
688
+ ## `ciphrix asset tag`
689
+
690
+ ```text
691
+ Usage: ciphrix asset tag [options] <asset>
692
+
693
+ Assign a key/value tag to an asset, or remove one
694
+
695
+ Options:
696
+ --key <key> tag key
697
+ --value <value> tag value
698
+ --unlink <mappingId> tag mapping id to remove
699
+ --yes apply without prompting
700
+ --api-url <url> override the API base URL for this command
701
+ --json output raw JSON
702
+ -h, --help display help for command
703
+ ```
704
+
705
+ **Effect:** Adds or removes an asset tag; the CLI asks for confirmation when required.
706
+
707
+ ## `ciphrix vendor`
708
+
709
+ ```text
710
+ Usage: ciphrix vendor [options] [command]
711
+
712
+ Manage vendors
713
+
714
+ Options:
715
+ -h, --help display help for command
716
+
717
+ Commands:
718
+ list [options] List vendors with a total count
719
+ get [options] <name> Show one vendor
720
+ create [options] Create a vendor
721
+ update [options] <name> Update vendor fields
722
+ delete [options] <name> Delete a vendor
723
+ files [options] <name> List the files attached to a vendor
724
+ attach [options] <name> Attach a file to a vendor
725
+ detach [options] <name> <mappingId> Detach a file from a vendor by its
726
+ mapping id
727
+ help [command] display help for command
728
+ ```
729
+
730
+ ## `ciphrix vendor list`
731
+
732
+ ```text
733
+ Usage: ciphrix vendor list [options]
734
+
735
+ List vendors with a total count
736
+
737
+ Options:
738
+ --name <text> filter by name
739
+ --criticality <value> filter by criticality
740
+ --relationship-status <value> filter by relationship status
741
+ --page <n> page number
742
+ --limit <n> page size
743
+ --api-url <url> override the API base URL for this command
744
+ --json output raw JSON
745
+ -h, --help display help for command
746
+ ```
747
+
748
+ ## `ciphrix vendor get`
749
+
750
+ ```text
751
+ Usage: ciphrix vendor get [options] <name>
752
+
753
+ Show one vendor
754
+
755
+ Options:
756
+ --api-url <url> override the API base URL for this command
757
+ --json output raw JSON
758
+ -h, --help display help for command
759
+ ```
760
+
761
+ ## `ciphrix vendor create`
762
+
763
+ ```text
764
+ Usage: ciphrix vendor create [options]
765
+
766
+ Create a vendor
767
+
768
+ 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
776
+ ```
777
+
778
+ **Effect:** Creates a vendor; the CLI prompts if the API requests confirmation.
779
+
780
+ ## `ciphrix vendor update`
781
+
782
+ ```text
783
+ Usage: ciphrix vendor update [options] <name>
784
+
785
+ Update vendor fields
786
+
787
+ Options:
788
+ --name <value> rename
789
+ --website <value> website
790
+ --description <value> description
791
+ --category <value> category
792
+ --criticality <value> business criticality
793
+ --data-sensitivity <value> public | internal | confidential | pii | phi
794
+ --relationship-status <value> active | inactive | onboarding | terminated
795
+ --review-status <value> pending | completed | expired
796
+ --internal-owner <value> internal owner (email)
797
+ --api-url <url> override the API base URL for this command
798
+ --json output raw JSON
799
+ -h, --help display help for command
800
+ ```
801
+
802
+ **Effect:** Changes vendor fields; the CLI prompts if the API requests confirmation.
803
+
804
+ ## `ciphrix vendor delete`
805
+
806
+ ```text
807
+ Usage: ciphrix vendor delete [options] <name>
808
+
809
+ Delete a vendor
810
+
811
+ Options:
812
+ --yes apply without prompting
813
+ --api-url <url> override the API base URL for this command
814
+ --json output raw JSON
815
+ -h, --help display help for command
816
+ ```
817
+
818
+ **Effect:** Deletes a vendor; the CLI asks for confirmation when required.
819
+
820
+ ## `ciphrix vendor files`
821
+
822
+ ```text
823
+ Usage: ciphrix vendor files [options] <name>
824
+
825
+ List the files attached to a vendor
826
+
827
+ Options:
828
+ --api-url <url> override the API base URL for this command
829
+ --json output raw JSON
830
+ -h, --help display help for command
831
+ ```
832
+
833
+ ## `ciphrix vendor attach`
834
+
835
+ ```text
836
+ Usage: ciphrix vendor attach [options] <name>
837
+
838
+ Attach a file to a vendor
839
+
840
+ Options:
841
+ --file <path> stage and attach a local file
842
+ --upload <id> attach an already-staged upload
843
+ --yes apply without prompting
844
+ --api-url <url> override the API base URL for this command
845
+ --json output raw JSON
846
+ -h, --help display help for command
847
+ ```
848
+
849
+ **Effect:** Attaches a staged or local file; the CLI asks for confirmation when required.
850
+
851
+ ## `ciphrix vendor detach`
852
+
853
+ ```text
854
+ Usage: ciphrix vendor detach [options] <name> <mappingId>
855
+
856
+ Detach a file from a vendor by its mapping id
857
+
858
+ Options:
859
+ --yes apply without prompting
860
+ --api-url <url> override the API base URL for this command
861
+ --json output raw JSON
862
+ -h, --help display help for command
863
+ ```
864
+
865
+ **Effect:** Detaches a file; the CLI asks for confirmation when required.
866
+
867
+ ## `ciphrix control`
868
+
869
+ ```text
870
+ Usage: ciphrix control [options] [command]
871
+
872
+ Controls: status, applicability, owner and design requirements
873
+
874
+ Options:
875
+ -h, --help display help for command
876
+
877
+ Commands:
878
+ list [options] List controls with their status,
879
+ applicability and owner
880
+ get [options] <control> Show one control by name or code
881
+ items [options] <control> List the items linked to a control
882
+ available [options] <control> List items that can be linked to a control
883
+ update [options] <control> Change owner, applicability, design
884
+ requirements or notes
885
+ link [options] <control> <itemId> Link a test or document to a control
886
+ help [command] display help for command
887
+ ```
888
+
889
+ ## `ciphrix control list`
890
+
891
+ ```text
892
+ Usage: ciphrix control list [options]
893
+
894
+ List controls with their status, applicability and owner
895
+
896
+ Options:
897
+ --search <text> filter by name or code
898
+ --domain <value> filter by control domain
899
+ --status <csv> filter by status
900
+ --applicability <value> filter by applicability (in_scope|out_of_scope)
901
+ --page <n> page number
902
+ --limit <n> page size
903
+ --api-url <url> override the API base URL for this command
904
+ --json output raw JSON
905
+ -h, --help display help for command
906
+ ```
907
+
908
+ ## `ciphrix control get`
909
+
910
+ ```text
911
+ Usage: ciphrix control get [options] <control>
912
+
913
+ Show one control by name or code
914
+
915
+ Options:
916
+ --api-url <url> override the API base URL for this command
917
+ --json output raw JSON
918
+ -h, --help display help for command
919
+ ```
920
+
921
+ ## `ciphrix control items`
922
+
923
+ ```text
924
+ Usage: ciphrix control items [options] <control>
925
+
926
+ List the items linked to a control
927
+
928
+ Options:
929
+ --search <text> filter by item name
930
+ --page <n> page number
931
+ --limit <n> page size
932
+ --api-url <url> override the API base URL for this command
933
+ --json output raw JSON
934
+ -h, --help display help for command
935
+ ```
936
+
937
+ ## `ciphrix control available`
938
+
939
+ ```text
940
+ Usage: ciphrix control available [options] <control>
941
+
942
+ List items that can be linked to a control
943
+
944
+ Options:
945
+ --type <type> item type: test or document
946
+ --search <text> filter by item name
947
+ --page <n> page number
948
+ --limit <n> page size
949
+ --api-url <url> override the API base URL for this command
950
+ --json output raw JSON
951
+ -h, --help display help for command
952
+ ```
953
+
954
+ ## `ciphrix control update`
955
+
956
+ ```text
957
+ Usage: ciphrix control update [options] <control>
958
+
959
+ Change owner, applicability, design requirements or notes
960
+
961
+ Options:
962
+ --owner <id|none> owner user id, or none to clear
963
+ --applicability <value> in_scope or out_of_scope
964
+ --justification <text> why the applicability changed
965
+ --design-requirements <state> not_assessed | not_needed | not_met | partial |
966
+ met
967
+ --notes <text> notes (Markdown)
968
+ --rename <text> new name (custom controls only)
969
+ --yes apply without prompting
970
+ --api-url <url> override the API base URL for this command
971
+ --json output raw JSON
972
+ -h, --help display help for command
973
+ ```
974
+
975
+ **Effect:** Changes control fields; the CLI asks for confirmation when required.
976
+
977
+ ## `ciphrix control link`
978
+
979
+ ```text
980
+ Usage: ciphrix control link [options] <control> <itemId>
981
+
982
+ Link a test or document to a control
983
+
984
+ Options:
985
+ --type <type> item type: test or document
986
+ --unlink unlink instead of link
987
+ --yes apply without prompting
988
+ --api-url <url> override the API base URL for this command
989
+ --json output raw JSON
990
+ -h, --help display help for command
991
+ ```
992
+
993
+ **Effect:** Links or unlinks a test or document to a control; the CLI asks for confirmation when required.
994
+
995
+ ## `ciphrix document`
996
+
997
+ ```text
998
+ Usage: ciphrix document [options] [command]
999
+
1000
+ Browse, read and change documents
1001
+
1002
+ Options:
1003
+ -h, --help display help for command
1004
+
1005
+ Commands:
1006
+ list [options] List documents with status and counts
1007
+ get [options] <document> Print a document as Markdown (by name or id)
1008
+ update [options] <document> Update document metadata
1009
+ versions [options] <document> Show a document’s version history
1010
+ create [options] Create a new blank document
1011
+ edit [options] <document> Replace the content of a draft document with
1012
+ Markdown
1013
+ version [options] <document> Create a new draft version of a document
1014
+ submit [options] <document> Submit a draft document for review
1015
+ approve [options] <document> Approve a document awaiting approval
1016
+ delete [options] <document> Delete a document
1017
+ help [command] display help for command
1018
+ ```
1019
+
1020
+ ## `ciphrix document list`
1021
+
1022
+ ```text
1023
+ Usage: ciphrix document list [options]
1024
+
1025
+ List documents with status and counts
1026
+
1027
+ Options:
1028
+ --name <text> filter by name
1029
+ --status <csv> filter by workflow status
1030
+ --page <n> page number
1031
+ --limit <n> page size
1032
+ --api-url <url> override the API base URL for this command
1033
+ --json output raw JSON
1034
+ -h, --help display help for command
1035
+ ```
1036
+
1037
+ ## `ciphrix document get`
1038
+
1039
+ ```text
1040
+ Usage: ciphrix document get [options] <document>
1041
+
1042
+ Print a document as Markdown (by name or id)
1043
+
1044
+ Options:
1045
+ --version-number <n> a specific version number
1046
+ --minor-number <n> a specific minor version (with --version-number)
1047
+ --api-url <url> override the API base URL for this command
1048
+ --json output raw JSON
1049
+ -h, --help display help for command
1050
+ ```
1051
+
1052
+ ## `ciphrix document update`
1053
+
1054
+ ```text
1055
+ Usage: ciphrix document update [options] <document>
1056
+
1057
+ Update document metadata
1058
+
1059
+ Options:
1060
+ --name <value> rename
1061
+ --description <value> description
1062
+ --type <value> document type
1063
+ --publish <on|off> published state
1064
+ --api-url <url> override the API base URL for this command
1065
+ --json output raw JSON
1066
+ -h, --help display help for command
1067
+ ```
1068
+
1069
+ **Effect:** Changes document metadata; the CLI prompts if the API requests confirmation.
1070
+
1071
+ ## `ciphrix document versions`
1072
+
1073
+ ```text
1074
+ Usage: ciphrix document versions [options] <document>
1075
+
1076
+ Show a document’s version history
1077
+
1078
+ Options:
1079
+ --api-url <url> override the API base URL for this command
1080
+ --json output raw JSON
1081
+ -h, --help display help for command
1082
+ ```
1083
+
1084
+ ## `ciphrix document create`
1085
+
1086
+ ```text
1087
+ Usage: ciphrix document create [options]
1088
+
1089
+ Create a new blank document
1090
+
1091
+ Options:
1092
+ --name <name> policy name
1093
+ --type <type> document type
1094
+ --description <text> short description
1095
+ --api-url <url> override the API base URL for this command
1096
+ --json output raw JSON
1097
+ -h, --help display help for command
1098
+ ```
1099
+
1100
+ **Effect:** Creates a blank document; the CLI prompts if the API requests confirmation.
1101
+
1102
+ ## `ciphrix document edit`
1103
+
1104
+ ```text
1105
+ Usage: ciphrix document edit [options] <document>
1106
+
1107
+ Replace the content of a draft document with Markdown
1108
+
1109
+ Options:
1110
+ --file <path> read the new Markdown from a file
1111
+ --content <markdown> new Markdown inline
1112
+ --yes apply without prompting
1113
+ --api-url <url> override the API base URL for this command
1114
+ --json output raw JSON
1115
+ -h, --help display help for command
1116
+ ```
1117
+
1118
+ **Effect:** Replaces draft document content; the CLI asks for confirmation when required.
1119
+
1120
+ ## `ciphrix document version`
1121
+
1122
+ ```text
1123
+ Usage: ciphrix document version [options] <document>
1124
+
1125
+ Create a new draft version of a document
1126
+
1127
+ Options:
1128
+ --change-type <type> change type
1129
+ --summary <text> change summary
1130
+ --yes apply without prompting
1131
+ --api-url <url> override the API base URL for this command
1132
+ --json output raw JSON
1133
+ -h, --help display help for command
1134
+ ```
1135
+
1136
+ **Effect:** Creates a new draft version; the CLI asks for confirmation when required.
1137
+
1138
+ ## `ciphrix document submit`
1139
+
1140
+ ```text
1141
+ Usage: ciphrix document submit [options] <document>
1142
+
1143
+ Submit a draft document for review
1144
+
1145
+ Options:
1146
+ --yes apply without prompting
1147
+ --api-url <url> override the API base URL for this command
1148
+ --json output raw JSON
1149
+ -h, --help display help for command
1150
+ ```
1151
+
1152
+ **Effect:** Submits a draft for review; the CLI asks for confirmation when required.
1153
+
1154
+ ## `ciphrix document approve`
1155
+
1156
+ ```text
1157
+ Usage: ciphrix document approve [options] <document>
1158
+
1159
+ Approve a document awaiting approval
1160
+
1161
+ Options:
1162
+ --yes apply without prompting
1163
+ --api-url <url> override the API base URL for this command
1164
+ --json output raw JSON
1165
+ -h, --help display help for command
1166
+ ```
1167
+
1168
+ **Effect:** Records a formal document approval; the CLI asks for confirmation when required.
1169
+
1170
+ ## `ciphrix document delete`
1171
+
1172
+ ```text
1173
+ Usage: ciphrix document delete [options] <document>
1174
+
1175
+ Delete a document
1176
+
1177
+ Options:
1178
+ --yes apply without prompting
1179
+ --api-url <url> override the API base URL for this command
1180
+ --json output raw JSON
1181
+ -h, --help display help for command
1182
+ ```
1183
+
1184
+ **Effect:** Deletes a document; the CLI asks for confirmation when required.
1185
+
1186
+ ## `ciphrix risk`
1187
+
1188
+ ```text
1189
+ Usage: ciphrix risk [options] [command]
1190
+
1191
+ Manage risks
1192
+
1193
+ Options:
1194
+ -h, --help display help for command
1195
+
1196
+ Commands:
1197
+ list [options] List the risk register
1198
+ get [options] <risk> Show one risk by title or id
1199
+ update [options] <risk> Update risk fields
1200
+ create [options] Create a risk
1201
+ delete [options] <risk> Delete a risk
1202
+ treatment [options] <risk> Show a risk’s treatment strategy and
1203
+ notes
1204
+ scores [options] <risk> Show a risk’s scores
1205
+ controls [options] <risk> List the controls linked to a risk
1206
+ link [options] <risk> Link a control to a risk, or unlink a
1207
+ mapping
1208
+ files [options] <risk> List the files attached to a risk
1209
+ attach [options] <risk> Attach a file to a risk
1210
+ detach [options] <risk> <mappingId> Detach a file from a risk by its mapping
1211
+ id
1212
+ help [command] display help for command
1213
+ ```
1214
+
1215
+ ## `ciphrix risk list`
1216
+
1217
+ ```text
1218
+ Usage: ciphrix risk list [options]
1219
+
1220
+ List the risk register
1221
+
1222
+ Options:
1223
+ --status <csv> filter by status
1224
+ --business-unit <value> filter by business unit
1225
+ --page <n> page number
1226
+ --limit <n> page size
1227
+ --api-url <url> override the API base URL for this command
1228
+ --json output raw JSON
1229
+ -h, --help display help for command
1230
+ ```
1231
+
1232
+ ## `ciphrix risk get`
1233
+
1234
+ ```text
1235
+ Usage: ciphrix risk get [options] <risk>
1236
+
1237
+ Show one risk by title or id
1238
+
1239
+ Options:
1240
+ --api-url <url> override the API base URL for this command
1241
+ --json output raw JSON
1242
+ -h, --help display help for command
1243
+ ```
1244
+
1245
+ ## `ciphrix risk update`
1246
+
1247
+ ```text
1248
+ Usage: ciphrix risk update [options] <risk>
1249
+
1250
+ Update risk fields
1251
+
1252
+ Options:
1253
+ --status <value> open | in_treatment | monitor | closed
1254
+ --title <value> title
1255
+ --description <value> description
1256
+ --owner <value> owner
1257
+ --treatment-type <value> treatment strategy
1258
+ --treatment-notes <text> treatment notes (Markdown)
1259
+ --business-unit <value> business unit
1260
+ --api-url <url> override the API base URL for this command
1261
+ --json output raw JSON
1262
+ -h, --help display help for command
1263
+ ```
1264
+
1265
+ **Effect:** Changes risk fields; the CLI prompts if the API requests confirmation.
1266
+
1267
+ ## `ciphrix risk create`
1268
+
1269
+ ```text
1270
+ Usage: ciphrix risk create [options]
1271
+
1272
+ Create a risk
1273
+
1274
+ Options:
1275
+ --title <title> risk title
1276
+ --category <value> category
1277
+ --description <value> description
1278
+ --api-url <url> override the API base URL for this command
1279
+ --json output raw JSON
1280
+ -h, --help display help for command
1281
+ ```
1282
+
1283
+ **Effect:** Creates a risk; the CLI prompts if the API requests confirmation.
1284
+
1285
+ ## `ciphrix risk delete`
1286
+
1287
+ ```text
1288
+ Usage: ciphrix risk delete [options] <risk>
1289
+
1290
+ Delete a risk
1291
+
1292
+ Options:
1293
+ --yes apply without prompting
1294
+ --api-url <url> override the API base URL for this command
1295
+ --json output raw JSON
1296
+ -h, --help display help for command
1297
+ ```
1298
+
1299
+ **Effect:** Deletes a risk; the CLI asks for confirmation when required.
1300
+
1301
+ ## `ciphrix risk treatment`
1302
+
1303
+ ```text
1304
+ Usage: ciphrix risk treatment [options] <risk>
1305
+
1306
+ Show a risk’s treatment strategy and notes
1307
+
1308
+ Options:
1309
+ --api-url <url> override the API base URL for this command
1310
+ --json output raw JSON
1311
+ -h, --help display help for command
1312
+ ```
1313
+
1314
+ ## `ciphrix risk scores`
1315
+
1316
+ ```text
1317
+ Usage: ciphrix risk scores [options] <risk>
1318
+
1319
+ Show a risk’s scores
1320
+
1321
+ Options:
1322
+ --api-url <url> override the API base URL for this command
1323
+ --json output raw JSON
1324
+ -h, --help display help for command
1325
+ ```
1326
+
1327
+ ## `ciphrix risk controls`
1328
+
1329
+ ```text
1330
+ Usage: ciphrix risk controls [options] <risk>
1331
+
1332
+ List the controls linked to a risk
1333
+
1334
+ Options:
1335
+ --api-url <url> override the API base URL for this command
1336
+ --json output raw JSON
1337
+ -h, --help display help for command
1338
+ ```
1339
+
1340
+ ## `ciphrix risk link`
1341
+
1342
+ ```text
1343
+ Usage: ciphrix risk link [options] <risk>
1344
+
1345
+ Link a control to a risk, or unlink a mapping
1346
+
1347
+ Options:
1348
+ --control <id> control instance id to link
1349
+ --unlink <mappingId> control mapping id to unlink
1350
+ --yes apply without prompting
1351
+ --api-url <url> override the API base URL for this command
1352
+ --json output raw JSON
1353
+ -h, --help display help for command
1354
+ ```
1355
+
1356
+ **Effect:** Links or unlinks a control to a risk; the CLI asks for confirmation when required.
1357
+
1358
+ ## `ciphrix risk files`
1359
+
1360
+ ```text
1361
+ Usage: ciphrix risk files [options] <risk>
1362
+
1363
+ List the files attached to a risk
1364
+
1365
+ Options:
1366
+ --api-url <url> override the API base URL for this command
1367
+ --json output raw JSON
1368
+ -h, --help display help for command
1369
+ ```
1370
+
1371
+ ## `ciphrix risk attach`
1372
+
1373
+ ```text
1374
+ Usage: ciphrix risk attach [options] <risk>
1375
+
1376
+ Attach a file to a risk
1377
+
1378
+ Options:
1379
+ --file <path> stage and attach a local file
1380
+ --upload <id> attach an already-staged upload
1381
+ --yes apply without prompting
1382
+ --api-url <url> override the API base URL for this command
1383
+ --json output raw JSON
1384
+ -h, --help display help for command
1385
+ ```
1386
+
1387
+ **Effect:** Attaches a staged or local file; the CLI asks for confirmation when required.
1388
+
1389
+ ## `ciphrix risk detach`
1390
+
1391
+ ```text
1392
+ Usage: ciphrix risk detach [options] <risk> <mappingId>
1393
+
1394
+ Detach a file from a risk by its mapping id
1395
+
1396
+ Options:
1397
+ --yes apply without prompting
1398
+ --api-url <url> override the API base URL for this command
1399
+ --json output raw JSON
1400
+ -h, --help display help for command
1401
+ ```
1402
+
1403
+ **Effect:** Detaches a file; the CLI asks for confirmation when required.
1404
+
1405
+ ## `ciphrix check`
1406
+
1407
+ ```text
1408
+ Usage: ciphrix check [options] [command]
1409
+
1410
+ Monitoring checks
1411
+
1412
+ Options:
1413
+ -h, --help display help for command
1414
+
1415
+ Commands:
1416
+ list [options] List monitoring checks
1417
+ resources [options] <check> List the resources covered by a check
1418
+ run [options] <check> Show a check’s latest run
1419
+ integrations [options] List check integration types
1420
+ runs [options] <check> List a check’s run history
1421
+ findings [options] <check> List the findings raised from a check
1422
+ enable [options] <check> Enable a check for this tenant
1423
+ disable [options] <check> Disable a check for this tenant
1424
+ help [command] display help for command
1425
+ ```
1426
+
1427
+ ## `ciphrix check list`
1428
+
1429
+ ```text
1430
+ Usage: ciphrix check list [options]
1431
+
1432
+ List monitoring checks
1433
+
1434
+ Options:
1435
+ --integration-type <csv> filter by integration type
1436
+ --status <csv> filter by status
1437
+ --page <n> page number
1438
+ --limit <n> page size
1439
+ --api-url <url> override the API base URL for this command
1440
+ --json output raw JSON
1441
+ -h, --help display help for command
1442
+ ```
1443
+
1444
+ ## `ciphrix check resources`
1445
+
1446
+ ```text
1447
+ Usage: ciphrix check resources [options] <check>
1448
+
1449
+ List the resources covered by a check
1450
+
1451
+ Options:
1452
+ --api-url <url> override the API base URL for this command
1453
+ --json output raw JSON
1454
+ -h, --help display help for command
1455
+ ```
1456
+
1457
+ ## `ciphrix check run`
1458
+
1459
+ ```text
1460
+ Usage: ciphrix check run [options] <check>
1461
+
1462
+ Show a check’s latest run
1463
+
1464
+ Options:
1465
+ --api-url <url> override the API base URL for this command
1466
+ --json output raw JSON
1467
+ -h, --help display help for command
1468
+ ```
1469
+
1470
+ **Effect:** Read-only: shows the latest run for a monitoring check.
1471
+
1472
+ ## `ciphrix check integrations`
1473
+
1474
+ ```text
1475
+ Usage: ciphrix check integrations [options]
1476
+
1477
+ List check integration types
1478
+
1479
+ Options:
1480
+ --api-url <url> override the API base URL for this command
1481
+ --json output raw JSON
1482
+ -h, --help display help for command
1483
+ ```
1484
+
1485
+ ## `ciphrix check runs`
1486
+
1487
+ ```text
1488
+ Usage: ciphrix check runs [options] <check>
1489
+
1490
+ List a check’s run history
1491
+
1492
+ Options:
1493
+ --page <n> page number
1494
+ --limit <n> page size
1495
+ --api-url <url> override the API base URL for this command
1496
+ --json output raw JSON
1497
+ -h, --help display help for command
1498
+ ```
1499
+
1500
+ ## `ciphrix check findings`
1501
+
1502
+ ```text
1503
+ Usage: ciphrix check findings [options] <check>
1504
+
1505
+ List the findings raised from a check
1506
+
1507
+ Options:
1508
+ --api-url <url> override the API base URL for this command
1509
+ --json output raw JSON
1510
+ -h, --help display help for command
1511
+ ```
1512
+
1513
+ ## `ciphrix check enable`
1514
+
1515
+ ```text
1516
+ Usage: ciphrix check enable [options] <check>
1517
+
1518
+ Enable a check for this tenant
1519
+
1520
+ Options:
1521
+ --notes <text> why
1522
+ --yes apply without prompting
1523
+ --api-url <url> override the API base URL for this command
1524
+ --json output raw JSON
1525
+ -h, --help display help for command
1526
+ ```
1527
+
1528
+ **Effect:** Enables a monitoring check for this tenant; the CLI asks for confirmation when required.
1529
+
1530
+ ## `ciphrix check disable`
1531
+
1532
+ ```text
1533
+ Usage: ciphrix check disable [options] <check>
1534
+
1535
+ Disable a check for this tenant
1536
+
1537
+ Options:
1538
+ --notes <text> why
1539
+ --yes apply without prompting
1540
+ --api-url <url> override the API base URL for this command
1541
+ --json output raw JSON
1542
+ -h, --help display help for command
1543
+ ```
1544
+
1545
+ **Effect:** Disables a monitoring check for this tenant; the CLI asks for confirmation when required.
1546
+
1547
+ ## `ciphrix job`
1548
+
1549
+ ```text
1550
+ Usage: ciphrix job [options] [command]
1551
+
1552
+ Check background jobs started by other commands
1553
+
1554
+ Options:
1555
+ -h, --help display help for command
1556
+
1557
+ Commands:
1558
+ status [options] <jobId> Show the status of a background job
1559
+ help [command] display help for command
1560
+ ```
1561
+
1562
+ ## `ciphrix job status`
1563
+
1564
+ ```text
1565
+ Usage: ciphrix job status [options] <jobId>
1566
+
1567
+ Show the status of a background job
1568
+
1569
+ Options:
1570
+ --api-url <url> override the API base URL for this command
1571
+ --json output raw JSON
1572
+ -h, --help display help for command
1573
+ ```
1574
+
1575
+ ## Behavioral defaults
1576
+
1577
+ - 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`.
1578
+ - Credentials use the operating system keychain by default. File-based credential storage requires the explicit `CIPHRIX_CREDENTIAL_STORE=file` opt-in.
1579
+ - Commands that accept `--page` or `--limit` use the server/API pagination defaults when omitted.
1580
+ - Commands whose help says they use the current run use that run when `--run` is omitted; `test run create` defaults its date to now.
1581
+
1582
+ ## Safe examples
1583
+
1584
+ ```sh
1585
+ ciphrix --help
1586
+ ciphrix login --api-url https://api.example.com
1587
+ ciphrix document get 'Example Policy'
1588
+ ciphrix test list --page 1 --limit 25
1589
+ ciphrix asset get '<asset-code>'
1590
+ ```
1591
+
1592
+ Examples use generic values. Replace placeholders with values from the authenticated tenant; never guess identifiers. Use `--yes` only after the user authorized that specific change. It bypasses an interactive confirmation prompt when one is requested; it does not grant access or override API authorization.