@knocklabs/cli 0.3.0 → 1.0.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/README.md +505 -162
  2. package/dist/commands/branch/create.js +0 -2
  3. package/dist/commands/branch/delete.js +4 -3
  4. package/dist/commands/branch/exit.js +0 -2
  5. package/dist/commands/branch/list.js +0 -2
  6. package/dist/commands/branch/merge.js +82 -0
  7. package/dist/commands/branch/switch.js +0 -2
  8. package/dist/commands/channel/list.js +73 -0
  9. package/dist/commands/environment/list.js +73 -0
  10. package/dist/commands/guide/new.js +276 -0
  11. package/dist/commands/guide/pull.js +5 -6
  12. package/dist/commands/guide/push.js +1 -1
  13. package/dist/commands/guide/validate.js +1 -1
  14. package/dist/commands/init.js +108 -0
  15. package/dist/commands/layout/new.js +228 -0
  16. package/dist/commands/layout/pull.js +5 -6
  17. package/dist/commands/layout/push.js +1 -1
  18. package/dist/commands/layout/validate.js +1 -1
  19. package/dist/commands/message-type/new.js +228 -0
  20. package/dist/commands/message-type/pull.js +5 -6
  21. package/dist/commands/message-type/push.js +1 -1
  22. package/dist/commands/message-type/validate.js +1 -1
  23. package/dist/commands/partial/new.js +274 -0
  24. package/dist/commands/partial/pull.js +5 -6
  25. package/dist/commands/partial/push.js +1 -1
  26. package/dist/commands/partial/validate.js +1 -1
  27. package/dist/commands/pull.js +7 -2
  28. package/dist/commands/push.js +6 -4
  29. package/dist/commands/translation/pull.js +1 -1
  30. package/dist/commands/translation/push.js +1 -1
  31. package/dist/commands/translation/validate.js +1 -1
  32. package/dist/commands/workflow/new.js +179 -54
  33. package/dist/commands/workflow/pull.js +6 -8
  34. package/dist/commands/workflow/push.js +1 -1
  35. package/dist/commands/workflow/validate.js +1 -1
  36. package/dist/lib/api-v1.js +23 -2
  37. package/dist/lib/auth.js +1 -1
  38. package/dist/lib/base-command.js +18 -15
  39. package/dist/lib/helpers/flag.js +0 -2
  40. package/dist/lib/helpers/project-config.js +158 -0
  41. package/dist/lib/helpers/request.js +1 -2
  42. package/dist/lib/helpers/string.js +4 -4
  43. package/dist/lib/helpers/typegen.js +1 -1
  44. package/dist/lib/marshal/email-layout/generator.js +152 -0
  45. package/dist/lib/marshal/email-layout/helpers.js +6 -9
  46. package/dist/lib/marshal/email-layout/index.js +1 -0
  47. package/dist/lib/marshal/email-layout/writer.js +15 -3
  48. package/dist/lib/marshal/guide/generator.js +163 -0
  49. package/dist/lib/marshal/guide/helpers.js +6 -10
  50. package/dist/lib/marshal/guide/index.js +1 -0
  51. package/dist/lib/marshal/guide/writer.js +5 -9
  52. package/dist/lib/marshal/message-type/generator.js +139 -0
  53. package/dist/lib/marshal/message-type/helpers.js +6 -10
  54. package/dist/lib/marshal/message-type/index.js +1 -0
  55. package/dist/lib/marshal/message-type/writer.js +5 -1
  56. package/dist/lib/marshal/partial/generator.js +159 -0
  57. package/dist/lib/marshal/partial/helpers.js +6 -10
  58. package/dist/lib/marshal/partial/index.js +1 -0
  59. package/dist/lib/marshal/partial/writer.js +3 -0
  60. package/dist/lib/marshal/translation/helpers.js +6 -10
  61. package/dist/lib/marshal/translation/processor.isomorphic.js +4 -4
  62. package/dist/lib/marshal/translation/writer.js +2 -2
  63. package/dist/lib/marshal/workflow/generator.js +175 -19
  64. package/dist/lib/marshal/workflow/helpers.js +7 -10
  65. package/dist/lib/run-context/loader.js +5 -0
  66. package/dist/lib/templates.js +131 -0
  67. package/oclif.manifest.json +826 -266
  68. package/package.json +14 -9
@@ -1,5 +1,44 @@
1
1
  {
2
2
  "commands": {
3
+ "init": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "description": "Creates a knock.json configuration file in the current directory to store project-level settings like the knock resources directory.",
7
+ "flags": {
8
+ "service-token": {
9
+ "env": "KNOCK_SERVICE_TOKEN",
10
+ "name": "service-token",
11
+ "required": false,
12
+ "summary": "The service token to authenticate with.",
13
+ "hasDynamicHelp": false,
14
+ "multiple": false,
15
+ "type": "option"
16
+ },
17
+ "api-origin": {
18
+ "hidden": true,
19
+ "name": "api-origin",
20
+ "required": false,
21
+ "hasDynamicHelp": false,
22
+ "multiple": false,
23
+ "type": "option"
24
+ }
25
+ },
26
+ "hasDynamicHelp": false,
27
+ "hiddenAliases": [],
28
+ "id": "init",
29
+ "pluginAlias": "@knocklabs/cli",
30
+ "pluginName": "@knocklabs/cli",
31
+ "pluginType": "core",
32
+ "strict": true,
33
+ "summary": "Initialize a new Knock project with a knock.json configuration file.",
34
+ "enableJsonFlag": false,
35
+ "isESM": false,
36
+ "relativePath": [
37
+ "dist",
38
+ "commands",
39
+ "init.js"
40
+ ]
41
+ },
3
42
  "knock": {
4
43
  "aliases": [],
5
44
  "args": {},
@@ -144,7 +183,6 @@
144
183
  "type": "option"
145
184
  },
146
185
  "branch": {
147
- "hidden": true,
148
186
  "name": "branch",
149
187
  "summary": "The slug of the branch to use.",
150
188
  "hasDynamicHelp": false,
@@ -153,7 +191,7 @@
153
191
  },
154
192
  "knock-dir": {
155
193
  "name": "knock-dir",
156
- "required": true,
194
+ "required": false,
157
195
  "summary": "The target directory path to pull all resources into.",
158
196
  "hasDynamicHelp": false,
159
197
  "multiple": false,
@@ -221,7 +259,6 @@
221
259
  "type": "option"
222
260
  },
223
261
  "branch": {
224
- "hidden": true,
225
262
  "name": "branch",
226
263
  "summary": "The slug of the branch to use.",
227
264
  "hasDynamicHelp": false,
@@ -230,7 +267,7 @@
230
267
  },
231
268
  "knock-dir": {
232
269
  "name": "knock-dir",
233
- "required": true,
270
+ "required": false,
234
271
  "summary": "The target directory path to find all resources to push.",
235
272
  "hasDynamicHelp": false,
236
273
  "multiple": false,
@@ -351,7 +388,6 @@
351
388
  }
352
389
  },
353
390
  "hasDynamicHelp": false,
354
- "hidden": true,
355
391
  "hiddenAliases": [],
356
392
  "id": "branch:create",
357
393
  "pluginAlias": "@knocklabs/cli",
@@ -403,7 +439,6 @@
403
439
  }
404
440
  },
405
441
  "hasDynamicHelp": false,
406
- "hidden": true,
407
442
  "hiddenAliases": [],
408
443
  "id": "branch:delete",
409
444
  "pluginAlias": "@knocklabs/cli",
@@ -443,7 +478,6 @@
443
478
  }
444
479
  },
445
480
  "hasDynamicHelp": false,
446
- "hidden": true,
447
481
  "hiddenAliases": [],
448
482
  "id": "branch:exit",
449
483
  "pluginAlias": "@knocklabs/cli",
@@ -511,7 +545,6 @@
511
545
  }
512
546
  },
513
547
  "hasDynamicHelp": false,
514
- "hidden": true,
515
548
  "hiddenAliases": [],
516
549
  "id": "branch:list",
517
550
  "pluginAlias": "@knocklabs/cli",
@@ -528,6 +561,63 @@
528
561
  "list.js"
529
562
  ]
530
563
  },
564
+ "branch:merge": {
565
+ "aliases": [],
566
+ "args": {
567
+ "slug": {
568
+ "description": "The slug of the branch to merge",
569
+ "name": "slug",
570
+ "required": true
571
+ }
572
+ },
573
+ "flags": {
574
+ "service-token": {
575
+ "env": "KNOCK_SERVICE_TOKEN",
576
+ "name": "service-token",
577
+ "required": false,
578
+ "summary": "The service token to authenticate with.",
579
+ "hasDynamicHelp": false,
580
+ "multiple": false,
581
+ "type": "option"
582
+ },
583
+ "api-origin": {
584
+ "hidden": true,
585
+ "name": "api-origin",
586
+ "required": false,
587
+ "hasDynamicHelp": false,
588
+ "multiple": false,
589
+ "type": "option"
590
+ },
591
+ "force": {
592
+ "name": "force",
593
+ "summary": "Remove the confirmation prompt.",
594
+ "allowNo": false,
595
+ "type": "boolean"
596
+ },
597
+ "delete": {
598
+ "name": "delete",
599
+ "summary": "Delete the branch after merging.",
600
+ "allowNo": true,
601
+ "type": "boolean"
602
+ }
603
+ },
604
+ "hasDynamicHelp": false,
605
+ "hiddenAliases": [],
606
+ "id": "branch:merge",
607
+ "pluginAlias": "@knocklabs/cli",
608
+ "pluginName": "@knocklabs/cli",
609
+ "pluginType": "core",
610
+ "strict": true,
611
+ "summary": "Merges a branch into the development environment.",
612
+ "enableJsonFlag": false,
613
+ "isESM": false,
614
+ "relativePath": [
615
+ "dist",
616
+ "commands",
617
+ "branch",
618
+ "merge.js"
619
+ ]
620
+ },
531
621
  "branch:switch": {
532
622
  "aliases": [],
533
623
  "args": {
@@ -569,7 +659,6 @@
569
659
  }
570
660
  },
