@knocklabs/cli 0.2.5 → 0.3.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.
@@ -144,7 +144,6 @@
144
144
  "type": "option"
145
145
  },
146
146
  "branch": {
147
- "hidden": true,
148
147
  "name": "branch",
149
148
  "summary": "The slug of the branch to use.",
150
149
  "hasDynamicHelp": false,
@@ -221,7 +220,6 @@
221
220
  "type": "option"
222
221
  },
223
222
  "branch": {
224
- "hidden": true,
225
223
  "name": "branch",
226
224
  "summary": "The slug of the branch to use.",
227
225
  "hasDynamicHelp": false,
@@ -351,7 +349,6 @@
351
349
  }
352
350
  },
353
351
  "hasDynamicHelp": false,
354
- "hidden": true,
355
352
  "hiddenAliases": [],
356
353
  "id": "branch:create",
357
354
  "pluginAlias": "@knocklabs/cli",
@@ -403,7 +400,6 @@
403
400
  }
404
401
  },
405
402
  "hasDynamicHelp": false,
406
- "hidden": true,
407
403
  "hiddenAliases": [],
408
404
  "id": "branch:delete",
409
405
  "pluginAlias": "@knocklabs/cli",
@@ -443,7 +439,6 @@
443
439
  }
444
440
  },
445
441
  "hasDynamicHelp": false,
446
- "hidden": true,
447
442
  "hiddenAliases": [],
448
443
  "id": "branch:exit",
449
444
  "pluginAlias": "@knocklabs/cli",
@@ -511,7 +506,6 @@
511
506
  }
512
507
  },
513
508
  "hasDynamicHelp": false,
514
- "hidden": true,
515
509
  "hiddenAliases": [],
516
510
  "id": "branch:list",
517
511
  "pluginAlias": "@knocklabs/cli",
@@ -569,7 +563,6 @@
569
563
  }
570
564
  },
571
565
  "hasDynamicHelp": false,
572
- "hidden": true,
573
566
  "hiddenAliases": [],
574
567
  "id": "branch:switch",
575
568
  "pluginAlias": "@knocklabs/cli",
@@ -670,7 +663,6 @@
670
663
  "type": "option"
671
664
  },
672
665
  "branch": {
673
- "hidden": true,
674
666
  "name": "branch",
675
667
  "summary": "The slug of the branch to use.",
676
668
  "hasDynamicHelp": false,
@@ -746,7 +738,6 @@
746
738
  "type": "option"
747
739
  },
748
740
  "branch": {
749
- "hidden": true,
750
741
  "name": "branch",
751
742
  "summary": "The slug of the branch to use.",
752
743
  "hasDynamicHelp": false,
@@ -915,7 +906,6 @@
915
906
  "type": "option"
916
907
  },
917
908
  "branch": {
918
- "hidden": true,
919
909
  "name": "branch",
920
910
  "summary": "The slug of the branch to use.",
921
911
  "hasDynamicHelp": false,
@@ -1012,7 +1002,6 @@
1012
1002
  "type": "option"
1013
1003
  },
1014
1004
  "branch": {
1015
- "hidden": true,
1016
1005
  "name": "branch",
1017
1006
  "summary": "The slug of the branch to use.",
1018
1007
  "hasDynamicHelp": false,
@@ -1086,7 +1075,6 @@
1086
1075
  "type": "option"
1087
1076
  },
1088
1077
  "branch": {
1089
- "hidden": true,
1090
1078
  "name": "branch",
1091
1079
  "summary": "The slug of the branch to use.",
1092
1080
  "hasDynamicHelp": false,
@@ -1154,7 +1142,6 @@
1154
1142
  "type": "option"
1155
1143
  },
1156
1144
  "branch": {
1157
- "hidden": true,
1158
1145
  "name": "branch",
1159
1146
  "summary": "The slug of the branch to use.",
1160
1147
  "hasDynamicHelp": false,
@@ -1241,7 +1228,6 @@
1241
1228
  "type": "option"
1242
1229
  },
1243
1230
  "branch": {
1244
- "hidden": true,
1245
1231
  "name": "branch",
1246
1232
  "summary": "The slug of the branch to use.",
1247
1233
  "hasDynamicHelp": false,
@@ -1329,7 +1315,6 @@
1329
1315
  "type": "option"
1330
1316
  },
1331
1317
  "branch": {
1332
- "hidden": true,
1333
1318
  "name": "branch",
1334
1319
  "summary": "The slug of the branch to use.",
1335
1320
  "hasDynamicHelp": false,
@@ -1422,7 +1407,6 @@
1422
1407
  "type": "option"
1423
1408
  },
1424
1409
  "branch": {
1425
- "hidden": true,
1426
1410
  "name": "branch",
1427
1411
  "summary": "The slug of the branch to use.",
1428
1412
  "hasDynamicHelp": false,
@@ -1505,7 +1489,6 @@
1505
1489
  "type": "option"
1506
1490
  },
1507
1491
  "branch": {
1508
- "hidden": true,
1509
1492
  "name": "branch",
1510
1493
  "summary": "The slug of the branch to use.",
1511
1494
  "hasDynamicHelp": false,
@@ -1573,7 +1556,6 @@
1573
1556
  "type": "option"
1574
1557
  },
1575
1558
  "branch": {
1576
- "hidden": true,
1577
1559
  "name": "branch",
1578
1560
  "summary": "The slug of the branch to use.",
1579
1561
  "hasDynamicHelp": false,
@@ -1660,7 +1642,6 @@
1660
1642
  "type": "option"
1661
1643
  },
1662
1644
  "branch": {
1663
- "hidden": true,
1664
1645
  "name": "branch",
1665
1646
  "summary": "The slug of the branch to use.",
1666
1647
  "hasDynamicHelp": false,
@@ -1754,7 +1735,6 @@
1754
1735
  "type": "option"
1755
1736
  },
1756
1737
  "branch": {
1757
- "hidden": true,
1758
1738
  "name": "branch",
1759
1739
  "summary": "The slug of the branch to use.",
1760
1740
  "hasDynamicHelp": false,
@@ -1853,7 +1833,6 @@
1853
1833
  "type": "option"
1854
1834
  },
1855
1835
  "branch": {
1856
- "hidden": true,
1857
1836
  "name": "branch",
1858
1837
  "summary": "The slug of the branch to use.",
1859
1838
  "hasDynamicHelp": false,
@@ -1939,7 +1918,6 @@
1939
1918
  "type": "option"
1940
1919
  },
1941
1920
  "branch": {
1942
- "hidden": true,
1943
1921
  "name": "branch",
1944
1922
  "summary": "The slug of the branch to use.",
1945
1923
  "hasDynamicHelp": false,
@@ -2007,7 +1985,6 @@
2007
1985
  "type": "option"
2008
1986
  },
2009
1987
  "branch": {
2010
- "hidden": true,
2011
1988
  "name": "branch",
2012
1989
  "summary": "The slug of the branch to use.",
2013
1990
  "hasDynamicHelp": false,
@@ -2094,7 +2071,6 @@
2094
2071
  "type": "option"
2095
2072
  },
2096
2073
  "branch": {
2097
- "hidden": true,
2098
2074
  "name": "branch",
2099
2075
  "summary": "The slug of the branch to use.",
2100
2076
  "hasDynamicHelp": false,
@@ -2185,7 +2161,6 @@
2185
2161
  "type": "option"
2186
2162
  },
2187
2163
  "branch": {
2188
- "hidden": true,
2189
2164
  "name": "branch",
2190
2165
  "summary": "The slug of the branch to use.",
2191
2166
  "hasDynamicHelp": false,
@@ -2281,7 +2256,6 @@
2281
2256
  "type": "option"
2282
2257
  },
2283
2258
  "branch": {
2284
- "hidden": true,
2285
2259
  "name": "branch",
2286
2260
  "summary": "The slug of the branch to use.",
2287
2261
  "hasDynamicHelp": false,
@@ -2364,7 +2338,6 @@
2364
2338
  "type": "option"
2365
2339
  },
2366
2340
  "branch": {
2367
- "hidden": true,
2368
2341
  "name": "branch",
2369
2342
  "summary": "The slug of the branch to use.",
2370
2343
  "hasDynamicHelp": false,
@@ -2432,7 +2405,6 @@
2432
2405
  "type": "option"
2433
2406
  },
2434
2407
  "branch": {
2435
- "hidden": true,
2436
2408
  "name": "branch",
2437
2409
  "summary": "The slug of the branch to use.",
2438
2410
  "hasDynamicHelp": false,
@@ -2519,7 +2491,6 @@
2519
2491
  "type": "option"
2520
2492
  },
2521
2493
  "branch": {
2522
- "hidden": true,
2523
2494
  "name": "branch",
2524
2495
  "summary": "The slug of the branch to use.",
2525
2496
  "hasDynamicHelp": false,
@@ -2610,7 +2581,6 @@
2610
2581
  "type": "option"
2611
2582
  },
2612
2583
  "branch": {
2613
- "hidden": true,
2614
2584
  "name": "branch",
2615
2585
  "summary": "The slug of the branch to use.",
2616
2586
  "hasDynamicHelp": false,
@@ -2706,7 +2676,6 @@
2706
2676
  "type": "option"
2707
2677
  },
2708
2678
  "branch": {
2709
- "hidden": true,
2710
2679
  "name": "branch",
2711
2680
  "summary": "The slug of the branch to use.",
2712
2681
  "hasDynamicHelp": false,
@@ -2747,23 +2716,16 @@
2747
2716
  "validate.js"
2748
2717
  ]
2749
2718
  },