571
661
  "hasDynamicHelp": false,
572
- "hidden": true,
573
662
  "hiddenAliases": [],
574
663
  "id": "branch:switch",
575
664
  "pluginAlias": "@knocklabs/cli",
@@ -586,6 +675,52 @@
586
675
  "switch.js"
587
676
  ]
588
677
  },
678
+ "channel:list": {
679
+ "aliases": [],
680
+ "args": {},
681
+ "flags": {
682
+ "json": {
683
+ "description": "Format output as json.",
684
+ "helpGroup": "GLOBAL",
685
+ "name": "json",
686
+ "allowNo": false,
687
+ "type": "boolean"
688
+ },
689
+ "service-token": {
690
+ "env": "KNOCK_SERVICE_TOKEN",
691
+ "name": "service-token",
692
+ "required": false,
693
+ "summary": "The service token to authenticate with.",
694
+ "hasDynamicHelp": false,
695
+ "multiple": false,
696
+ "type": "option"
697
+ },
698
+ "api-origin": {
699
+ "hidden": true,
700
+ "name": "api-origin",
701
+ "required": false,
702
+ "hasDynamicHelp": false,
703
+ "multiple": false,
704
+ "type": "option"
705
+ }
706
+ },
707
+ "hasDynamicHelp": false,
708
+ "hiddenAliases": [],
709
+ "id": "channel:list",
710
+ "pluginAlias": "@knocklabs/cli",
711
+ "pluginName": "@knocklabs/cli",
712
+ "pluginType": "core",
713
+ "strict": true,
714
+ "summary": "Display all channels configured for the account.",
715
+ "enableJsonFlag": true,
716
+ "isESM": false,
717
+ "relativePath": [
718
+ "dist",
719
+ "commands",
720
+ "channel",
721
+ "list.js"
722
+ ]
723
+ },
589
724
  "commit:get": {
590
725
  "aliases": [],
591
726
  "args": {
@@ -670,7 +805,6 @@
670
805
  "type": "option"
671
806
  },
672
807
  "branch": {
673
- "hidden": true,
674
808
  "name": "branch",
675
809
  "summary": "The slug of the branch to use.",
676
810
  "hasDynamicHelp": false,
@@ -746,7 +880,6 @@
746
880
  "type": "option"
747
881
  },
748
882
  "branch": {
749
- "hidden": true,
750
883
  "name": "branch",
751
884
  "summary": "The slug of the branch to use.",
752
885
  "hasDynamicHelp": false,
@@ -879,6 +1012,52 @@
879
1012
  "promote.js"
880
1013
  ]
881
1014
  },
1015
+ "environment:list": {
1016
+ "aliases": [],
1017
+ "args": {},
1018
+ "flags": {
1019
+ "json": {
1020
+ "description": "Format output as json.",
1021
+ "helpGroup": "GLOBAL",
1022
+ "name": "json",
1023
+ "allowNo": false,
1024
+ "type": "boolean"
1025
+ },
1026
+ "service-token": {
1027
+ "env": "KNOCK_SERVICE_TOKEN",
1028
+ "name": "service-token",
1029
+ "required": false,
1030
+ "summary": "The service token to authenticate with.",
1031
+ "hasDynamicHelp": false,
1032
+ "multiple": false,
1033
+ "type": "option"
1034
+ },
1035
+ "api-origin": {
1036
+ "hidden": true,
1037
+ "name": "api-origin",
1038
+ "required": false,
1039
+ "hasDynamicHelp": false,
1040
+ "multiple": false,
1041
+ "type": "option"
1042
+ }
1043
+ },
1044
+ "hasDynamicHelp": false,
1045
+ "hiddenAliases": [],
1046
+ "id": "environment:list",
1047
+ "pluginAlias": "@knocklabs/cli",
1048
+ "pluginName": "@knocklabs/cli",
1049
+ "pluginType": "core",
1050
+ "strict": true,
1051
+ "summary": "Display all environments configured for the account.",
1052
+ "enableJsonFlag": true,
1053
+ "isESM": false,
1054
+ "relativePath": [
1055
+ "dist",
1056
+ "commands",
1057
+ "environment",
1058
+ "list.js"
1059
+ ]
1060
+ },
882
1061
  "guide:activate": {
883
1062
  "aliases": [],
884
1063
  "args": {
@@ -915,7 +1094,6 @@
915
1094
  "type": "option"
916
1095
  },
917
1096
  "branch": {
918
- "hidden": true,
919
1097
  "name": "branch",
920
1098
  "summary": "The slug of the branch to use.",
921
1099
  "hasDynamicHelp": false,
@@ -1012,7 +1190,6 @@
1012
1190
  "type": "option"
1013
1191
  },
1014
1192
  "branch": {
1015
- "hidden": true,
1016
1193
  "name": "branch",
1017
1194
  "summary": "The slug of the branch to use.",
1018
1195
  "hasDynamicHelp": false,
@@ -1086,7 +1263,6 @@
1086
1263
  "type": "option"
1087
1264
  },
1088
1265
  "branch": {
1089
- "hidden": true,
1090
1266
  "name": "branch",
1091
1267
  "summary": "The slug of the branch to use.",
1092
1268
  "hasDynamicHelp": false,
@@ -1154,7 +1330,6 @@
1154
1330
  "type": "option"
1155
1331
  },
1156
1332
  "branch": {
1157
- "hidden": true,
1158
1333
  "name": "branch",
1159
1334
  "summary": "The slug of the branch to use.",
1160
1335
  "hasDynamicHelp": false,
@@ -1206,14 +1381,9 @@
1206
1381
  "list.js"
1207
1382
  ]
1208
1383
  },