2750
- "translation:get": {
2719
+ "workflow:activate": {
2751
2720
  "aliases": [],
2752
2721
  "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",
2722
+ "workflowKey": {
2723
+ "name": "workflowKey",
2756
2724
  "required": true
2757
2725
  }
2758
2726
  },
2727
+ "description": "This immediately enables or disables a workflow in a given environment without\nneeding to go through environment promotion.\n\nBy default, this command activates a given workflow. Pass in the --status flag\nwith `false` in order to deactivate it.",
2759
2728
  "flags": {
2760
- "json": {
2761
- "description": "Format output as json.",
2762
- "helpGroup": "GLOBAL",
2763
- "name": "json",
2764
- "allowNo": false,
2765
- "type": "boolean"
2766
- },
2767
2729
  "service-token": {
2768
2730
  "env": "KNOCK_SERVICE_TOKEN",
2769
2731
  "name": "service-token",
@@ -2783,68 +2745,60 @@
2783
2745
  },
2784
2746
  "environment": {
2785
2747
  "name": "environment",
2748
+ "required": true,
2786
2749
  "summary": "The environment to use.",
2787
- "default": "development",
2788
2750
  "hasDynamicHelp": false,
2789
2751
  "multiple": false,
2790
2752
  "type": "option"
2791
2753
  },
2792
2754
  "branch": {
2793
- "hidden": true,
2794
2755
  "name": "branch",
2795
2756
  "summary": "The slug of the branch to use.",
2796
2757
  "hasDynamicHelp": false,
2797
2758
  "multiple": false,
2798
2759
  "type": "option"
2799
2760
  },
2800
- "hide-uncommitted-changes": {
2801
- "name": "hide-uncommitted-changes",
2802
- "summary": "Hide any uncommitted changes.",
2803
- "allowNo": false,
2804
- "type": "boolean"
2805
- },
2806
- "format": {
2807
- "name": "format",
2808
- "summary": "Specify the output format of the returned translations.",
2809
- "default": "json",
2761
+ "status": {
2762
+ "name": "status",
2763
+ "summary": "The workflow active status to set.",
2764
+ "default": true,
2810
2765
  "hasDynamicHelp": false,
2811
2766
  "multiple": false,
2812
2767
  "options": [
2813
- "json",
2814
- "po"
2768
+ "true",
2769
+ "false"
2815
2770
  ],
2816
2771
  "type": "option"
2772
+ },
2773
+ "force": {
2774
+ "name": "force",
2775
+ "summary": "Remove the confirmation prompt.",
2776
+ "allowNo": false,
2777
+ "type": "boolean"
2817
2778
  }
2818
2779
  },
2819
2780
  "hasDynamicHelp": false,
2820
2781
  "hiddenAliases": [],
2821
- "id": "translation:get",
2782
+ "id": "workflow:activate",
2822
2783
  "pluginAlias": "@knocklabs/cli",
2823
2784
  "pluginName": "@knocklabs/cli",
2824
2785
  "pluginType": "core",
2825
2786
  "strict": true,
2826
- "summary": "Display a single translation from an environment.",
2827
- "enableJsonFlag": true,
2828
- "verifyFeatureEnabled": "translations",
2787
+ "summary": "Activate or deactivate a workflow in a given environment.",
2788
+ "enableJsonFlag": false,
2829
2789
  "isESM": false,
2830
2790
  "relativePath": [
2831
2791
  "dist",
2832
2792
  "commands",
2833
- "translation",
2834
- "get.js"
2793
+ "workflow",
2794
+ "activate.js"
2835
2795
  ]
2836
2796
  },
2837
- "translation:list": {
2797
+ "workflow:generate-types": {
2838
2798
  "aliases": [],
2839
2799
  "args": {},
2800
+ "description": "Generate types for all workflows in an environment and write them to a file.",
2840
2801
  "flags": {
2841
- "json": {
2842
- "description": "Format output as json.",
2843
- "helpGroup": "GLOBAL",
2844
- "name": "json",
2845
- "allowNo": false,
2846
- "type": "boolean"
2847
- },
2848
2802
  "service-token": {
2849
2803
  "env": "KNOCK_SERVICE_TOKEN",
2850
2804
  "name": "service-token",
@@ -2864,43 +2818,23 @@
2864
2818
  },
2865
2819
  "environment": {
2866
2820
  "name": "environment",
2867
- "summary": "The environment to use.",
2821
+ "summary": "Select the environment to generate types for.",
2868
2822
  "default": "development",
2869
2823
  "hasDynamicHelp": false,
2870
2824
  "multiple": false,
2871
2825
  "type": "option"
2872
2826
  },
2873
2827
  "branch": {
2874
- "hidden": true,
2875
2828
  "name": "branch",
2876
2829
  "summary": "The slug of the branch to use.",
2877
2830
  "hasDynamicHelp": false,
2878
2831
  "multiple": false,
2879
2832
  "type": "option"
2880
2833
  },
2881
- "hide-uncommitted-changes": {
2882
- "name": "hide-uncommitted-changes",
2883
- "summary": "Hide any uncommitted changes.",
2884
- "allowNo": false,
2885
- "type": "boolean"
2886
- },
2887
- "after": {
2888
- "name": "after",
2889
- "summary": "The cursor after which to fetch the next page.",
2890
- "hasDynamicHelp": false,
2891
- "multiple": false,
2892
- "type": "option"
2893
- },
2894
- "before": {
2895
- "name": "before",
2896
- "summary": "The cursor before which to fetch the previous page.",
2897
- "hasDynamicHelp": false,
2898
- "multiple": false,
2899
- "type": "option"
2900
- },
2901
- "limit": {
2902
- "name": "limit",
2903
- "summary": "The total number of entries to fetch per page.",
2834
+ "output-file": {
2835
+ "name": "output-file",
2836
+ "required": true,
2837
+ "summary": "The output file to write the generated types to. We currently support .ts, .rb, .go, .py files only. Your file extension will determine the target language for the generated types.",
2904
2838
  "hasDynamicHelp": false,
2905
2839
  "multiple": false,
2906
2840
  "type": "option"
@@ -2908,32 +2842,36 @@
2908
2842
  },
2909
2843
  "hasDynamicHelp": false,
2910
2844
  "hiddenAliases": [],
2911
- "id": "translation:list",
2845
+ "id": "workflow:generate-types",
2912
2846
  "pluginAlias": "@knocklabs/cli",
2913
2847
  "pluginName": "@knocklabs/cli",
2914
2848
  "pluginType": "core",
2915
2849
  "strict": true,
2916
- "summary": "Display all translations for an environment.",
2917
- "enableJsonFlag": true,
2918
- "verifyFeatureEnabled": "translations",
2850
+ "enableJsonFlag": false,
2919
2851
  "isESM": false,
2920
2852
  "relativePath": [
2921
2853
  "dist",
2922
2854
  "commands",
2923
- "translation",
2924
- "list.js"
2855
+ "workflow",
2856
+ "generate-types.js"
2925
2857
  ]
2926
2858
  },
2927
- "translation:pull": {
2859
+ "workflow:get": {
2928
2860
  "aliases": [],
2929
2861
  "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",
2933
- "required": false
2862
+ "workflowKey": {
2863
+ "name": "workflowKey",
2864
+ "required": true
2934
2865
  }
2935
2866
  },
2936
2867
  "flags": {
2868
+ "json": {
2869
+ "description": "Format output as json.",
2870
+ "helpGroup": "GLOBAL",
2871
+ "name": "json",
2872
+ "allowNo": false,
2873
+ "type": "boolean"
2874
+ },
2937
2875
  "service-token": {
2938
2876
  "env": "KNOCK_SERVICE_TOKEN",
2939
2877
  "name": "service-token",
@@ -2960,82 +2898,47 @@
2960
2898
  "type": "option"
2961
2899
  },
2962
2900
  "branch": {
2963
- "hidden": true,
2964
2901
  "name": "branch",
2965
2902
  "summary": "The slug of the branch to use.",
2966
2903
  "hasDynamicHelp": false,
2967
2904
  "multiple": false,
2968
2905
  "type": "option"
2969
2906
  },
2970
- "all": {
2971
- "name": "all",
2972
- "summary": "Whether to pull all translations from the specified environment.",
2973
- "allowNo": false,
2974
- "type": "boolean"
2975
- },
2976
- "translations-dir": {
2977
- "dependsOn": [
2978
- "all"
2979
- ],
2980
- "name": "translations-dir",
2981
- "summary": "The target directory path to pull all translations into.",
2982
- "hasDynamicHelp": false,
2983
- "multiple": false,
2984
- "type": "option"
2985
- },
2986
2907
  "hide-uncommitted-changes": {
2987
2908
  "name": "hide-uncommitted-changes",
2988
2909
  "summary": "Hide any uncommitted changes.",
2989
2910
  "allowNo": false,
2990
2911
  "type": "boolean"
2991
- },
2992
- "force": {
2993
- "name": "force",
2994
- "summary": "Remove the confirmation prompt.",
2995
- "allowNo": false,
2996
- "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
2912
  }
3010
2913
  },
3011
2914
  "hasDynamicHelp": false,
3012
2915
  "hiddenAliases": [],
3013
- "id": "translation:pull",
2916
+ "id": "workflow:get",
3014
2917
  "pluginAlias": "@knocklabs/cli",
3015
2918
  "pluginName": "@knocklabs/cli",
3016
2919
  "pluginType": "core",
3017
2920
  "strict": true,
3018
- "summary": "Pull one or more translations from an environment into a local file system.",
3019
- "enableJsonFlag": false,
3020
- "verifyFeatureEnabled": "translations",
2921
+ "summary": "Display a single workflow from an environment.",
2922
+ "enableJsonFlag": true,
3021
2923
  "isESM": false,
3022
2924
  "relativePath": [
3023
2925
  "dist",
3024
2926
  "commands",
3025
- "translation",
3026
- "pull.js"
2927
+ "workflow",
2928
+ "get.js"
3027
2929
  ]
3028
2930
  },
3029
- "translation:push": {
2931
+ "workflow:list": {
3030
2932
  "aliases": [],
3031
- "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",
3035
- "required": false
3036
- }
3037
- },
2933
+ "args": {},
3038
2934
  "flags": {
2935
+ "json": {
2936
+ "description": "Format output as json.",
2937
+ "helpGroup": "GLOBAL",
2938
+ "name": "json",
2939
+ "allowNo": false,
2940
+ "type": "boolean"
2941
+ },
3039
2942
  "service-token": {
3040
2943
  "env": "KNOCK_SERVICE_TOKEN",
3041
2944
  "name": "service-token",
@@ -3055,52 +2958,42 @@
3055
2958
  },
3056
2959
  "environment": {
3057
2960
  "name": "environment",
3058
- "summary": "Pushing a translation is only allowed in the development environment",
2961
+ "summary": "The environment to use.",
3059
2962
  "default": "development",
3060
2963
  "hasDynamicHelp": false,
3061
2964
  "multiple": false,
3062
- "options": [
3063
- "development"
3064
- ],
3065
2965
  "type": "option"
3066
2966
  },
3067
2967
  "branch": {
3068
- "hidden": true,
3069
2968
  "name": "branch",
3070
2969
  "summary": "The slug of the branch to use.",
3071
2970
  "hasDynamicHelp": false,
3072
2971
  "multiple": false,
3073
2972
  "type": "option"
3074
2973
  },
3075
- "all": {
3076
- "name": "all",
3077
- "summary": "Whether to push all translations from the target directory.",
2974
+ "hide-uncommitted-changes": {
2975
+ "name": "hide-uncommitted-changes",
2976
+ "summary": "Hide any uncommitted changes.",
3078
2977
  "allowNo": false,
3079
2978
  "type": "boolean"
3080
2979
  },
3081
- "translations-dir": {
3082
- "dependsOn": [
3083
- "all"
3084
- ],
3085
- "name": "translations-dir",
3086
- "summary": "The target directory path to find all translations to push.",
2980
+ "after": {
2981
+ "name": "after",
2982
+ "summary": "The cursor after which to fetch the next page.",
3087
2983
  "hasDynamicHelp": false,
3088
2984
  "multiple": false,
3089
2985
  "type": "option"
3090
2986
  },
3091
- "commit": {
3092
- "name": "commit",
3093
- "summary": "Push and commit the translation(s) at the same time",
3094
- "allowNo": false,
3095
- "type": "boolean"
2987
+ "before": {
2988
+ "name": "before",
2989
+ "summary": "The cursor before which to fetch the previous page.",
2990
+ "hasDynamicHelp": false,
2991
+ "multiple": false,
2992
+ "type": "option"
3096
2993
  },
3097
- "commit-message": {
3098
- "char": "m",
3099
- "dependsOn": [
3100
- "commit"
3101
- ],
3102
- "name": "commit-message",
3103
- "summary": "Use the given value as the commit message",
2994
+ "limit": {
2995
+ "name": "limit",
2996
+ "summary": "The total number of entries to fetch per page.",
3104
2997
  "hasDynamicHelp": false,
3105
2998
  "multiple": false,
3106
2999
  "type": "option"
@@ -3108,29 +3001,27 @@
3108
3001
  },
3109
3002
  "hasDynamicHelp": false,
3110
3003
  "hiddenAliases": [],
3111
- "id": "translation:push",
3004
+ "id": "workflow:list",
3112
3005
  "pluginAlias": "@knocklabs/cli",
3113
3006
  "pluginName": "@knocklabs/cli",
3114
3007
  "pluginType": "core",
3115
3008
  "strict": true,
3116
- "summary": "Push one or more translations from a local file system to Knock.",
3117
- "enableJsonFlag": false,
3118
- "verifyFeatureEnabled": "translations",
3009
+ "summary": "Display all workflows for an environment.",
3010
+ "enableJsonFlag": true,
3119
3011
  "isESM": false,
3120
3012
  "relativePath": [
3121
3013
  "dist",
3122
3014
  "commands",
3123
- "translation",
3124
- "push.js"
3015
+ "workflow",
3016
+ "list.js"
3125
3017
  ]
3126
3018
  },
3127
- "translation:validate": {
3019
+ "workflow:new": {
3128
3020
  "aliases": [],
3129
3021
  "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",
3133
- "required": false
3022
+ "workflowKey": {
3023
+ "name": "workflowKey",
3024
+ "required": true
3134
3025
  }
3135
3026
  },
3136
3027
  "flags": {
@@ -3151,69 +3042,54 @@
3151
3042
  "multiple": false,
3152
3043
  "type": "option"
3153
3044
  },
3154
- "environment": {
3155
- "name": "environment",
3156
- "summary": "Validating a translation is only done in the development environment",
3157
- "default": "development",
3158
- "hasDynamicHelp": false,
3159
- "multiple": false,
3160
- "options": [
3161
- "development"
3045
+ "steps": {
3046
+ "aliases": [
3047
+ "step"
3162
3048
  ],
3163
- "type": "option"
3164
- },
3165
- "branch": {
3166
- "hidden": true,
3167
- "name": "branch",
3168
- "summary": "The slug of the branch to use.",
3049
+ "name": "steps",
3169
3050
  "hasDynamicHelp": false,
3170
3051
  "multiple": false,
3171
3052
  "type": "option"
3172
3053
  },
3173
- "all": {
3174
- "name": "all",
3175
- "summary": "Whether to validate all translations from the target directory.",
3054
+ "force": {
3055
+ "name": "force",
3176
3056
  "allowNo": false,
3177
3057
  "type": "boolean"
3178
3058
  },
3179
- "translations-dir": {
3180
- "dependsOn": [
3181
- "all"
3182
- ],
3183
- "name": "translations-dir",
3184
- "summary": "The target directory path to find all translations to validate.",
3059
+ "environment": {
3060
+ "hidden": true,
3061
+ "name": "environment",
3062
+ "default": "development",
3185
3063
  "hasDynamicHelp": false,
3186
3064
  "multiple": false,
3187
3065
  "type": "option"
3188
3066
  }
3189
3067
  },
3190
3068
  "hasDynamicHelp": false,
3069
+ "hidden": true,
3191
3070
  "hiddenAliases": [],
3192
- "id": "translation:validate",
3071
+ "id": "workflow:new",
3193
3072
  "pluginAlias": "@knocklabs/cli",
3194
3073
  "pluginName": "@knocklabs/cli",
3195
3074
  "pluginType": "core",
3196
3075
  "strict": true,
3197
- "summary": "Validate one or more translations from a local file system.",
3198
3076
  "enableJsonFlag": false,
3199
- "verifyFeatureEnabled": "translations",
3200
3077
  "isESM": false,
3201
3078
  "relativePath": [
3202
3079
  "dist",
3203
3080
  "commands",
3204
- "translation",
3205
- "validate.js"
3081
+ "workflow",
3082
+ "new.js"
3206
3083
  ]
3207
3084
  },
3208
- "workflow:activate": {
3085
+ "workflow:pull": {
3209
3086
  "aliases": [],
3210
3087
  "args": {
3211
3088
  "workflowKey": {
3212
3089
  "name": "workflowKey",
3213
- "required": true
3090
+ "required": false
3214
3091
  }
3215
3092
  },
3216
- "description": "This immediately enables or disables a workflow in a given environment without\nneeding to go through environment promotion.\n\nBy default, this command activates a given workflow. Pass in the --status flag\nwith `false` in order to deactivate it.",
3217
3093
  "flags": {
3218
3094
  "service-token": {
3219
3095
  "env": "KNOCK_SERVICE_TOKEN",
@@ -3234,32 +3110,41 @@
3234
3110
  },
3235
3111
  "environment": {
3236
3112
  "name": "environment",
3237
- "required": true,
3238
3113
  "summary": "The environment to use.",
3114
+ "default": "development",
3239
3115
  "hasDynamicHelp": false,
3240
3116
  "multiple": false,
3241
3117
  "type": "option"
3242
3118
  },
3243
3119
  "branch": {
3244
- "hidden": true,
3245
3120
  "name": "branch",
3246
3121
  "summary": "The slug of the branch to use.",
3247
3122
  "hasDynamicHelp": false,
3248
3123
  "multiple": false,
3249
3124
  "type": "option"
3250
3125
  },
3251
- "status": {
3252
- "name": "status",
3253
- "summary": "The workflow active status to set.",
3254
- "default": true,
3126
+ "all": {
3127
+ "name": "all",
3128
+ "summary": "Whether to pull all workflows from the specified environment.",
3129
+ "allowNo": false,
3130
+ "type": "boolean"
3131
+ },
3132
+ "workflows-dir": {
3133
+ "dependsOn": [
3134
+ "all"
3135
+ ],
3136
+ "name": "workflows-dir",
3137
+ "summary": "The target directory path to pull all workflows into.",
3255
3138
  "hasDynamicHelp": false,
3256
3139
  "multiple": false,
3257
- "options": [
3258
- "true",
3259
- "false"
3260
- ],
3261
3140
  "type": "option"
3262
3141
  },
3142
+ "hide-uncommitted-changes": {
3143
+ "name": "hide-uncommitted-changes",
3144
+ "summary": "Hide any uncommitted changes.",
3145
+ "allowNo": false,
3146
+ "type": "boolean"
3147
+ },
3263
3148
  "force": {
3264
3149
  "name": "force",
3265
3150
  "summary": "Remove the confirmation prompt.",
@@ -3269,25 +3154,29 @@
3269
3154
  },
3270
3155
  "hasDynamicHelp": false,
3271
3156
  "hiddenAliases": [],
3272
- "id": "workflow:activate",
3157
+ "id": "workflow:pull",
3273
3158
  "pluginAlias": "@knocklabs/cli",
3274
3159
  "pluginName": "@knocklabs/cli",
3275
3160
  "pluginType": "core",
3276
3161
  "strict": true,
3277
- "summary": "Activate or deactivate a workflow in a given environment.",
3162
+ "summary": "Pull one or more workflows from an environment into a local file system.",
3278
3163
  "enableJsonFlag": false,
3279
3164
  "isESM": false,
3280
3165
  "relativePath": [
3281
3166
  "dist",
3282
3167
  "commands",
3283
3168
  "workflow",
3284
- "activate.js"
3169
+ "pull.js"
3285
3170
  ]
3286
3171
  },
3287
- "workflow:generate-types": {
3172
+ "workflow:push": {
3288
3173
  "aliases": [],
3289
- "args": {},
3290
- "description": "Generate types for all workflows in an environment and write them to a file.",
3174
+ "args": {
3175
+ "workflowKey": {
3176
+ "name": "workflowKey",
3177
+ "required": false
3178
+ }
3179
+ },
3291
3180
  "flags": {
3292
3181
  "service-token": {
3293
3182
  "env": "KNOCK_SERVICE_TOKEN",
@@ -3308,24 +3197,48 @@
3308
3197
  },
3309
3198
  "environment": {
3310
3199
  "name": "environment",
3311
- "summary": "Select the environment to generate types for.",
3200
+ "summary": "The environment to push the workflow to. Defaults to development.",
3312
3201
  "default": "development",
3313
3202
  "hasDynamicHelp": false,
3314
3203
  "multiple": false,
3315
3204
  "type": "option"
3316
3205
  },
3317
3206
  "branch": {
3318
- "hidden": true,
3319
3207
  "name": "branch",
3320
3208
  "summary": "The slug of the branch to use.",
3321
3209
  "hasDynamicHelp": false,
3322
3210
  "multiple": false,
3323
3211
  "type": "option"
3324
3212
  },
3325
- "output-file": {
3326
- "name": "output-file",
3327
- "required": true,
3328
- "summary": "The output file to write the generated types to. We currently support .ts, .rb, .go, .py files only. Your file extension will determine the target language for the generated types.",
3213
+ "all": {
3214
+ "name": "all",
3215
+ "summary": "Whether to push all workflows from the target directory.",
3216
+ "allowNo": false,
3217
+ "type": "boolean"
3218
+ },
3219
+ "workflows-dir": {
3220
+ "dependsOn": [
3221
+ "all"
3222
+ ],
3223
+ "name": "workflows-dir",
3224
+ "summary": "The target directory path to find all workflows to push.",
3225
+ "hasDynamicHelp": false,
3226
+ "multiple": false,
3227
+ "type": "option"
3228
+ },
3229
+ "commit": {
3230
+ "name": "commit",
3231
+ "summary": "Push and commit the workflow(s) at the same time",
3232
+ "allowNo": false,
3233
+ "type": "boolean"
3234
+ },
3235
+ "commit-message": {
3236
+ "char": "m",
3237
+ "dependsOn": [
3238
+ "commit"
3239
+ ],
3240
+ "name": "commit-message",
3241
+ "summary": "Use the given value as the commit message",
3329
3242
  "hasDynamicHelp": false,
3330
3243
  "multiple": false,
3331
3244
  "type": "option"
@@ -3333,21 +3246,22 @@
3333
3246
  },
3334
3247
  "hasDynamicHelp": false,
3335
3248
  "hiddenAliases": [],
3336
- "id": "workflow:generate-types",
3249
+ "id": "workflow:push",
3337
3250
  "pluginAlias": "@knocklabs/cli",
3338
3251
  "pluginName": "@knocklabs/cli",
3339
3252
  "pluginType": "core",
3340
3253
  "strict": true,
3254
+ "summary": "Push one or more workflows from a local file system to Knock.",
3341
3255
  "enableJsonFlag": false,
3342
3256
  "isESM": false,
3343
3257
  "relativePath": [
3344
3258
  "dist",
3345
3259
  "commands",
3346
3260
  "workflow",
3347
- "generate-types.js"
3261
+ "push.js"
3348
3262
  ]
3349
3263
  },
3350
- "workflow:get": {
3264
+ "workflow:run": {
3351
3265
  "aliases": [],
3352
3266
  "args": {
3353
3267
  "workflowKey": {
@@ -3356,13 +3270,6 @@
3356
3270
  }
3357
3271
  },
3358
3272
  "flags": {
3359
- "json": {
3360
- "description": "Format output as json.",
3361
- "helpGroup": "GLOBAL",
3362
- "name": "json",
3363
- "allowNo": false,
3364
- "type": "boolean"
3365
- },
3366
3273
  "service-token": {
3367
3274
  "env": "KNOCK_SERVICE_TOKEN",
3368
3275
  "name": "service-token",
@@ -3382,55 +3289,78 @@
3382
3289
  },
3383
3290
  "environment": {
3384
3291
  "name": "environment",
3385
- "summary": "The environment to use.",
3292
+ "summary": "The environment in which to run the workflow",
3386
3293
  "default": "development",
3387
3294
  "hasDynamicHelp": false,
3388
3295
  "multiple": false,
3389
3296
  "type": "option"
3390
3297
  },
3391
3298
  "branch": {
3392
- "hidden": true,
3393
3299
  "name": "branch",
3394
3300
  "summary": "The slug of the branch to use.",
3395
3301
  "hasDynamicHelp": false,
3396
3302
  "multiple": false,
3397
3303
  "type": "option"
3398
3304
  },
3399
- "hide-uncommitted-changes": {
3400
- "name": "hide-uncommitted-changes",
3401
- "summary": "Hide any uncommitted changes.",
3402
- "allowNo": false,
3403
- "type": "boolean"
3305
+ "recipients": {
3306
+ "aliases": [
3307
+ "recipient"
3308
+ ],
3309
+ "name": "recipients",
3310
+ "required": true,
3311
+ "summary": "One or more recipient user ids separated by comma, or a JSON string containing one or more recipient object references for this workflow run.",
3312
+ "hasDynamicHelp": false,
3313
+ "multiple": false,
3314
+ "type": "option"
3315
+ },
3316
+ "actor": {
3317
+ "name": "actor",
3318
+ "summary": "An actor id, or a JSON string of an actor object reference for the workflow run.",
3319
+ "hasDynamicHelp": false,
3320
+ "multiple": false,
3321
+ "type": "option"
3322
+ },
3323
+ "tenant": {
3324
+ "name": "tenant",
3325
+ "summary": "A tenant id for the workflow run.",
3326
+ "hasDynamicHelp": false,
3327
+ "multiple": false,
3328
+ "type": "option"
3329
+ },
3330
+ "data": {
3331
+ "name": "data",
3332
+ "summary": "A JSON string of the data for this workflow",
3333
+ "hasDynamicHelp": false,
3334
+ "multiple": false,
3335
+ "type": "option"
3404
3336
  }
3405
3337
  },
3406
3338
  "hasDynamicHelp": false,
3407
3339
  "hiddenAliases": [],
3408
- "id": "workflow:get",
3340
+ "id": "workflow:run",
3409
3341
  "pluginAlias": "@knocklabs/cli",
3410
3342
  "pluginName": "@knocklabs/cli",
3411
3343
  "pluginType": "core",
3412
3344
  "strict": true,
3413
- "summary": "Display a single workflow from an environment.",
3414
- "enableJsonFlag": true,
3345
+ "summary": "Test run a workflow using the latest version from Knock.",
3346
+ "enableJsonFlag": false,
3415
3347
  "isESM": false,
3416
3348
  "relativePath": [
3417
3349
  "dist",
3418
3350
  "commands",
3419
3351
  "workflow",
3420
- "get.js"
3352
+ "run.js"
3421
3353
  ]
3422
3354
  },
3423
- "workflow:list": {
3355
+ "workflow:validate": {
3424
3356
  "aliases": [],
3425
- "args": {},
3357
+ "args": {
3358
+ "workflowKey": {
3359
+ "name": "workflowKey",
3360
+ "required": false
3361
+ }
3362
+ },
3426
3363
  "flags": {
3427
- "json": {
3428
- "description": "Format output as json.",
3429
- "helpGroup": "GLOBAL",
3430
- "name": "json",
3431
- "allowNo": false,
3432
- "type": "boolean"
3433
- },
3434
3364
  "service-token": {
3435
3365
  "env": "KNOCK_SERVICE_TOKEN",
3436
3366
  "name": "service-token",
@@ -3450,43 +3380,31 @@
3450
3380
  },
3451
3381
  "environment": {
3452
3382
  "name": "environment",
3453
- "summary": "The environment to use.",
3383
+ "summary": "The environment to validate the workflow in. Defaults to development.",
3454
3384
  "default": "development",
3455
3385
  "hasDynamicHelp": false,
3456
3386
  "multiple": false,
3457
3387
  "type": "option"
3458
3388
  },
3459
3389
  "branch": {
3460
- "hidden": true,
3461
3390
  "name": "branch",
3462
3391
  "summary": "The slug of the branch to use.",
3463
3392
  "hasDynamicHelp": false,
3464
3393
  "multiple": false,
3465
3394
  "type": "option"
3466
3395
  },
3467
- "hide-uncommitted-changes": {
3468
- "name": "hide-uncommitted-changes",
3469
- "summary": "Hide any uncommitted changes.",
3396
+ "all": {
3397
+ "name": "all",
3398
+ "summary": "Whether to validate all workflows from the target directory.",
3470
3399
  "allowNo": false,
3471
3400
  "type": "boolean"
3472
3401
  },
3473
- "after": {
3474
- "name": "after",
3475
- "summary": "The cursor after which to fetch the next page.",
3476
- "hasDynamicHelp": false,
3477
- "multiple": false,
3478
- "type": "option"
3479
- },
3480
- "before": {
3481
- "name": "before",
3482
- "summary": "The cursor before which to fetch the previous page.",
3483
- "hasDynamicHelp": false,
3484
- "multiple": false,
3485
- "type": "option"
3486
- },
3487
- "limit": {
3488
- "name": "limit",
3489
- "summary": "The total number of entries to fetch per page.",
3402
+ "workflows-dir": {
3403
+ "dependsOn": [
3404
+ "all"
3405
+ ],
3406
+ "name": "workflows-dir",
3407
+ "summary": "The target directory path to find all workflows to validate.",
3490
3408
  "hasDynamicHelp": false,
3491
3409
  "multiple": false,
3492
3410
  "type": "option"
@@ -3494,30 +3412,38 @@
3494
3412
  },
3495
3413
  "hasDynamicHelp": false,
3496
3414
  "hiddenAliases": [],
3497
- "id": "workflow:list",
3415
+ "id": "workflow:validate",
3498
3416
  "pluginAlias": "@knocklabs/cli",
3499
3417
  "pluginName": "@knocklabs/cli",
3500
3418
  "pluginType": "core",
3501
3419
  "strict": true,
3502
- "summary": "Display all workflows for an environment.",
3503
- "enableJsonFlag": true,
3420
+ "summary": "Validate one or more workflows from a local file system.",
3421
+ "enableJsonFlag": false,
3504
3422
  "isESM": false,
3505
3423
  "relativePath": [
3506
3424
  "dist",
3507
3425
  "commands",
3508
3426
  "workflow",
3509
- "list.js"
3427
+ "validate.js"
3510
3428
  ]
3511
3429
  },
3512
- "workflow:new": {
3430
+ "translation:get": {
3513
3431
  "aliases": [],
3514
3432
  "args": {
3515
- "workflowKey": {
3516
- "name": "workflowKey",
3433
+ "translationRef": {
3434
+ "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`.",
3435
+ "name": "translationRef",
3517
3436
  "required": true
3518
3437
  }
3519
3438
  },
3520
3439
  "flags": {
3440
+ "json": {
3441
+ "description": "Format output as json.",
3442
+ "helpGroup": "GLOBAL",
3443
+ "name": "json",
3444
+ "allowNo": false,
3445
+ "type": "boolean"
3446
+ },
3521
3447
  "service-token": {
3522
3448
  "env": "KNOCK_SERVICE_TOKEN",
3523
3449
  "name": "service-token",
@@ -3535,55 +3461,69 @@
3535
3461
  "multiple": false,
3536
3462
  "type": "option"
3537
3463
  },
3538
- "steps": {
3539
- "aliases": [
3540
- "step"
3541
- ],
3542
- "name": "steps",
3464
+ "environment": {
3465
+ "name": "environment",
3466
+ "summary": "The environment to use.",
3467
+ "default": "development",
3468
+ "hasDynamicHelp": false,
3469
+ "multiple": false,
3470
+ "type": "option"
3471
+ },
3472
+ "branch": {
3473
+ "name": "branch",
3474
+ "summary": "The slug of the branch to use.",
3543
3475
  "hasDynamicHelp": false,
3544
3476
  "multiple": false,
3545
3477
  "type": "option"
3546
3478
  },
3547
- "force": {
3548
- "name": "force",
3479
+ "hide-uncommitted-changes": {
3480
+ "name": "hide-uncommitted-changes",
3481
+ "summary": "Hide any uncommitted changes.",
3549
3482
  "allowNo": false,
3550
3483
  "type": "boolean"
3551
3484
  },
3552
- "environment": {
3553
- "hidden": true,
3554
- "name": "environment",
3555
- "default": "development",
3485
+ "format": {
3486
+ "name": "format",
3487
+ "summary": "Specify the output format of the returned translations.",
3488
+ "default": "json",
3556
3489
  "hasDynamicHelp": false,
3557
3490
  "multiple": false,
3491
+ "options": [
3492
+ "json",
3493
+ "po"
3494
+ ],
3558
3495
  "type": "option"
3559
3496
  }
3560
3497
  },
3561
3498
  "hasDynamicHelp": false,
3562
- "hidden": true,
3563
3499
  "hiddenAliases": [],
3564
- "id": "workflow:new",
3500
+ "id": "translation:get",
3565
3501
  "pluginAlias": "@knocklabs/cli",
3566
3502
  "pluginName": "@knocklabs/cli",
3567
3503
  "pluginType": "core",
3568
3504
  "strict": true,
3569
- "enableJsonFlag": false,
3505
+ "summary": "Display a single translation from an environment.",
3506
+ "enableJsonFlag": true,
3507
+ "verifyFeatureEnabled": "translations",
3570
3508
  "isESM": false,
3571
3509
  "relativePath": [
3572
3510
  "dist",
3573
3511
  "commands",
3574
- "workflow",
3575
- "new.js"
3512
+ "translation",
3513
+ "get.js"
3576
3514
  ]
3577
3515
  },
3578
- "workflow:pull": {
3516
+ "translation:list": {
3579
3517
  "aliases": [],
3580
- "args": {
3581
- "workflowKey": {
3582
- "name": "workflowKey",
3583
- "required": false
3584
- }
3585
- },
3518
+ "args": {},
3586
3519
  "flags": {
3520
+ "json": {
3521
+ "description": "Format output as json.",
3522
+ "helpGroup": "GLOBAL",
3523
+ "name": "json",
3524
+ "allowNo": false,
3525
+ "type": "boolean"
3526
+ },
3587
3527
  "service-token": {
3588
3528
  "env": "KNOCK_SERVICE_TOKEN",
3589
3529
  "name": "service-token",
@@ -3610,64 +3550,64 @@
3610
3550
  "type": "option"
3611
3551
  },
3612
3552
  "branch": {
3613
- "hidden": true,
3614
3553
  "name": "branch",
3615
3554
  "summary": "The slug of the branch to use.",
3616
3555
  "hasDynamicHelp": false,
3617
3556
  "multiple": false,
3618
3557
  "type": "option"
3619
3558
  },
3620
- "all": {
3621
- "name": "all",
3622
- "summary": "Whether to pull all workflows from the specified environment.",
3559
+ "hide-uncommitted-changes": {
3560
+ "name": "hide-uncommitted-changes",
3561
+ "summary": "Hide any uncommitted changes.",
3623
3562
  "allowNo": false,
3624
3563
  "type": "boolean"
3625
3564
  },
3626
- "workflows-dir": {
3627
- "dependsOn": [
3628
- "all"
3629
- ],
3630
- "name": "workflows-dir",
3631
- "summary": "The target directory path to pull all workflows into.",
3565
+ "after": {
3566
+ "name": "after",
3567
+ "summary": "The cursor after which to fetch the next page.",
3632
3568
  "hasDynamicHelp": false,
3633
3569
  "multiple": false,
3634
3570
  "type": "option"
3635
3571
  },
3636
- "hide-uncommitted-changes": {
3637
- "name": "hide-uncommitted-changes",
3638
- "summary": "Hide any uncommitted changes.",
3639
- "allowNo": false,
3640
- "type": "boolean"
3572
+ "before": {
3573
+ "name": "before",
3574
+ "summary": "The cursor before which to fetch the previous page.",
3575
+ "hasDynamicHelp": false,
3576
+ "multiple": false,
3577
+ "type": "option"
3641
3578
  },
3642
- "force": {
3643
- "name": "force",
3644
- "summary": "Remove the confirmation prompt.",
3645
- "allowNo": false,
3646
- "type": "boolean"
3579
+ "limit": {
3580
+ "name": "limit",
3581
+ "summary": "The total number of entries to fetch per page.",
3582
+ "hasDynamicHelp": false,
3583
+ "multiple": false,
3584
+ "type": "option"
3647
3585
  }
3648
3586
  },
3649
3587
  "hasDynamicHelp": false,
3650
3588
  "hiddenAliases": [],
3651
- "id": "workflow:pull",
3589
+ "id": "translation:list",
3652
3590
  "pluginAlias": "@knocklabs/cli",
3653
3591
  "pluginName": "@knocklabs/cli",
3654
3592
  "pluginType": "core",
3655
3593
  "strict": true,
3656
- "summary": "Pull one or more workflows from an environment into a local file system.",
3657
- "enableJsonFlag": false,
3594
+ "summary": "Display all translations for an environment.",
3595
+ "enableJsonFlag": true,
3596
+ "verifyFeatureEnabled": "translations",
3658
3597
  "isESM": false,
3659
3598
  "relativePath": [
3660
3599
  "dist",
3661
3600
  "commands",
3662
- "workflow",
3663
- "pull.js"
3601
+ "translation",
3602
+ "list.js"
3664
3603
  ]
3665
3604
  },
3666
- "workflow:push": {
3605
+ "translation:pull": {
3667
3606
  "aliases": [],
3668
3607
  "args": {
3669
- "workflowKey": {
3670
- "name": "workflowKey",
3608
+ "translationRef": {
3609
+ "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`.",
3610
+ "name": "translationRef",
3671
3611
  "required": false
3672
3612
  }
3673
3613
  },
@@ -3691,14 +3631,13 @@
3691
3631
  },
3692
3632
  "environment": {
3693
3633
  "name": "environment",
3694
- "summary": "The environment to push the workflow to. Defaults to development.",
3634
+ "summary": "The environment to use.",
3695
3635
  "default": "development",
3696
3636
  "hasDynamicHelp": false,
3697
3637
  "multiple": false,
3698
3638
  "type": "option"
3699
3639
  },
3700
3640
  "branch": {
3701
- "hidden": true,
3702
3641
  "name": "branch",
3703
3642
  "summary": "The slug of the branch to use.",
3704
3643
  "hasDynamicHelp": false,
@@ -3707,61 +3646,70 @@
3707
3646
  },
3708
3647
  "all": {
3709
3648
  "name": "all",
3710
- "summary": "Whether to push all workflows from the target directory.",
3649
+ "summary": "Whether to pull all translations from the specified environment.",
3711
3650
  "allowNo": false,
3712
3651
  "type": "boolean"
3713
3652
  },
3714
- "workflows-dir": {
3653
+ "translations-dir": {
3715
3654
  "dependsOn": [
3716
3655
  "all"
3717
3656
  ],
3718
- "name": "workflows-dir",
3719
- "summary": "The target directory path to find all workflows to push.",
3657
+ "name": "translations-dir",
3658
+ "summary": "The target directory path to pull all translations into.",
3720
3659
  "hasDynamicHelp": false,
3721
3660
  "multiple": false,
3722
3661
  "type": "option"
3723
3662
  },
3724
- "commit": {
3725
- "name": "commit",
3726
- "summary": "Push and commit the workflow(s) at the same time",
3663
+ "hide-uncommitted-changes": {
3664
+ "name": "hide-uncommitted-changes",
3665
+ "summary": "Hide any uncommitted changes.",
3727
3666
  "allowNo": false,
3728
3667
  "type": "boolean"
3729
3668
  },
3730
- "commit-message": {
3731
- "char": "m",
3732
- "dependsOn": [
3733
- "commit"
3734
- ],
3735
- "name": "commit-message",
3736
- "summary": "Use the given value as the commit message",
3669
+ "force": {
3670
+ "name": "force",
3671
+ "summary": "Remove the confirmation prompt.",
3672
+ "allowNo": false,
3673
+ "type": "boolean"
3674
+ },
3675
+ "format": {
3676
+ "name": "format",
3677
+ "summary": "Specify the output format of the returned translations.",
3678
+ "default": "json",
3737
3679
  "hasDynamicHelp": false,
3738
3680
  "multiple": false,
3681
+ "options": [
3682
+ "json",
3683
+ "po"
3684
+ ],
3739
3685
  "type": "option"
3740
3686
  }
3741
3687
  },
3742
3688
  "hasDynamicHelp": false,
3743
3689
  "hiddenAliases": [],
3744
- "id": "workflow:push",
3690
+ "id": "translation:pull",
3745
3691
  "pluginAlias": "@knocklabs/cli",
3746
3692
  "pluginName": "@knocklabs/cli",
3747
3693
  "pluginType": "core",
3748
3694
  "strict": true,
3749
- "summary": "Push one or more workflows from a local file system to Knock.",
3695
+ "summary": "Pull one or more translations from an environment into a local file system.",
3750
3696
  "enableJsonFlag": false,
3697
+ "verifyFeatureEnabled": "translations",
3751
3698
  "isESM": false,
3752
3699
  "relativePath": [
3753
3700
  "dist",
3754
3701
  "commands",
3755
- "workflow",
3756
- "push.js"
3702
+ "translation",
3703
+ "pull.js"
3757
3704
  ]
3758
3705
  },
3759
- "workflow:run": {
3706
+ "translation:push": {
3760
3707
  "aliases": [],
3761
3708
  "args": {
3762
- "workflowKey": {
3763
- "name": "workflowKey",
3764
- "required": true
3709
+ "translationRef": {
3710
+ "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`.",
3711
+ "name": "translationRef",
3712
+ "required": false
3765
3713
  }
3766
3714
  },
3767
3715
  "flags": {
@@ -3784,48 +3732,51 @@
3784
3732
  },
3785
3733
  "environment": {
3786
3734
  "name": "environment",
3787
- "summary": "The environment in which to run the workflow",
3735
+ "summary": "Pushing a translation is only allowed in the development environment",
3788
3736
  "default": "development",
3789
3737
  "hasDynamicHelp": false,
3790
3738
  "multiple": false,
3739
+ "options": [
3740
+ "development"
3741
+ ],
3791
3742
  "type": "option"
3792
3743
  },
3793
3744
  "branch": {
3794
- "hidden": true,
3795
3745
  "name": "branch",
3796
3746
  "summary": "The slug of the branch to use.",
3797
3747
  "hasDynamicHelp": false,
3798
3748
  "multiple": false,
3799
3749
  "type": "option"
3800
3750
  },
3801
- "recipients": {
3802
- "aliases": [
3803
- "recipient"
3804
- ],
3805
- "name": "recipients",
3806
- "required": true,
3807
- "summary": "One or more recipient user ids separated by comma, or a JSON string containing one or more recipient object references for this workflow run.",
3808
- "hasDynamicHelp": false,
3809
- "multiple": false,
3810
- "type": "option"
3751
+ "all": {
3752
+ "name": "all",
3753
+ "summary": "Whether to push all translations from the target directory.",
3754
+ "allowNo": false,
3755
+ "type": "boolean"
3811
3756
  },
3812
- "actor": {
3813
- "name": "actor",
3814
- "summary": "An actor id, or a JSON string of an actor object reference for the workflow run.",
3757
+ "translations-dir": {
3758
+ "dependsOn": [
3759
+ "all"
3760
+ ],
3761
+ "name": "translations-dir",
3762
+ "summary": "The target directory path to find all translations to push.",
3815
3763
  "hasDynamicHelp": false,
3816
3764
  "multiple": false,
3817
3765
  "type": "option"
3818
3766
  },
3819
- "tenant": {
3820
- "name": "tenant",
3821
- "summary": "A tenant id for the workflow run.",
3822
- "hasDynamicHelp": false,
3823
- "multiple": false,
3824
- "type": "option"
3767
+ "commit": {
3768
+ "name": "commit",
3769
+ "summary": "Push and commit the translation(s) at the same time",
3770
+ "allowNo": false,
3771
+ "type": "boolean"
3825
3772
  },
3826
- "data": {
3827
- "name": "data",
3828
- "summary": "A JSON string of the data for this workflow",
3773
+ "commit-message": {
3774
+ "char": "m",
3775
+ "dependsOn": [
3776
+ "commit"
3777
+ ],
3778
+ "name": "commit-message",
3779
+ "summary": "Use the given value as the commit message",
3829
3780
  "hasDynamicHelp": false,
3830
3781
  "multiple": false,
3831
3782
  "type": "option"
@@ -3833,26 +3784,28 @@
3833
3784
  },
3834
3785
  "hasDynamicHelp": false,
3835
3786
  "hiddenAliases": [],
3836
- "id": "workflow:run",
3787
+ "id": "translation:push",
3837
3788
  "pluginAlias": "@knocklabs/cli",
3838
3789
  "pluginName": "@knocklabs/cli",
3839
3790
  "pluginType": "core",
3840
3791
  "strict": true,
3841
- "summary": "Test run a workflow using the latest version from Knock.",
3792
+ "summary": "Push one or more translations from a local file system to Knock.",
3842
3793
  "enableJsonFlag": false,
3794
+ "verifyFeatureEnabled": "translations",
3843
3795
  "isESM": false,
3844
3796
  "relativePath": [
3845
3797
  "dist",
3846
3798
  "commands",
3847
- "workflow",
3848
- "run.js"
3799
+ "translation",
3800
+ "push.js"
3849
3801
  ]
3850
3802
  },
3851
- "workflow:validate": {
3803
+ "translation:validate": {
3852
3804
  "aliases": [],
3853
3805
  "args": {
3854
- "workflowKey": {
3855
- "name": "workflowKey",
3806
+ "translationRef": {
3807
+ "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`.",
3808
+ "name": "translationRef",
3856
3809
  "required": false
3857
3810
  }
3858
3811
  },
@@ -3876,14 +3829,16 @@
3876
3829
  },
3877
3830
  "environment": {
3878
3831
  "name": "environment",
3879
- "summary": "The environment to validate the workflow in. Defaults to development.",
3832
+ "summary": "Validating a translation is only done in the development environment",
3880
3833
  "default": "development",
3881
3834
  "hasDynamicHelp": false,
3882
3835
  "multiple": false,
3836
+ "options": [
3837
+ "development"
3838
+ ],
3883
3839
  "type": "option"
3884
3840
  },
3885
3841
  "branch": {
3886
- "hidden": true,
3887
3842
  "name": "branch",
3888
3843
  "summary": "The slug of the branch to use.",
3889
3844
  "hasDynamicHelp": false,
@@ -3892,16 +3847,16 @@
3892
3847
  },
3893
3848
  "all": {
3894
3849
  "name": "all",
3895
- "summary": "Whether to validate all workflows from the target directory.",
3850
+ "summary": "Whether to validate all translations from the target directory.",
3896
3851
  "allowNo": false,
3897
3852
  "type": "boolean"
3898
3853
  },
3899
- "workflows-dir": {
3854
+ "translations-dir": {
3900
3855
  "dependsOn": [
3901
3856
  "all"
3902
3857
  ],
3903
- "name": "workflows-dir",
3904
- "summary": "The target directory path to find all workflows to validate.",
3858
+ "name": "translations-dir",
3859
+ "summary": "The target directory path to find all translations to validate.",
3905
3860
  "hasDynamicHelp": false,
3906
3861
  "multiple": false,
3907
3862
  "type": "option"
@@ -3909,21 +3864,22 @@
3909
3864
  },
3910
3865
  "hasDynamicHelp": false,
3911
3866
  "hiddenAliases": [],
3912
- "id": "workflow:validate",
3867
+ "id": "translation:validate",
3913
3868
  "pluginAlias": "@knocklabs/cli",
3914
3869
  "pluginName": "@knocklabs/cli",
3915
3870
  "pluginType": "core",
3916
3871
  "strict": true,
3917
- "summary": "Validate one or more workflows from a local file system.",
3872
+ "summary": "Validate one or more translations from a local file system.",
3918
3873
  "enableJsonFlag": false,
3874
+ "verifyFeatureEnabled": "translations",
3919
3875
  "isESM": false,
3920
3876
  "relativePath": [
3921
3877
  "dist",
3922
3878
  "commands",
3923
- "workflow",
3879
+ "translation",
3924
3880
  "validate.js"
3925
3881
  ]
3926
3882
  }
3927
3883
  },
3928
- "version": "0.2.5"
3884
+ "version": "0.3.1"
3929
3885
  }