1209
- "guide:pull": {
1384
+ "guide:new": {
1210
1385
  "aliases": [],
1211
- "args": {
1212
- "guideKey": {
1213
- "name": "guideKey",
1214
- "required": false
1215
- }
1216
- },
1386
+ "args": {},
1217
1387
  "flags": {
1218
1388
  "service-token": {
1219
1389
  "env": "KNOCK_SERVICE_TOKEN",
@@ -1232,69 +1402,85 @@
1232
1402
  "multiple": false,
1233
1403
  "type": "option"
1234
1404
  },
1405
+ "name": {
1406
+ "char": "n",
1407
+ "name": "name",
1408
+ "summary": "The name of the guide",
1409
+ "hasDynamicHelp": false,
1410
+ "multiple": false,
1411
+ "type": "option"
1412
+ },
1413
+ "key": {
1414
+ "char": "k",
1415
+ "name": "key",
1416
+ "summary": "The key of the guide",
1417
+ "hasDynamicHelp": false,
1418
+ "multiple": false,
1419
+ "type": "option"
1420
+ },
1421
+ "message-type": {
1422
+ "char": "m",
1423
+ "name": "message-type",
1424
+ "summary": "The message type key to use for the guide. You cannot use this flag with --template.",
1425
+ "hasDynamicHelp": false,
1426
+ "multiple": false,
1427
+ "type": "option"
1428
+ },
1235
1429
  "environment": {
1236
1430
  "name": "environment",
1237
- "summary": "The environment to use.",
1431
+ "summary": "The environment to create the guide in. Defaults to development.",
1238
1432
  "default": "development",
1239
1433
  "hasDynamicHelp": false,
1240
1434
  "multiple": false,
1241
1435
  "type": "option"
1242
1436
  },
1243
1437
  "branch": {
1244
- "hidden": true,
1245
1438
  "name": "branch",
1246
1439
  "summary": "The slug of the branch to use.",
1247
1440
  "hasDynamicHelp": false,
1248
1441
  "multiple": false,
1249
1442
  "type": "option"
1250
1443
  },
1251
- "all": {
1252
- "name": "all",
1253
- "summary": "Whether to pull all guides from the specified environment.",
1444
+ "force": {
1445
+ "name": "force",
1446
+ "summary": "Force the creation of the guide directory without confirmation.",
1254
1447
  "allowNo": false,
1255
1448
  "type": "boolean"
1256
1449
  },
1257
- "guides-dir": {
1258
- "dependsOn": [
1259
- "all"
1260
- ],
1261
- "name": "guides-dir",
1262
- "summary": "The target directory path to pull all guides into.",
1263
- "hasDynamicHelp": false,
1264
- "multiple": false,
1265
- "type": "option"
1266
- },
1267
- "hide-uncommitted-changes": {
1268
- "name": "hide-uncommitted-changes",
1269
- "summary": "Hide any uncommitted changes.",
1450
+ "push": {
1451
+ "char": "p",
1452
+ "name": "push",
1453
+ "summary": "Whether or not to push the guide to Knock after creation.",
1270
1454
  "allowNo": false,
1271
1455
  "type": "boolean"
1272
1456
  },
1273
- "force": {
1274
- "name": "force",
1275
- "summary": "Remove the confirmation prompt.",
1276
- "allowNo": false,
1277
- "type": "boolean"
1457
+ "template": {
1458
+ "char": "t",
1459
+ "name": "template",
1460
+ "summary": "The template to use for the guide. Should be `guides/{key}`. You cannot use this flag with --message-type.",
1461
+ "hasDynamicHelp": false,
1462
+ "multiple": false,
1463
+ "type": "option"
1278
1464
  }
1279
1465
  },
1280
1466
  "hasDynamicHelp": false,
1281
1467
  "hiddenAliases": [],
1282
- "id": "guide:pull",
1468
+ "id": "guide:new",
1283
1469
  "pluginAlias": "@knocklabs/cli",
1284
1470
  "pluginName": "@knocklabs/cli",
1285
1471
  "pluginType": "core",
1286
1472
  "strict": true,
1287
- "summary": "Pull one or more guides from an environment into a local file system.",
1473
+ "summary": "Create a new guide with a minimal configuration.",
1288
1474
  "enableJsonFlag": false,
1289
1475
  "isESM": false,
1290
1476
  "relativePath": [
1291
1477
  "dist",
1292
1478
  "commands",
1293
1479
  "guide",
1294
- "pull.js"
1480
+ "new.js"
1295
1481
  ]
1296
1482
  },
1297
- "guide:push": {
1483
+ "guide:pull": {
1298
1484
  "aliases": [],
1299
1485
  "args": {
1300
1486
  "guideKey": {
@@ -1322,14 +1508,13 @@
1322
1508
  },
1323
1509
  "environment": {
1324
1510
  "name": "environment",
1325
- "summary": "The environment to push the guide to. Defaults to development.",
1511
+ "summary": "The environment to use.",
1326
1512
  "default": "development",
1327
1513
  "hasDynamicHelp": false,
1328
1514
  "multiple": false,
1329
1515
  "type": "option"
1330
1516
  },
1331
1517
  "branch": {
1332
- "hidden": true,
1333
1518
  "name": "branch",
1334
1519
  "summary": "The slug of the branch to use.",
1335
1520
  "hasDynamicHelp": false,
@@ -1338,7 +1523,7 @@
1338
1523
  },
1339
1524
  "all": {
1340
1525
  "name": "all",
1341
- "summary": "Whether to push all guides from the target directory.",
1526
+ "summary": "Whether to pull all guides from the specified environment.",
1342
1527
  "allowNo": false,
1343
1528
  "type": "boolean"
1344
1529
  },
@@ -1347,21 +1532,108 @@
1347
1532
  "all"
1348
1533
  ],
1349
1534
  "name": "guides-dir",
1350
- "summary": "The target directory path to find all guides to push.",
1535
+ "summary": "The target directory path to pull all guides into.",
1351
1536
  "hasDynamicHelp": false,
1352
1537
  "multiple": false,
1353
1538
  "type": "option"
1354
1539
  },
1355
- "commit": {
1356
- "name": "commit",
1357
- "summary": "Push and commit the guide(s) at the same time",
1540
+ "hide-uncommitted-changes": {
1541
+ "name": "hide-uncommitted-changes",
1542
+ "summary": "Hide any uncommitted changes.",
1358
1543
  "allowNo": false,
1359
1544
  "type": "boolean"
1360
1545
  },
1361
- "commit-message": {
1362
- "char": "m",
1363
- "dependsOn": [
1364
- "commit"
1546
+ "force": {
1547
+ "name": "force",
1548
+ "summary": "Remove the confirmation prompt.",
1549
+ "allowNo": false,
1550
+ "type": "boolean"
1551
+ }
1552
+ },
1553
+ "hasDynamicHelp": false,
1554
+ "hiddenAliases": [],
1555
+ "id": "guide:pull",
1556
+ "pluginAlias": "@knocklabs/cli",
1557
+ "pluginName": "@knocklabs/cli",
1558
+ "pluginType": "core",
1559
+ "strict": true,
1560
+ "summary": "Pull one or more guides from an environment into a local file system.",
1561
+ "enableJsonFlag": false,
1562
+ "isESM": false,
1563
+ "relativePath": [
1564
+ "dist",
1565
+ "commands",
1566
+ "guide",
1567
+ "pull.js"
1568
+ ]
1569
+ },
1570
+ "guide:push": {
1571
+ "aliases": [],
1572
+ "args": {
1573
+ "guideKey": {
1574
+ "name": "guideKey",
1575
+ "required": false
1576
+ }
1577
+ },
1578
+ "flags": {
1579
+ "service-token": {
1580
+ "env": "KNOCK_SERVICE_TOKEN",
1581
+ "name": "service-token",
1582
+ "required": false,
1583
+ "summary": "The service token to authenticate with.",
1584
+ "hasDynamicHelp": false,
1585
+ "multiple": false,
1586
+ "type": "option"
1587
+ },
1588
+ "api-origin": {
1589
+ "hidden": true,
1590
+ "name": "api-origin",
1591
+ "required": false,
1592
+ "hasDynamicHelp": false,
1593
+ "multiple": false,
1594
+ "type": "option"
1595
+ },
1596
+ "environment": {
1597
+ "name": "environment",
1598
+ "summary": "The environment to push the guide to. Defaults to development.",
1599
+ "default": "development",
1600
+ "hasDynamicHelp": false,
1601
+ "multiple": false,
1602
+ "type": "option"
1603
+ },
1604
+ "branch": {
1605
+ "name": "branch",
1606
+ "summary": "The slug of the branch to use.",
1607
+ "hasDynamicHelp": false,
1608
+ "multiple": false,
1609
+ "type": "option"
1610
+ },
1611
+ "all": {
1612
+ "name": "all",
1613
+ "summary": "Whether to push all guides from the target directory.",
1614
+ "allowNo": false,
1615
+ "type": "boolean"
1616
+ },
1617
+ "guides-dir": {
1618
+ "dependsOn": [
1619
+ "all"
1620
+ ],
1621
+ "name": "guides-dir",
1622
+ "summary": "The target directory path to find all guides to push.",
1623
+ "hasDynamicHelp": false,
1624
+ "multiple": false,
1625
+ "type": "option"
1626
+ },
1627
+ "commit": {
1628
+ "name": "commit",
1629
+ "summary": "Push and commit the guide(s) at the same time",
1630
+ "allowNo": false,
1631
+ "type": "boolean"
1632
+ },
1633
+ "commit-message": {
1634
+ "char": "m",
1635
+ "dependsOn": [
1636
+ "commit"
1365
1637
  ],
1366
1638
  "name": "commit-message",
1367
1639
  "summary": "Use the given value as the commit message",
@@ -1422,7 +1694,6 @@
1422
1694
  "type": "option"
1423
1695
  },
1424
1696
  "branch": {
1425
- "hidden": true,
1426
1697
  "name": "branch",
1427
1698
  "summary": "The slug of the branch to use.",
1428
1699
  "hasDynamicHelp": false,
@@ -1505,7 +1776,6 @@
1505
1776
  "type": "option"
1506
1777
  },
1507
1778
  "branch": {
1508
- "hidden": true,
1509
1779
  "name": "branch",
1510
1780
  "summary": "The slug of the branch to use.",
1511
1781
  "hasDynamicHelp": false,
@@ -1573,7 +1843,6 @@
1573
1843
  "type": "option"
1574
1844
  },
1575
1845
  "branch": {
1576
- "hidden": true,
1577
1846
  "name": "branch",
1578
1847
  "summary": "The slug of the branch to use.",
1579
1848
  "hasDynamicHelp": false,
@@ -1625,6 +1894,96 @@
1625
1894
  "list.js"
1626
1895
  ]
1627
1896
  },
1897
+ "layout:new": {
1898
+ "aliases": [],
1899
+ "args": {},
1900
+ "flags": {
1901
+ "service-token": {
1902
+ "env": "KNOCK_SERVICE_TOKEN",
1903
+ "name": "service-token",
1904
+ "required": false,
1905
+ "summary": "The service token to authenticate with.",
1906
+ "hasDynamicHelp": false,
1907
+ "multiple": false,
1908
+ "type": "option"
1909
+ },
1910
+ "api-origin": {
1911
+ "hidden": true,
1912
+ "name": "api-origin",
1913
+ "required": false,
1914
+ "hasDynamicHelp": false,
1915
+ "multiple": false,
1916
+ "type": "option"
1917
+ },
1918
+ "name": {
1919
+ "char": "n",
1920
+ "name": "name",
1921
+ "summary": "The name of the email layout",
1922
+ "hasDynamicHelp": false,
1923
+ "multiple": false,
1924
+ "type": "option"
1925
+ },
1926
+ "key": {
1927
+ "char": "k",
1928
+ "name": "key",
1929
+ "summary": "The key of the email layout",
1930
+ "hasDynamicHelp": false,
1931
+ "multiple": false,
1932
+ "type": "option"
1933
+ },
1934
+ "environment": {
1935
+ "name": "environment",
1936
+ "summary": "The environment to create the email layout in. Defaults to development.",
1937
+ "default": "development",
1938
+ "hasDynamicHelp": false,
1939
+ "multiple": false,
1940
+ "type": "option"
1941
+ },
1942
+ "branch": {
1943
+ "name": "branch",
1944
+ "summary": "The slug of the branch to use.",
1945
+ "hasDynamicHelp": false,
1946
+ "multiple": false,
1947
+ "type": "option"
1948
+ },
1949
+ "force": {
1950
+ "name": "force",
1951
+ "summary": "Force the creation of the email layout directory without confirmation.",
1952
+ "allowNo": false,
1953
+ "type": "boolean"
1954
+ },
1955
+ "push": {
1956
+ "char": "p",
1957
+ "name": "push",
1958
+ "summary": "Whether or not to push the email layout to Knock after creation.",
1959
+ "allowNo": false,
1960
+ "type": "boolean"
1961
+ },
1962
+ "template": {
1963
+ "name": "template",
1964
+ "summary": "The template to use for the email layout. Should be `email-layouts/{key}`.",
1965
+ "hasDynamicHelp": false,
1966
+ "multiple": false,
1967
+ "type": "option"
1968
+ }
1969
+ },
1970
+ "hasDynamicHelp": false,
1971
+ "hiddenAliases": [],
1972
+ "id": "layout:new",
1973
+ "pluginAlias": "@knocklabs/cli",
1974
+ "pluginName": "@knocklabs/cli",
1975
+ "pluginType": "core",
1976
+ "strict": true,
1977
+ "summary": "Create a new email layout with a minimal configuration.",
1978
+ "enableJsonFlag": false,
1979
+ "isESM": false,
1980
+ "relativePath": [
1981
+ "dist",
1982
+ "commands",
1983
+ "layout",
1984
+ "new.js"
1985
+ ]
1986
+ },
1628
1987
  "layout:pull": {
1629
1988
  "aliases": [],
1630
1989
  "args": {
@@ -1660,7 +2019,6 @@
1660
2019
  "type": "option"
1661
2020
  },
1662
2021
  "branch": {
1663
- "hidden": true,
1664
2022
  "name": "branch",
1665
2023
  "summary": "The slug of the branch to use.",
1666
2024
  "hasDynamicHelp": false,
@@ -1754,7 +2112,6 @@
1754
2112
  "type": "option"
1755
2113
  },
1756
2114
  "branch": {
1757
- "hidden": true,
1758
2115
  "name": "branch",
1759
2116
  "summary": "The slug of the branch to use.",
1760
2117
  "hasDynamicHelp": false,
@@ -1853,7 +2210,6 @@
1853
2210
  "type": "option"
1854
2211
  },
1855
2212
  "branch": {
1856
- "hidden": true,
1857
2213
  "name": "branch",
1858
2214
  "summary": "The slug of the branch to use.",
1859
2215
  "hasDynamicHelp": false,
@@ -1897,11 +2253,11 @@
1897
2253
  "validate.js"
1898
2254
  ]
1899
2255
  },
1900
- "message-type:get": {
2256
+ "partial:get": {
1901
2257
  "aliases": [],
1902
2258
  "args": {
1903
- "messageTypeKey": {
1904
- "name": "messageTypeKey",
2259
+ "partialKey": {
2260
+ "name": "partialKey",
1905
2261
  "required": true
1906
2262
  }
1907
2263
  },
@@ -1939,7 +2295,6 @@
1939
2295
  "type": "option"
1940
2296
  },
1941
2297
  "branch": {
1942
- "hidden": true,
1943
2298
  "name": "branch",
1944
2299
  "summary": "The slug of the branch to use.",
1945
2300
  "hasDynamicHelp": false,
@@ -1955,22 +2310,22 @@
1955
2310
  },
1956
2311
  "hasDynamicHelp": false,
1957
2312
  "hiddenAliases": [],
1958
- "id": "message-type:get",
2313
+ "id": "partial:get",
1959
2314
  "pluginAlias": "@knocklabs/cli",
1960
2315
  "pluginName": "@knocklabs/cli",
1961
2316
  "pluginType": "core",
1962
2317
  "strict": true,
1963
- "summary": "Display a single in-app message type from an environment.",
2318
+ "summary": "Display a single partial from an environment.",
1964
2319
  "enableJsonFlag": true,
1965
2320
  "isESM": false,
1966
2321
  "relativePath": [
1967
2322
  "dist",
1968
2323
  "commands",
1969
- "message-type",
2324
+ "partial",
1970
2325
  "get.js"
1971
2326
  ]
1972
2327
  },
1973
- "message-type:list": {
2328
+ "partial:list": {
1974
2329
  "aliases": [],
1975
2330
  "args": {},
1976
2331
  "flags": {
@@ -2007,7 +2362,6 @@
2007
2362
  "type": "option"
2008
2363
  },
2009
2364
  "branch": {
2010
- "hidden": true,
2011
2365
  "name": "branch",
2012
2366
  "summary": "The slug of the branch to use.",
2013
2367
  "hasDynamicHelp": false,
@@ -2044,26 +2398,130 @@
2044
2398
  },
2045
2399
  "hasDynamicHelp": false,
2046
2400
  "hiddenAliases": [],
2047
- "id": "message-type:list",
2401
+ "id": "partial:list",
2048
2402
  "pluginAlias": "@knocklabs/cli",
2049
2403
  "pluginName": "@knocklabs/cli",
2050
2404
  "pluginType": "core",
2051
2405
  "strict": true,
2052
- "summary": "Display all in-app message types for an environment.",
2406
+ "summary": "Display all partials for an environment.",
2053
2407
  "enableJsonFlag": true,
2054
2408
  "isESM": false,
2055
2409
  "relativePath": [
2056
2410
  "dist",
2057
2411
  "commands",
2058
- "message-type",
2412
+ "partial",
2059
2413
  "list.js"
2060
2414
  ]
2061
2415
  },
2062
- "message-type:pull": {
2416
+ "partial:new": {
2417
+ "aliases": [],
2418
+ "args": {},
2419
+ "flags": {
2420
+ "service-token": {
2421
+ "env": "KNOCK_SERVICE_TOKEN",
2422
+ "name": "service-token",
2423
+ "required": false,
2424
+ "summary": "The service token to authenticate with.",
2425
+ "hasDynamicHelp": false,
2426
+ "multiple": false,
2427
+ "type": "option"
2428
+ },
2429
+ "api-origin": {
2430
+ "hidden": true,
2431
+ "name": "api-origin",
2432
+ "required": false,
2433
+ "hasDynamicHelp": false,
2434
+ "multiple": false,
2435
+ "type": "option"
2436
+ },
2437
+ "name": {
2438
+ "char": "n",
2439
+ "name": "name",
2440
+ "summary": "The name of the partial",
2441
+ "hasDynamicHelp": false,
2442
+ "multiple": false,
2443
+ "type": "option"
2444
+ },
2445
+ "key": {
2446
+ "char": "k",
2447
+ "name": "key",
2448
+ "summary": "The key of the partial",
2449
+ "hasDynamicHelp": false,
2450
+ "multiple": false,
2451
+ "type": "option"
2452
+ },
2453
+ "type": {
2454
+ "char": "t",
2455
+ "name": "type",
2456
+ "summary": "The type of the partial (html, json, markdown, text). You cannot use this flag with --template.",
2457
+ "hasDynamicHelp": false,
2458
+ "multiple": false,
2459
+ "options": [
2460
+ "html",
2461
+ "json",
2462
+ "markdown",
2463
+ "text"
2464
+ ],
2465
+ "type": "option"
2466
+ },
2467
+ "environment": {
2468
+ "name": "environment",
2469
+ "summary": "The environment to create the partial in. Defaults to development.",
2470
+ "default": "development",
2471
+ "hasDynamicHelp": false,
2472
+ "multiple": false,
2473
+ "type": "option"
2474
+ },
2475
+ "branch": {
2476
+ "name": "branch",
2477
+ "summary": "The slug of the branch to use.",
2478
+ "hasDynamicHelp": false,
2479
+ "multiple": false,
2480
+ "type": "option"
2481
+ },
2482
+ "force": {
2483
+ "name": "force",
2484
+ "summary": "Force the creation of the partial directory without confirmation.",
2485
+ "allowNo": false,
2486
+ "type": "boolean"
2487
+ },
2488
+ "push": {
2489
+ "char": "p",
2490
+ "name": "push",
2491
+ "summary": "Whether or not to push the partial to Knock after creation.",
2492
+ "allowNo": false,
2493
+ "type": "boolean"
2494
+ },
2495
+ "template": {
2496
+ "name": "template",
2497
+ "summary": "The template to use for the partial. Should be `partials/{key}`. You cannot use this flag with --type.",
2498
+ "hasDynamicHelp": false,
2499
+ "multiple": false,
2500
+ "type": "option"
2501
+ }
2502
+ },
2503
+ "hasDynamicHelp": false,
2504
+ "hiddenAliases": [],
2505
+ "id": "partial:new",
2506
+ "pluginAlias": "@knocklabs/cli",
2507
+ "pluginName": "@knocklabs/cli",
2508
+ "pluginType": "core",
2509
+ "strict": true,
2510
+ "summary": "Create a new partial with a minimal configuration.",
2511
+ "enableJsonFlag": false,
2512
+ "isESM": false,
2513
+ "relativePath": [
2514
+ "dist",
2515
+ "commands",
2516
+ "partial",
2517
+ "new.js"
2518
+ ]
2519
+ },
2520
+ "partial:pull": {
2063
2521
  "aliases": [],
2064
2522
  "args": {
2065
- "messageTypeKey": {
2066
- "name": "messageTypeKey",
2523
+ "partialKey": {
2524
+ "name": "partialKey",
2067
2525
  "required": false
2068
2526
  }
2069
2527
  },
@@ -2094,7 +2552,6 @@
2094
2552
  "type": "option"
2095
2553
  },
2096
2554
  "branch": {
2097
- "hidden": true,
2098
2555
  "name": "branch",
2099
2556
  "summary": "The slug of the branch to use.",
2100
2557
  "hasDynamicHelp": false,
@@ -2103,16 +2560,16 @@
2103
2560
  },
2104
2561
  "all": {
2105
2562
  "name": "all",
2106
- "summary": "Whether to pull all in-app message types from the specified environment.",
2563
+ "summary": "Whether to pull all partials from the specified environment.",
2107
2564
  "allowNo": false,
2108
2565
  "type": "boolean"
2109
2566
  },
2110
- "message-types-dir": {
2567
+ "partials-dir": {
2111
2568
  "dependsOn": [
2112
2569
  "all"
2113
2570
  ],
2114
- "name": "message-types-dir",
2115
- "summary": "The target directory path to pull all in-app message types into.",
2571
+ "name": "partials-dir",
2572
+ "summary": "The target directory path to pull all partials into.",
2116
2573
  "hasDynamicHelp": false,
2117
2574
  "multiple": false,
2118
2575
  "type": "option"
@@ -2132,26 +2589,26 @@
2132
2589
  },
2133
2590
  "hasDynamicHelp": false,
2134
2591
  "hiddenAliases": [],
2135
- "id": "message-type:pull",
2592
+ "id": "partial:pull",
2136
2593
  "pluginAlias": "@knocklabs/cli",
2137
2594
  "pluginName": "@knocklabs/cli",
2138
2595
  "pluginType": "core",
2139
2596
  "strict": true,
2140
- "summary": "Pull one or more in-app message types from an environment into a local file system.",
2597
+ "summary": "Pull one or more partial from an environment into a local file system.",
2141
2598
  "enableJsonFlag": false,
2142
2599
  "isESM": false,
2143
2600
  "relativePath": [
2144
2601
  "dist",
2145
2602
  "commands",
2146
- "message-type",
2603
+ "partial",
2147
2604
  "pull.js"
2148
2605
  ]
2149
2606
  },
2150
- "message-type:push": {
2607
+ "partial:push": {
2151
2608
  "aliases": [],
2152
2609
  "args": {
2153
- "messageTypeKey": {
2154
- "name": "messageTypeKey",
2610
+ "partialKey": {
2611
+ "name": "partialKey",
2155
2612
  "required": false
2156
2613
  }
2157
2614
  },
@@ -2175,7 +2632,7 @@
2175
2632
  },
2176
2633
  "environment": {
2177
2634
  "name": "environment",
2178
- "summary": "Pushing a message type is only allowed in the development environment",
2635
+ "summary": "Pushing a partial is only allowed in the development environment",
2179
2636
  "default": "development",
2180
2637
  "hasDynamicHelp": false,
2181
2638
  "multiple": false,
@@ -2185,7 +2642,6 @@
2185
2642
  "type": "option"
2186
2643
  },
2187
2644
  "branch": {
2188
- "hidden": true,
2189
2645
  "name": "branch",
2190
2646
  "summary": "The slug of the branch to use.",
2191
2647
  "hasDynamicHelp": false,
@@ -2194,23 +2650,23 @@
2194
2650
  },
2195
2651
  "all": {
2196
2652
  "name": "all",
2197
- "summary": "Whether to push all message types from the target directory.",
2653
+ "summary": "Whether to push all partials from the target directory.",
2198
2654
  "allowNo": false,
2199
2655
  "type": "boolean"
2200
2656
  },
2201
- "message-types-dir": {
2657
+ "partials-dir": {
2202
2658
  "dependsOn": [
2203
2659
  "all"
2204
2660
  ],
2205
- "name": "message-types-dir",
2206
- "summary": "The target directory path to find all message types to push.",
2661
+ "name": "partials-dir",
2662
+ "summary": "The target directory path to find all partials to push.",
2207
2663
  "hasDynamicHelp": false,
2208
2664
  "multiple": false,
2209
2665
  "type": "option"
2210
2666
  },
2211
2667
  "commit": {
2212
2668
  "name": "commit",
2213
- "summary": "Push and commit the message type(s) at the same time",
2669
+ "summary": "Push and commit the partial(s) at the same time",
2214
2670
  "allowNo": false,
2215
2671
  "type": "boolean"
2216
2672
  },
@@ -2228,26 +2684,26 @@
2228
2684
  },
2229
2685
  "hasDynamicHelp": false,
2230
2686
  "hiddenAliases": [],
2231
- "id": "message-type:push",
2687
+ "id": "partial:push",
2232
2688
  "pluginAlias": "@knocklabs/cli",
2233
2689
  "pluginName": "@knocklabs/cli",
2234
2690
  "pluginType": "core",
2235
2691
  "strict": true,
2236
- "summary": "Push one or more message types from a local file system to Knock.",
2692
+ "summary": "Push one or more partials from a local file system to Knock.",
2237
2693
  "enableJsonFlag": false,
2238
2694
  "isESM": false,
2239
2695
  "relativePath": [
2240
2696
  "dist",
2241
2697
  "commands",
2242
- "message-type",
2698
+ "partial",
2243
2699
  "push.js"
2244
2700
  ]
2245
2701
  },
2246
- "message-type:validate": {
2702
+ "partial:validate": {
2247
2703
  "aliases": [],
2248
2704
  "args": {
2249
- "messageTypeKey": {
2250
- "name": "messageTypeKey",
2705
+ "partialKey": {
2706
+ "name": "partialKey",
2251
2707
  "required": false
2252
2708
  }
2253
2709
  },
@@ -2271,7 +2727,7 @@
2271
2727
  },
2272
2728
  "environment": {
2273
2729
  "name": "environment",
2274
- "summary": "Validating a message type is only done in the development environment",
2730
+ "summary": "Validating a partial is only done in the development environment",
2275
2731
  "default": "development",
2276
2732
  "hasDynamicHelp": false,
2277
2733
  "multiple": false,
@@ -2281,7 +2737,6 @@
2281
2737
  "type": "option"
2282
2738
  },
2283
2739
  "branch": {
2284
- "hidden": true,
2285
2740
  "name": "branch",
2286
2741
  "summary": "The slug of the branch to use.",
2287
2742
  "hasDynamicHelp": false,
@@ -2290,16 +2745,16 @@
2290
2745
  },
2291
2746
  "all": {
2292
2747
  "name": "all",
2293
- "summary": "Whether to validate all message types from the target directory.",
2748
+ "summary": "Whether to validate all partials from the target directory.",
2294
2749
  "allowNo": false,
2295
2750
  "type": "boolean"
2296
2751
  },
2297
- "message-types-dir": {
2752
+ "partials-dir": {
2298
2753
  "dependsOn": [
2299
2754
  "all"
2300
2755
  ],
2301
- "name": "message-types-dir",
2302
- "summary": "The target directory path to find all message types to validate.",
2756
+ "name": "partials-dir",
2757
+ "summary": "The target directory path to find all partials to validate.",
2303
2758
  "hasDynamicHelp": false,
2304
2759
  "multiple": false,
2305
2760
  "type": "option"
@@ -2307,26 +2762,27 @@
2307
2762
  },
2308
2763
  "hasDynamicHelp": false,
2309
2764
  "hiddenAliases": [],
2310
- "id": "message-type:validate",
2765
+ "id": "partial:validate",
2311
2766
  "pluginAlias": "@knocklabs/cli",
2312
2767
  "pluginName": "@knocklabs/cli",
2313
2768
  "pluginType": "core",
2314
2769
  "strict": true,
2315
- "summary": "Validate one or more message types from a local file system.",
2770
+ "summary": "Validate one or more partials from a local file system.",
2316
2771
  "enableJsonFlag": false,
2317
2772
  "isESM": false,
2318
2773
  "relativePath": [
2319
2774
  "dist",
2320
2775
  "commands",
2321
- "message-type",
2776
+ "partial",
2322
2777
  "validate.js"
2323
2778
  ]
2324
2779
  },
2325
- "partial:get": {
2780
+ "translation:get": {
2326
2781
  "aliases": [],
2327
2782
  "args": {
2328
- "partialKey": {
2329
- "name": "partialKey",
2783
+ "translationRef": {
2784
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2785
+ "name": "translationRef",
2330
2786
  "required": true
2331
2787
  }
2332
2788
  },
@@ -2364,7 +2820,6 @@
2364
2820
  "type": "option"
2365
2821
  },
2366
2822
  "branch": {
2367
- "hidden": true,
2368
2823
  "name": "branch",
2369
2824
  "summary": "The slug of the branch to use.",
2370
2825
  "hasDynamicHelp": false,
@@ -2376,26 +2831,39 @@
2376
2831
  "summary": "Hide any uncommitted changes.",
2377
2832
  "allowNo": false,
2378
2833
  "type": "boolean"
2834
+ },
2835
+ "format": {
2836
+ "name": "format",
2837
+ "summary": "Specify the output format of the returned translations.",
2838
+ "default": "json",
2839
+ "hasDynamicHelp": false,
2840
+ "multiple": false,
2841
+ "options": [
2842
+ "json",
2843
+ "po"
2844
+ ],
2845
+ "type": "option"
2379
2846
  }
2380
2847
  },
2381
2848
  "hasDynamicHelp": false,
2382
2849
  "hiddenAliases": [],
2383
- "id": "partial:get",
2850
+ "id": "translation:get",
2384
2851
  "pluginAlias": "@knocklabs/cli",
2385
2852
  "pluginName": "@knocklabs/cli",
2386
2853
  "pluginType": "core",
2387
2854
  "strict": true,
2388
- "summary": "Display a single partial from an environment.",
2855
+ "summary": "Display a single translation from an environment.",
2389
2856
  "enableJsonFlag": true,
2857
+ "verifyFeatureEnabled": "translations",
2390
2858
  "isESM": false,
2391
2859
  "relativePath": [
2392
2860
  "dist",
2393
2861
  "commands",
2394
- "partial",
2862
+ "translation",
2395
2863
  "get.js"
2396
2864
  ]
2397
2865
  },
2398
- "partial:list": {
2866
+ "translation:list": {
2399
2867
  "aliases": [],
2400
2868
  "args": {},
2401
2869
  "flags": {
@@ -2432,7 +2900,6 @@
2432
2900
  "type": "option"
2433
2901
  },
2434
2902
  "branch": {
2435
- "hidden": true,
2436
2903
  "name": "branch",
2437
2904
  "summary": "The slug of the branch to use.",
2438
2905
  "hasDynamicHelp": false,
@@ -2469,26 +2936,28 @@
2469
2936
  },
2470
2937
  "hasDynamicHelp": false,
2471
2938
  "hiddenAliases": [],
2472
- "id": "partial:list",
2939
+ "id": "translation:list",
2473
2940
  "pluginAlias": "@knocklabs/cli",
2474
2941
  "pluginName": "@knocklabs/cli",
2475
2942
  "pluginType": "core",
2476
2943
  "strict": true,
2477
- "summary": "Display all partials for an environment.",
2944
+ "summary": "Display all translations for an environment.",
2478
2945
  "enableJsonFlag": true,
2946
+ "verifyFeatureEnabled": "translations",
2479
2947
  "isESM": false,
2480
2948
  "relativePath": [
2481
2949
  "dist",
2482
2950
  "commands",
2483
- "partial",
2951
+ "translation",
2484
2952
  "list.js"
2485
2953
  ]
2486
2954
  },
2487
- "partial:pull": {
2955
+ "translation:pull": {
2488
2956
  "aliases": [],
2489
2957
  "args": {
2490
- "partialKey": {
2491
- "name": "partialKey",
2958
+ "translationRef": {
2959
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2960
+ "name": "translationRef",
2492
2961
  "required": false
2493
2962
  }
2494
2963
  },
@@ -2519,7 +2988,6 @@
2519
2988
  "type": "option"
2520
2989
  },
2521
2990
  "branch": {
2522
- "hidden": true,
2523
2991
  "name": "branch",
2524
2992
  "summary": "The slug of the branch to use.",
2525
2993
  "hasDynamicHelp": false,
@@ -2528,16 +2996,16 @@
2528
2996
  },
2529
2997
  "all": {
2530
2998
  "name": "all",
2531
- "summary": "Whether to pull all partials from the specified environment.",
2999
+ "summary": "Whether to pull all translations from the specified environment.",
2532
3000
  "allowNo": false,
2533
3001
  "type": "boolean"
2534
3002
  },
2535
- "partials-dir": {
3003
+ "translations-dir": {
2536
3004
  "dependsOn": [
2537
3005
  "all"
2538
3006
  ],
2539
- "name": "partials-dir",
2540
- "summary": "The target directory path to pull all partials into.",
3007
+ "name": "translations-dir",
3008
+ "summary": "The target directory path to pull all translations into.",
2541
3009
  "hasDynamicHelp": false,
2542
3010
  "multiple": false,
2543
3011
  "type": "option"
@@ -2553,30 +3021,44 @@
2553
3021
  "summary": "Remove the confirmation prompt.",
2554
3022
  "allowNo": false,
2555
3023
  "type": "boolean"
3024
+ },
3025
+ "format": {
3026
+ "name": "format",
3027
+ "summary": "Specify the output format of the returned translations.",
3028
+ "default": "json",
3029
+ "hasDynamicHelp": false,
3030
+ "multiple": false,
3031
+ "options": [
3032
+ "json",
3033
+ "po"
3034
+ ],
3035
+ "type": "option"
2556
3036
  }
2557
3037
  },
2558
3038
  "hasDynamicHelp": false,
2559
3039
  "hiddenAliases": [],
2560
- "id": "partial:pull",
3040
+ "id": "translation:pull",
2561
3041
  "pluginAlias": "@knocklabs/cli",
2562
3042
  "pluginName": "@knocklabs/cli",
2563
3043
  "pluginType": "core",
2564
3044
  "strict": true,
2565
- "summary": "Pull one or more partial from an environment into a local file system.",
3045
+ "summary": "Pull one or more translations from an environment into a local file system.",
2566
3046
  "enableJsonFlag": false,
3047
+ "verifyFeatureEnabled": "translations",
2567
3048
  "isESM": false,
2568
3049
  "relativePath": [
2569
3050
  "dist",
2570
3051
  "commands",
2571
- "partial",
3052
+ "translation",
2572
3053
  "pull.js"
2573
3054
  ]
2574
3055
  },
2575
- "partial:push": {
3056
+ "translation:push": {
2576
3057
  "aliases": [],
2577
3058
  "args": {
2578
- "partialKey": {
2579
- "name": "partialKey",
3059
+ "translationRef": {
3060
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3061
+ "name": "translationRef",
2580
3062
  "required": false
2581
3063
  }
2582
3064
  },
@@ -2600,7 +3082,7 @@
2600
3082
  },
2601
3083
  "environment": {
2602
3084
  "name": "environment",
2603
- "summary": "Pushing a partial is only allowed in the development environment",
3085
+ "summary": "Pushing a translation is only allowed in the development environment",
2604
3086
  "default": "development",
2605
3087
  "hasDynamicHelp": false,
2606
3088
  "multiple": false,
@@ -2610,7 +3092,6 @@
2610
3092
  "type": "option"
2611
3093
  },
2612
3094
  "branch": {
2613
- "hidden": true,
2614
3095
  "name": "branch",
2615
3096
  "summary": "The slug of the branch to use.",
2616
3097
  "hasDynamicHelp": false,
@@ -2619,23 +3100,23 @@
2619
3100
  },
2620
3101
  "all": {
2621
3102
  "name": "all",
2622
- "summary": "Whether to push all partials from the target directory.",
3103
+ "summary": "Whether to push all translations from the target directory.",
2623
3104
  "allowNo": false,
2624
3105
  "type": "boolean"
2625
3106
  },
2626
- "partials-dir": {
3107
+ "translations-dir": {
2627
3108
  "dependsOn": [
2628
3109
  "all"
2629
3110
  ],
2630
- "name": "partials-dir",
2631
- "summary": "The target directory path to find all partials to push.",
3111
+ "name": "translations-dir",
3112
+ "summary": "The target directory path to find all translations to push.",
2632
3113
  "hasDynamicHelp": false,
2633
3114
  "multiple": false,
2634
3115
  "type": "option"
2635
3116
  },
2636
3117
  "commit": {
2637
3118
  "name": "commit",
2638
- "summary": "Push and commit the partial(s) at the same time",
3119
+ "summary": "Push and commit the translation(s) at the same time",
2639
3120
  "allowNo": false,
2640
3121
  "type": "boolean"
2641
3122
  },
@@ -2653,26 +3134,28 @@
2653
3134
  },
2654
3135
  "hasDynamicHelp": false,
2655
3136
  "hiddenAliases": [],
2656
- "id": "partial:push",
3137
+ "id": "translation:push",
2657
3138
  "pluginAlias": "@knocklabs/cli",
2658
3139
  "pluginName": "@knocklabs/cli",
2659
3140
  "pluginType": "core",
2660
3141
  "strict": true,
2661
- "summary": "Push one or more partials from a local file system to Knock.",
3142
+ "summary": "Push one or more translations from a local file system to Knock.",
2662
3143
  "enableJsonFlag": false,
3144
+ "verifyFeatureEnabled": "translations",
2663
3145
  "isESM": false,
2664
3146
  "relativePath": [
2665
3147
  "dist",
2666
3148
  "commands",
2667
- "partial",
3149
+ "translation",
2668
3150
  "push.js"
2669
3151
  ]
2670
3152
  },
2671
- "partial:validate": {
3153
+ "translation:validate": {
2672
3154
  "aliases": [],
2673
3155
  "args": {
2674
- "partialKey": {
2675
- "name": "partialKey",
3156
+ "translationRef": {
3157
+ "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3158
+ "name": "translationRef",
2676
3159
  "required": false
2677
3160
  }
2678
3161
  },
@@ -2696,7 +3179,7 @@
2696
3179
  },
2697
3180
  "environment": {
2698
3181
  "name": "environment",
2699
- "summary": "Validating a partial is only done in the development environment",
3182
+ "summary": "Validating a translation is only done in the development environment",
2700
3183
  "default": "development",
2701
3184
  "hasDynamicHelp": false,
2702
3185
  "multiple": false,
@@ -2706,7 +3189,6 @@
2706
3189
  "type": "option"
2707
3190
  },
2708
3191
  "branch": {
2709
- "hidden": true,
2710
3192
  "name": "branch",
2711
3193
  "summary": "The slug of the branch to use.",
2712
3194
  "hasDynamicHelp": false,
@@ -2715,16 +3197,16 @@
2715
3197
  },
2716
3198
  "all": {
2717
3199
  "name": "all",
2718
- "summary": "Whether to validate all partials from the target directory.",
3200
+ "summary": "Whether to validate all translations from the target directory.",
2719
3201
  "allowNo": false,
2720
3202
  "type": "boolean"
2721
3203
  },
2722
- "partials-dir": {
3204
+ "translations-dir": {
2723
3205
  "dependsOn": [
2724
3206
  "all"
2725
3207
  ],
2726
- "name": "partials-dir",
2727
- "summary": "The target directory path to find all partials to validate.",
3208
+ "name": "translations-dir",
3209
+ "summary": "The target directory path to find all translations to validate.",
2728
3210
  "hasDynamicHelp": false,
2729
3211
  "multiple": false,
2730
3212
  "type": "option"
@@ -2732,27 +3214,27 @@
2732
3214
  },
2733
3215
  "hasDynamicHelp": false,
2734
3216
  "hiddenAliases": [],
2735
- "id": "partial:validate",
3217
+ "id": "translation:validate",
2736
3218
  "pluginAlias": "@knocklabs/cli",
2737
3219
  "pluginName": "@knocklabs/cli",
2738
3220
  "pluginType": "core",
2739
3221
  "strict": true,
2740
- "summary": "Validate one or more partials from a local file system.",
3222
+ "summary": "Validate one or more translations from a local file system.",
2741
3223
  "enableJsonFlag": false,
3224
+ "verifyFeatureEnabled": "translations",
2742
3225
  "isESM": false,
2743
3226
  "relativePath": [
2744
3227
  "dist",
2745
3228
  "commands",
2746
- "partial",
3229
+ "translation",
2747
3230
  "validate.js"
2748
3231
  ]
2749
3232
  },
2750
- "translation:get": {
3233
+ "message-type:get": {
2751
3234
  "aliases": [],
2752
3235
  "args": {
2753
- "translationRef": {
2754
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2755
- "name": "translationRef",
3236
+ "messageTypeKey": {
3237
+ "name": "messageTypeKey",
2756
3238
  "required": true
2757
3239
  }
2758
3240
  },
@@ -2790,7 +3272,6 @@
2790
3272
  "type": "option"
2791
3273
  },
2792
3274
  "branch": {
2793
- "hidden": true,
2794
3275
  "name": "branch",
2795
3276
  "summary": "The slug of the branch to use.",
2796
3277
  "hasDynamicHelp": false,
@@ -2802,39 +3283,26 @@
2802
3283
  "summary": "Hide any uncommitted changes.",
2803
3284
  "allowNo": false,
2804
3285
  "type": "boolean"
2805
- },
2806
- "format": {
2807
- "name": "format",
2808
- "summary": "Specify the output format of the returned translations.",
2809
- "default": "json",
2810
- "hasDynamicHelp": false,
2811
- "multiple": false,
2812
- "options": [
2813
- "json",
2814
- "po"
2815
- ],
2816
- "type": "option"
2817
3286
  }
2818
3287
  },
2819
3288
  "hasDynamicHelp": false,
2820
3289
  "hiddenAliases": [],
2821
- "id": "translation:get",
3290
+ "id": "message-type:get",
2822
3291
  "pluginAlias": "@knocklabs/cli",
2823
3292
  "pluginName": "@knocklabs/cli",
2824
3293
  "pluginType": "core",
2825
3294
  "strict": true,
2826
- "summary": "Display a single translation from an environment.",
3295
+ "summary": "Display a single in-app message type from an environment.",
2827
3296
  "enableJsonFlag": true,
2828
- "verifyFeatureEnabled": "translations",
2829
3297
  "isESM": false,
2830
3298
  "relativePath": [
2831
3299
  "dist",
2832
3300
  "commands",
2833
- "translation",
3301
+ "message-type",
2834
3302
  "get.js"
2835
3303
  ]
2836
3304
  },
2837
- "translation:list": {
3305
+ "message-type:list": {
2838
3306
  "aliases": [],
2839
3307
  "args": {},
2840
3308
  "flags": {
@@ -2871,7 +3339,6 @@
2871
3339
  "type": "option"
2872
3340
  },
2873
3341
  "branch": {
2874
- "hidden": true,
2875
3342
  "name": "branch",
2876
3343
  "summary": "The slug of the branch to use.",
2877
3344
  "hasDynamicHelp": false,
@@ -2908,28 +3375,116 @@
2908
3375
  },
2909
3376
  "hasDynamicHelp": false,
2910
3377
  "hiddenAliases": [],
2911
- "id": "translation:list",
3378
+ "id": "message-type:list",
2912
3379
  "pluginAlias": "@knocklabs/cli",
2913
3380
  "pluginName": "@knocklabs/cli",
2914
3381
  "pluginType": "core",
2915
3382
  "strict": true,
2916
- "summary": "Display all translations for an environment.",
3383
+ "summary": "Display all in-app message types for an environment.",
2917
3384
  "enableJsonFlag": true,
2918
- "verifyFeatureEnabled": "translations",
2919
3385
  "isESM": false,
2920
3386
  "relativePath": [
2921
3387
  "dist",
2922
3388
  "commands",
2923
- "translation",
3389
+ "message-type",
2924
3390
  "list.js"
2925
3391
  ]
2926
3392
  },
2927
- "translation:pull": {
3393
+ "message-type:new": {
3394
+ "aliases": [],
3395
+ "args": {},
3396
+ "flags": {
3397
+ "service-token": {
3398
+ "env": "KNOCK_SERVICE_TOKEN",
3399
+ "name": "service-token",
3400
+ "required": false,
3401
+ "summary": "The service token to authenticate with.",
3402
+ "hasDynamicHelp": false,
3403
+ "multiple": false,
3404
+ "type": "option"
3405
+ },
3406
+ "api-origin": {
3407
+ "hidden": true,
3408
+ "name": "api-origin",
3409
+ "required": false,
3410
+ "hasDynamicHelp": false,
3411
+ "multiple": false,
3412
+ "type": "option"
3413
+ },
3414
+ "name": {
3415
+ "char": "n",
3416
+ "name": "name",
3417
+ "summary": "The name of the message type",
3418
+ "hasDynamicHelp": false,
3419
+ "multiple": false,
3420
+ "type": "option"
3421
+ },
3422
+ "key": {
3423
+ "char": "k",
3424
+ "name": "key",
3425
+ "summary": "The key of the message type",
3426
+ "hasDynamicHelp": false,
3427
+ "multiple": false,
3428
+ "type": "option"
3429
+ },
3430
+ "environment": {
3431
+ "name": "environment",
3432
+ "summary": "The environment to create the message type in. Defaults to development.",
3433
+ "default": "development",
3434
+ "hasDynamicHelp": false,
3435
+ "multiple": false,
3436
+ "type": "option"
3437
+ },
3438
+ "branch": {
3439
+ "name": "branch",
3440
+ "summary": "The slug of the branch to use.",
3441
+ "hasDynamicHelp": false,
3442
+ "multiple": false,
3443
+ "type": "option"
3444
+ },
3445
+ "force": {
3446
+ "name": "force",
3447
+ "summary": "Force the creation of the message type directory without confirmation.",
3448
+ "allowNo": false,
3449
+ "type": "boolean"
3450
+ },
3451
+ "push": {
3452
+ "char": "p",
3453
+ "name": "push",
3454
+ "summary": "Whether or not to push the message type to Knock after creation.",
3455
+ "allowNo": false,
3456
+ "type": "boolean"
3457
+ },
3458
+ "template": {
3459
+ "name": "template",
3460
+ "summary": "The template to use for the message type. Should be `message-types/{key}`.",
3461
+ "hasDynamicHelp": false,
3462
+ "multiple": false,
3463
+ "type": "option"
3464
+ }
3465
+ },
3466
+ "hasDynamicHelp": false,
3467
+ "hiddenAliases": [],
3468
+ "id": "message-type:new",
3469
+ "pluginAlias": "@knocklabs/cli",
3470
+ "pluginName": "@knocklabs/cli",
3471
+ "pluginType": "core",
3472
+ "strict": true,
3473
+ "summary": "Create a new message type with a minimal configuration.",
3474
+ "enableJsonFlag": false,
3475
+ "isESM": false,
3476
+ "relativePath": [
3477
+ "dist",
3478
+ "commands",
3479
+ "message-type",
3480
+ "new.js"
3481
+ ]
3482
+ },
3483
+ "message-type:pull": {
2928
3484
  "aliases": [],
2929
3485
  "args": {
2930
- "translationRef": {
2931
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
2932
- "name": "translationRef",
3486
+ "messageTypeKey": {
3487
+ "name": "messageTypeKey",
2933
3488
  "required": false
2934
3489
  }
2935
3490
  },
@@ -2960,7 +3515,6 @@
2960
3515
  "type": "option"
2961
3516
  },
2962
3517
  "branch": {
2963
- "hidden": true,
2964
3518
  "name": "branch",
2965
3519
  "summary": "The slug of the branch to use.",
2966
3520
  "hasDynamicHelp": false,
@@ -2969,16 +3523,16 @@
2969
3523
  },
2970
3524
  "all": {
2971
3525
  "name": "all",
2972
- "summary": "Whether to pull all translations from the specified environment.",
3526
+ "summary": "Whether to pull all in-app message types from the specified environment.",
2973
3527
  "allowNo": false,
2974
3528
  "type": "boolean"
2975
3529
  },
2976
- "translations-dir": {
3530
+ "message-types-dir": {
2977
3531
  "dependsOn": [
2978
3532
  "all"
2979
3533
  ],
2980
- "name": "translations-dir",
2981
- "summary": "The target directory path to pull all translations into.",
3534
+ "name": "message-types-dir",
3535
+ "summary": "The target directory path to pull all in-app message types into.",
2982
3536
  "hasDynamicHelp": false,
2983
3537
  "multiple": false,
2984
3538
  "type": "option"
@@ -2994,44 +3548,30 @@
2994
3548
  "summary": "Remove the confirmation prompt.",
2995
3549
  "allowNo": false,
2996
3550
  "type": "boolean"
2997
- },
2998
- "format": {
2999
- "name": "format",
3000
- "summary": "Specify the output format of the returned translations.",
3001
- "default": "json",
3002
- "hasDynamicHelp": false,
3003
- "multiple": false,
3004
- "options": [
3005
- "json",
3006
- "po"
3007
- ],
3008
- "type": "option"
3009
3551
  }
3010
3552
  },
3011
3553
  "hasDynamicHelp": false,
3012
3554
  "hiddenAliases": [],
3013
- "id": "translation:pull",
3555
+ "id": "message-type:pull",
3014
3556
  "pluginAlias": "@knocklabs/cli",
3015
3557
  "pluginName": "@knocklabs/cli",
3016
3558
  "pluginType": "core",
3017
3559
  "strict": true,
3018
- "summary": "Pull one or more translations from an environment into a local file system.",
3560
+ "summary": "Pull one or more in-app message types from an environment into a local file system.",
3019
3561
  "enableJsonFlag": false,
3020
- "verifyFeatureEnabled": "translations",
3021
3562
  "isESM": false,
3022
3563
  "relativePath": [
3023
3564
  "dist",
3024
3565
  "commands",
3025
- "translation",
3566
+ "message-type",
3026
3567
  "pull.js"
3027
3568
  ]
3028
3569
  },
3029
- "translation:push": {
3570
+ "message-type:push": {
3030
3571
  "aliases": [],
3031
3572
  "args": {
3032
- "translationRef": {
3033
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3034
- "name": "translationRef",
3573
+ "messageTypeKey": {
3574
+ "name": "messageTypeKey",
3035
3575
  "required": false
3036
3576
  }
3037
3577
  },
@@ -3055,7 +3595,7 @@
3055
3595
  },
3056
3596
  "environment": {
3057
3597
  "name": "environment",
3058
- "summary": "Pushing a translation is only allowed in the development environment",
3598
+ "summary": "Pushing a message type is only allowed in the development environment",
3059
3599
  "default": "development",
3060
3600
  "hasDynamicHelp": false,
3061
3601
  "multiple": false,
@@ -3065,7 +3605,6 @@
3065
3605
  "type": "option"
3066
3606
  },
3067
3607
  "branch": {
3068
- "hidden": true,
3069
3608
  "name": "branch",
3070
3609
  "summary": "The slug of the branch to use.",
3071
3610
  "hasDynamicHelp": false,
@@ -3074,23 +3613,23 @@
3074
3613
  },
3075
3614
  "all": {
3076
3615
  "name": "all",
3077
- "summary": "Whether to push all translations from the target directory.",
3616
+ "summary": "Whether to push all message types from the target directory.",
3078
3617
  "allowNo": false,
3079
3618
  "type": "boolean"
3080
3619
  },
3081
- "translations-dir": {
3620
+ "message-types-dir": {
3082
3621
  "dependsOn": [
3083
3622
  "all"
3084
3623
  ],
3085
- "name": "translations-dir",
3086
- "summary": "The target directory path to find all translations to push.",
3624
+ "name": "message-types-dir",
3625
+ "summary": "The target directory path to find all message types to push.",
3087
3626
  "hasDynamicHelp": false,
3088
3627
  "multiple": false,
3089
3628
  "type": "option"
3090
3629
  },
3091
3630
  "commit": {
3092
3631
  "name": "commit",
3093
- "summary": "Push and commit the translation(s) at the same time",
3632
+ "summary": "Push and commit the message type(s) at the same time",
3094
3633
  "allowNo": false,
3095
3634
  "type": "boolean"
3096
3635
  },
@@ -3108,28 +3647,26 @@
3108
3647
  },
3109
3648
  "hasDynamicHelp": false,
3110
3649
  "hiddenAliases": [],
3111
- "id": "translation:push",
3650
+ "id": "message-type:push",
3112
3651
  "pluginAlias": "@knocklabs/cli",
3113
3652
  "pluginName": "@knocklabs/cli",
3114
3653
  "pluginType": "core",
3115
3654
  "strict": true,
3116
- "summary": "Push one or more translations from a local file system to Knock.",
3655
+ "summary": "Push one or more message types from a local file system to Knock.",
3117
3656
  "enableJsonFlag": false,
3118
- "verifyFeatureEnabled": "translations",
3119
3657
  "isESM": false,
3120
3658
  "relativePath": [
3121
3659
  "dist",
3122
3660
  "commands",
3123
- "translation",
3661
+ "message-type",
3124
3662
  "push.js"
3125
3663
  ]
3126
3664
  },
3127
- "translation:validate": {
3665
+ "message-type:validate": {
3128
3666
  "aliases": [],
3129
3667
  "args": {
3130
- "translationRef": {
3131
- "description": "Translation ref is a identifier string that refers to a unique translation.\nIf a translation has no namespace, it is the same as the locale, e.g. `en`.\nIf namespaced, it is formatted as namespace.locale, e.g. `admin.en`.",
3132
- "name": "translationRef",
3668
+ "messageTypeKey": {
3669
+ "name": "messageTypeKey",
3133
3670
  "required": false
3134
3671
  }
3135
3672
  },
@@ -3153,7 +3690,7 @@
3153
3690
  },
3154
3691
  "environment": {
3155
3692
  "name": "environment",
3156
- "summary": "Validating a translation is only done in the development environment",
3693
+ "summary": "Validating a message type is only done in the development environment",
3157
3694
  "default": "development",
3158
3695
  "hasDynamicHelp": false,
3159
3696
  "multiple": false,
@@ -3163,7 +3700,6 @@
3163
3700
  "type": "option"
3164
3701
  },
3165
3702
  "branch": {
3166
- "hidden": true,
3167
3703
  "name": "branch",
3168
3704
  "summary": "The slug of the branch to use.",
3169
3705
  "hasDynamicHelp": false,
@@ -3172,16 +3708,16 @@
3172
3708
  },
3173
3709
  "all": {
3174
3710
  "name": "all",
3175
- "summary": "Whether to validate all translations from the target directory.",
3711
+ "summary": "Whether to validate all message types from the target directory.",
3176
3712
  "allowNo": false,
3177
3713
  "type": "boolean"
3178
3714
  },
3179
- "translations-dir": {
3715
+ "message-types-dir": {
3180
3716
  "dependsOn": [
3181
3717
  "all"
3182
3718
  ],
3183
- "name": "translations-dir",
3184
- "summary": "The target directory path to find all translations to validate.",
3719
+ "name": "message-types-dir",
3720
+ "summary": "The target directory path to find all message types to validate.",
3185
3721
  "hasDynamicHelp": false,
3186
3722
  "multiple": false,
3187
3723
  "type": "option"
@@ -3189,19 +3725,18 @@
3189
3725
  },
3190
3726
  "hasDynamicHelp": false,
3191
3727
  "hiddenAliases": [],
3192
- "id": "translation:validate",
3728
+ "id": "message-type:validate",
3193
3729
  "pluginAlias": "@knocklabs/cli",
3194
3730
  "pluginName": "@knocklabs/cli",
3195
3731
  "pluginType": "core",
3196
3732
  "strict": true,
3197
- "summary": "Validate one or more translations from a local file system.",
3733
+ "summary": "Validate one or more message types from a local file system.",
3198
3734
  "enableJsonFlag": false,
3199
- "verifyFeatureEnabled": "translations",
3200
3735
  "isESM": false,
3201
3736
  "relativePath": [
3202
3737
  "dist",
3203
3738
  "commands",
3204
- "translation",
3739
+ "message-type",
3205
3740
  "validate.js"
3206
3741
  ]
3207
3742
  },
@@ -3241,7 +3776,6 @@
3241
3776
  "type": "option"
3242
3777
  },
3243
3778
  "branch": {
3244
- "hidden": true,
3245
3779
  "name": "branch",
3246
3780
  "summary": "The slug of the branch to use.",
3247
3781
  "hasDynamicHelp": false,
@@ -3315,7 +3849,6 @@
3315
3849
  "type": "option"
3316
3850
  },
3317
3851
  "branch": {
3318
- "hidden": true,
3319
3852
  "name": "branch",
3320
3853
  "summary": "The slug of the branch to use.",
3321
3854
  "hasDynamicHelp": false,
@@ -3389,7 +3922,6 @@
3389
3922
  "type": "option"
3390
3923
  },
3391
3924
  "branch": {
3392
- "hidden": true,
3393
3925
  "name": "branch",
3394
3926
  "summary": "The slug of the branch to use.",
3395
3927
  "hasDynamicHelp": false,
@@ -3457,7 +3989,6 @@
3457
3989
  "type": "option"
3458
3990
  },
3459
3991
  "branch": {
3460
- "hidden": true,
3461
3992
  "name": "branch",
3462
3993
  "summary": "The slug of the branch to use.",
3463
3994
  "hasDynamicHelp": false,
@@ -3511,12 +4042,7 @@
3511
4042
  },
3512
4043
  "workflow:new": {
3513
4044
  "aliases": [],
3514
- "args": {
3515
- "workflowKey": {
3516
- "name": "workflowKey",
3517
- "required": true
3518
- }
3519
- },
4045
+ "args": {},
3520
4046
  "flags": {
3521
4047
  "service-token": {
3522
4048
  "env": "KNOCK_SERVICE_TOKEN",
@@ -3535,37 +4061,75 @@
3535
4061
  "multiple": false,
3536
4062
  "type": "option"
3537
4063
  },
4064
+ "name": {
4065
+ "char": "n",
4066
+ "name": "name",
4067
+ "summary": "The name of the workflow",
4068
+ "hasDynamicHelp": false,
4069
+ "multiple": false,
4070
+ "type": "option"
4071
+ },
4072
+ "key": {
4073
+ "char": "k",
4074
+ "name": "key",
4075
+ "summary": "The key of the workflow",
4076
+ "hasDynamicHelp": false,
4077
+ "multiple": false,
4078
+ "type": "option"
4079
+ },
3538
4080
  "steps": {
3539
- "aliases": [
3540
- "step"
3541
- ],
4081
+ "char": "s",
3542
4082
  "name": "steps",
4083
+ "summary": "Comma-separated list of step types to include in the workflow",
4084
+ "hasDynamicHelp": false,
4085
+ "multiple": false,
4086
+ "type": "option"
4087
+ },
4088
+ "environment": {
4089
+ "name": "environment",
4090
+ "summary": "The environment to create the workflow in. Defaults to development.",
4091
+ "default": "development",
4092
+ "hasDynamicHelp": false,
4093
+ "multiple": false,
4094
+ "type": "option"
4095
+ },
4096
+ "branch": {
4097
+ "name": "branch",
4098
+ "summary": "The slug of the branch to use.",
3543
4099
  "hasDynamicHelp": false,
3544
4100
  "multiple": false,
3545
4101
  "type": "option"
3546
4102
  },
3547
4103
  "force": {
3548
4104
  "name": "force",
4105
+ "summary": "Force the creation of the workflow directory without confirmation.",
3549
4106
  "allowNo": false,
3550
4107
  "type": "boolean"
3551
4108
  },
3552
- "environment": {
3553
- "hidden": true,
3554
- "name": "environment",
3555
- "default": "development",
4109
+ "push": {
4110
+ "char": "p",
4111
+ "name": "push",
4112
+ "summary": "Whether or not to push the workflow to Knock after creation.",
4113
+ "allowNo": false,
4114
+ "type": "boolean"
4115
+ },
4116
+ "template": {
4117
+ "char": "t",
4118
+ "name": "template",
4119
+ "summary": "The template repository to use for the workflow. Should be `workflows/{type}`. You cannot use this flag with --steps.",
3556
4120
  "hasDynamicHelp": false,
3557
4121
  "multiple": false,
3558
4122
  "type": "option"
3559
4123
  }
3560
4124
  },
3561
4125
  "hasDynamicHelp": false,
3562
- "hidden": true,
3563
4126
  "hiddenAliases": [],
3564
4127
  "id": "workflow:new",
3565
4128
  "pluginAlias": "@knocklabs/cli",
3566
4129
  "pluginName": "@knocklabs/cli",
3567
4130
  "pluginType": "core",
3568
4131
  "strict": true,
4132
+ "summary": "Create a new workflow with a minimal configuration.",
3569
4133
  "enableJsonFlag": false,
3570
4134
  "isESM": false,
3571
4135
  "relativePath": [
@@ -3610,7 +4174,6 @@
3610
4174
  "type": "option"
3611
4175
  },
3612
4176
  "branch": {
3613
- "hidden": true,
3614
4177
  "name": "branch",
3615
4178
  "summary": "The slug of the branch to use.",
3616
4179
  "hasDynamicHelp": false,
@@ -3698,7 +4261,6 @@
3698
4261
  "type": "option"
3699
4262
  },
3700
4263
  "branch": {
3701
- "hidden": true,
3702
4264
  "name": "branch",
3703
4265
  "summary": "The slug of the branch to use.",
3704
4266
  "hasDynamicHelp": false,
@@ -3791,7 +4353,6 @@
3791
4353
  "type": "option"
3792
4354
  },
3793
4355
  "branch": {
3794
- "hidden": true,
3795
4356
  "name": "branch",
3796
4357
  "summary": "The slug of the branch to use.",
3797
4358
  "hasDynamicHelp": false,
@@ -3883,7 +4444,6 @@
3883
4444
  "type": "option"
3884
4445
  },
3885
4446
  "branch": {
3886
- "hidden": true,
3887
4447
  "name": "branch",
3888
4448
  "summary": "The slug of the branch to use.",
3889
4449
  "hasDynamicHelp": false,
@@ -3925,5 +4485,5 @@
3925
4485
  ]
3926
4486
  }
3927
4487
  },
3928
- "version": "0.3.0"
4488
+ "version": "1.0.0-rc.1"
3929
4489
  }