@salesforce/cli 2.75.0 → 2.75.2

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.
@@ -2660,1263 +2660,6 @@
2660
2660
  "validate.js"
2661
2661
  ]
2662
2662
  },
2663
- "env:display": {
2664
- "aliases": [],
2665
- "args": {},
2666
- "description": "Specify an environment with either the username you used when you logged into the environment with \"sf login\", or the alias you gave the environment when you created it. Run \"sf env list\" to view all your environments and their aliases.\n\nOutput depends on the type of environment.",
2667
- "examples": [
2668
- "Display details about the \"myEnv\" environment:\n<%- config.bin %> <%- command.id %> --target-env myEnv"
2669
- ],
2670
- "flags": {
2671
- "json": {
2672
- "description": "Format output as json.",
2673
- "helpGroup": "GLOBAL",
2674
- "name": "json",
2675
- "allowNo": false,
2676
- "type": "boolean"
2677
- },
2678
- "target-env": {
2679
- "char": "e",
2680
- "name": "target-env",
2681
- "summary": "Environment alias or login user.",
2682
- "hasDynamicHelp": false,
2683
- "multiple": false,
2684
- "type": "option"
2685
- }
2686
- },
2687
- "hasDynamicHelp": false,
2688
- "hiddenAliases": [],
2689
- "id": "env:display",
2690
- "pluginAlias": "@salesforce/plugin-env",
2691
- "pluginName": "@salesforce/plugin-env",
2692
- "pluginType": "jit",
2693
- "strict": true,
2694
- "summary": "Display details about an environment.",
2695
- "enableJsonFlag": true,
2696
- "SF_ENV": "SF_ENV",
2697
- "isESM": true,
2698
- "relativePath": [
2699
- "lib",
2700
- "commands",
2701
- "env",
2702
- "display.js"
2703
- ],
2704
- "aliasPermutations": [],
2705
- "permutations": [
2706
- "env:display",
2707
- "display:env"
2708
- ]
2709
- },
2710
- "env:list": {
2711
- "aliases": [],
2712
- "args": {},
2713
- "description": "By default, the command displays active environments.\n\nOutput is displayed in multiple tables, one for each environment type.\n\nThe compute environment table shows the alias, information about the connected orgs, the project name, and more.\n\nUse the table manipulation flags, such as --filter and --sort, to change how the data is displayed.\n\nRun \"sf env display\" to view details about a specific environment.",
2714
- "examples": [
2715
- "List all active environments:\n<%= config.bin %> <%= command.id %>",
2716
- "List both active and inactive environments:\n<%= config.bin %> <%= command.id %> --all",
2717
- "Don't truncate the displayed output and instead wrap text that's wider than your terminal:\n<%= config.bin %> <%= command.id %> --no-truncate",
2718
- "Display only the table data, not the headers, in comma-separated value (csv) format:\n<%= config.bin %> <%= command.id %> --csv --no-header"
2719
- ],
2720
- "flags": {
2721
- "json": {
2722
- "description": "Format output as json.",
2723
- "helpGroup": "GLOBAL",
2724
- "name": "json",
2725
- "allowNo": false,
2726
- "type": "boolean"
2727
- },
2728
- "all": {
2729
- "char": "a",
2730
- "name": "all",
2731
- "summary": "Show all environments, even inactive ones.",
2732
- "allowNo": false,
2733
- "type": "boolean"
2734
- },
2735
- "columns": {
2736
- "name": "columns",
2737
- "summary": "List of columns to display.",
2738
- "hasDynamicHelp": false,
2739
- "multiple": true,
2740
- "type": "option"
2741
- },
2742
- "csv": {
2743
- "name": "csv",
2744
- "summary": "Output in csv format [alias: --output=csv]",
2745
- "allowNo": false,
2746
- "type": "boolean"
2747
- },
2748
- "filter": {
2749
- "name": "filter",
2750
- "summary": "Filter property by partial string matching.",
2751
- "hasDynamicHelp": false,
2752
- "multiple": false,
2753
- "type": "option"
2754
- },
2755
- "no-header": {
2756
- "name": "no-header",
2757
- "summary": "Hide table header from output.",
2758
- "allowNo": false,
2759
- "type": "boolean"
2760
- },
2761
- "no-truncate": {
2762
- "name": "no-truncate",
2763
- "summary": "Don't truncate output to fit screen.",
2764
- "allowNo": false,
2765
- "type": "boolean"
2766
- },
2767
- "output": {
2768
- "name": "output",
2769
- "summary": "Format in which to display the output.",
2770
- "hasDynamicHelp": false,
2771
- "multiple": false,
2772
- "options": [
2773
- "csv",
2774
- "json",
2775
- "yaml"
2776
- ],
2777
- "type": "option"
2778
- },
2779
- "sort": {
2780
- "name": "sort",
2781
- "summary": "Column to sort by (prepend '-' for descending).",
2782
- "hasDynamicHelp": false,
2783
- "multiple": false,
2784
- "type": "option"
2785
- }
2786
- },
2787
- "hasDynamicHelp": false,
2788
- "hiddenAliases": [],
2789
- "id": "env:list",
2790
- "pluginAlias": "@salesforce/plugin-env",
2791
- "pluginName": "@salesforce/plugin-env",
2792
- "pluginType": "jit",
2793
- "strict": true,
2794
- "summary": "List the environments you’ve created or logged into.",
2795
- "enableJsonFlag": true,
2796
- "SF_ENV": "SF_ENV",
2797
- "isESM": true,
2798
- "relativePath": [
2799
- "lib",
2800
- "commands",
2801
- "env",
2802
- "list.js"
2803
- ],
2804
- "aliasPermutations": [],
2805
- "permutations": [
2806
- "env:list",
2807
- "list:env"
2808
- ]
2809
- },
2810
- "env:open": {
2811
- "aliases": [],
2812
- "args": {},
2813
- "description": "Each of your environments is associated with an instance URL, such as https://login.salesforce.com. To open a specific web page, specify the portion of the URL after \"<URL>/\" with the --path flag.",
2814
- "examples": [
2815
- "Open the compute environment with alias \"test-compute\":\n<%= config.bin %> <%= command.id %> --target-env test-compute",
2816
- "View the URL but don't launch it in a browser:\n<%= config.bin %> <%= command.id %> --target-env test-compute --url-only",
2817
- "Open the environment in the Google Chrome browser:\n<%= config.bin %> <%= command.id %> --target-env test-compute --url-only --browser chrome"
2818
- ],
2819
- "flags": {
2820
- "json": {
2821
- "description": "Format output as json.",
2822
- "helpGroup": "GLOBAL",
2823
- "name": "json",
2824
- "allowNo": false,
2825
- "type": "boolean"
2826
- },
2827
- "path": {
2828
- "char": "p",
2829
- "name": "path",
2830
- "summary": "Path to append to the end of the login URL.",
2831
- "hasDynamicHelp": false,
2832
- "multiple": false,
2833
- "type": "option"
2834
- },
2835
- "url-only": {
2836
- "char": "r",
2837
- "name": "url-only",
2838
- "summary": "Display the URL, but don’t launch it in a browser.",
2839
- "allowNo": false,
2840
- "type": "boolean"
2841
- },
2842
- "target-env": {
2843
- "char": "e",
2844
- "name": "target-env",
2845
- "summary": "Login user or alias of the environment to open.",
2846
- "hasDynamicHelp": false,
2847
- "multiple": false,
2848
- "type": "option"
2849
- },
2850
- "browser": {
2851
- "description": "You can specify that the environment open in one of the following browsers: Firefox, Safari, Google Chrome, or Windows Edge. If you don’t specify --browser, the environment opens in your default browser. The exact names of the browser applications differ depending on the operating system you're on; check your documentation for details.",
2852
- "name": "browser",
2853
- "summary": "Browser in which to open the environment.",
2854
- "hasDynamicHelp": false,
2855
- "multiple": false,
2856
- "type": "option"
2857
- }
2858
- },
2859
- "hasDynamicHelp": false,
2860
- "hiddenAliases": [],
2861
- "id": "env:open",
2862
- "pluginAlias": "@salesforce/plugin-env",
2863
- "pluginName": "@salesforce/plugin-env",
2864
- "pluginType": "jit",
2865
- "strict": true,
2866
- "summary": "Open an environment in a web browser.",
2867
- "enableJsonFlag": true,
2868
- "SF_ENV": "SF_ENV",
2869
- "isESM": true,
2870
- "relativePath": [
2871
- "lib",
2872
- "commands",
2873
- "env",
2874
- "open.js"
2875
- ],
2876
- "aliasPermutations": [],
2877
- "permutations": [
2878
- "env:open",
2879
- "open:env"
2880
- ]
2881
- },
2882
- "deploy:functions": {
2883
- "id": "deploy:functions",
2884
- "summary": "Deploy a Salesforce Function to an org from your local project.",
2885
- "description": "You must run this command from within a git repository. Only committed changes to Functions are deployed. The active branch is deployed unless specified otherwise with `--branch`.",
2886
- "strict": true,
2887
- "pluginName": "@salesforce/plugin-functions",
2888
- "pluginAlias": "@salesforce/plugin-functions",
2889
- "pluginType": "jit",
2890
- "aliases": [],
2891
- "examples": [
2892
- "Deploy a Salesforce Function:\n<%= config.bin %> <%= command.id %> --connected-org org-alias",
2893
- "Deploy to 'deploy-branch':\n<%= config.bin %> <%= command.id %> --connected-org org-alias --branch deploy-branch",
2894
- "Overwrite the remote repository:\n<%= config.bin %> <%= command.id %> --connected-org org-alias --force"
2895
- ],
2896
- "flags": {
2897
- "json": {
2898
- "name": "json",
2899
- "type": "boolean",
2900
- "description": "Format output as json.",
2901
- "helpGroup": "GLOBAL",
2902
- "allowNo": false
2903
- },
2904
- "connected-org": {
2905
- "name": "connected-org",
2906
- "type": "option",
2907
- "char": "o",
2908
- "description": "Username or alias for the org that the compute environment should be connected to.",
2909
- "required": true,
2910
- "multiple": false
2911
- },
2912
- "branch": {
2913
- "name": "branch",
2914
- "type": "option",
2915
- "char": "b",
2916
- "description": "Deploy the latest commit from a branch different from the currently active branch.",
2917
- "multiple": false
2918
- },
2919
- "force": {
2920
- "name": "force",
2921
- "type": "boolean",
2922
- "description": "Ignore warnings and overwrite remote repository (not allowed in production).",
2923
- "allowNo": false
2924
- },
2925
- "quiet": {
2926
- "name": "quiet",
2927
- "type": "boolean",
2928
- "char": "q",
2929
- "description": "Limit the amount of output displayed from the deploy process.",
2930
- "allowNo": false
2931
- }
2932
- },
2933
- "args": {}
2934
- },
2935
- "env:delete": {
2936
- "id": "env:delete",
2937
- "summary": "Delete an environment.",
2938
- "description": "You must include the name of the environment to delete using '--target-compute'. Run 'sf env list' to see a list of environments.\n\nRunning this command will prompt a confirmation. If you want to skip this confirmation, use the '--confirm' flag and the environment alias to skip confirmation.",
2939
- "strict": true,
2940
- "pluginName": "@salesforce/plugin-functions",
2941
- "pluginAlias": "@salesforce/plugin-functions",
2942
- "pluginType": "jit",
2943
- "aliases": [],
2944
- "examples": [
2945
- "Delete a compute environment:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
2946
- "Delete without a confirmation step:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --confirm environment-alias"
2947
- ],
2948
- "flags": {
2949
- "json": {
2950
- "name": "json",
2951
- "type": "boolean",
2952
- "description": "Format output as json.",
2953
- "helpGroup": "GLOBAL",
2954
- "allowNo": false
2955
- },
2956
- "target-compute": {
2957
- "name": "target-compute",
2958
- "type": "option",
2959
- "char": "e",
2960
- "description": "Environment name.",
2961
- "required": false,
2962
- "multiple": false,
2963
- "exclusive": [
2964
- "environment"
2965
- ]
2966
- },
2967
- "environment": {
2968
- "name": "environment",
2969
- "type": "option",
2970
- "char": "e",
2971
- "description": "Environment name.",
2972
- "hidden": true,
2973
- "required": false,
2974
- "multiple": false,
2975
- "exclusive": [
2976
- "target-compute"
2977
- ]
2978
- },
2979
- "confirm": {
2980
- "name": "confirm",
2981
- "type": "option",
2982
- "description": "Confirmation name.",
2983
- "helpValue": "name",
2984
- "multiple": true
2985
- }
2986
- },
2987
- "args": {}
2988
- },
2989
- "env:log": {
2990
- "id": "env:log",
2991
- "summary": "Stream log output for an environment.",
2992
- "strict": true,
2993
- "pluginName": "@salesforce/plugin-functions",
2994
- "pluginAlias": "@salesforce/plugin-functions",
2995
- "pluginType": "jit",
2996
- "state": "beta",
2997
- "aliases": [],
2998
- "examples": [
2999
- "Stream log output:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
3000
- ],
3001
- "flags": {
3002
- "target-compute": {
3003
- "name": "target-compute",
3004
- "type": "option",
3005
- "char": "e",
3006
- "description": "Compute environment name to retrieve logs.",
3007
- "required": false,
3008
- "multiple": false,
3009
- "exclusive": [
3010
- "environment"
3011
- ]
3012
- },
3013
- "environment": {
3014
- "name": "environment",
3015
- "type": "option",
3016
- "char": "e",
3017
- "description": "Environment name.",
3018
- "hidden": true,
3019
- "required": false,
3020
- "multiple": false,
3021
- "exclusive": [
3022
- "target-compute"
3023
- ]
3024
- },
3025
- "num": {
3026
- "name": "num",
3027
- "type": "option",
3028
- "char": "n",
3029
- "description": "Number of lines to display.",
3030
- "multiple": false
3031
- }
3032
- },
3033
- "args": {}
3034
- },
3035
- "generate:function": {
3036
- "id": "generate:function",
3037
- "summary": "Create a Salesforce Function with basic scaffolding specific to a given language.",
3038
- "description": "Both '--language' and '--name' are required flags. Function names must start with a capital letter.",
3039
- "strict": true,
3040
- "pluginName": "@salesforce/plugin-functions",
3041
- "pluginAlias": "@salesforce/plugin-functions",
3042
- "pluginType": "jit",
3043
- "aliases": [],
3044
- "examples": [
3045
- "Create a JavaScript function:\n<%= config.bin %> <%= command.id %> --function-name myfunction --language javascript"
3046
- ],
3047
- "flags": {
3048
- "function-name": {
3049
- "name": "function-name",
3050
- "type": "option",
3051
- "char": "n",
3052
- "description": "Function name. Must start with a capital letter.",
3053
- "multiple": false,
3054
- "exclusive": [
3055
- "name"
3056
- ]
3057
- },
3058
- "name": {
3059
- "name": "name",
3060
- "type": "option",
3061
- "char": "n",
3062
- "description": "Function name. Must start with a capital letter.",
3063
- "hidden": true,
3064
- "multiple": false,
3065
- "exclusive": [
3066
- "function-name"
3067
- ]
3068
- },
3069
- "language": {
3070
- "name": "language",
3071
- "type": "option",
3072
- "char": "l",
3073
- "description": "The language in which the function is written.",
3074
- "required": true,
3075
- "multiple": false,
3076
- "options": [
3077
- "java",
3078
- "javascript",
3079
- "typescript"
3080
- ]
3081
- }
3082
- },
3083
- "args": {}
3084
- },
3085
- "login:functions": {
3086
- "id": "login:functions",
3087
- "summary": "Log in to Salesforce Functions.",
3088
- "description": "This step is required to develop or deploy Salesforce Functions.",
3089
- "strict": true,
3090
- "pluginName": "@salesforce/plugin-functions",
3091
- "pluginAlias": "@salesforce/plugin-functions",
3092
- "pluginType": "jit",
3093
- "aliases": [],
3094
- "examples": [
3095
- "Log in to Salesforce Functions:\n<%= config.bin %> <%= command.id %>"
3096
- ],
3097
- "flags": {
3098
- "json": {
3099
- "name": "json",
3100
- "type": "boolean",
3101
- "description": "Format output as json.",
3102
- "helpGroup": "GLOBAL",
3103
- "allowNo": false
3104
- }
3105
- },
3106
- "args": {}
3107
- },
3108
- "logout:functions": {
3109
- "id": "logout:functions",
3110
- "summary": "Log out of your Salesforce Functions account.",
3111
- "strict": true,
3112
- "pluginName": "@salesforce/plugin-functions",
3113
- "pluginAlias": "@salesforce/plugin-functions",
3114
- "pluginType": "jit",
3115
- "aliases": [],
3116
- "examples": [
3117
- "Log out:\n<%= config.bin %> <%= command.id %>"
3118
- ],
3119
- "flags": {
3120
- "json": {
3121
- "name": "json",
3122
- "type": "boolean",
3123
- "description": "Format output as json.",
3124
- "helpGroup": "GLOBAL",
3125
- "allowNo": false
3126
- }
3127
- },
3128
- "args": {}
3129
- },
3130
- "run:function": {
3131
- "id": "run:function",
3132
- "summary": "Send a cloudevent to a function.",
3133
- "strict": true,
3134
- "pluginName": "@salesforce/plugin-functions",
3135
- "pluginAlias": "@salesforce/plugin-functions",
3136
- "pluginType": "jit",
3137
- "aliases": [],
3138
- "examples": [
3139
- "Run a function:\n<%= config.bin %> <%= command.id %> --url http://path/to/function",
3140
- "Run a function with a payload and a JSON response:\n<%= config.bin %> <%= command.id %> --url http://path/to/function --payload '@file.json' --structured"
3141
- ],
3142
- "flags": {
3143
- "json": {
3144
- "name": "json",
3145
- "type": "boolean",
3146
- "description": "Format output as json.",
3147
- "helpGroup": "GLOBAL",
3148
- "allowNo": false
3149
- },
3150
- "function-url": {
3151
- "name": "function-url",
3152
- "type": "option",
3153
- "char": "l",
3154
- "description": "URL of the function to run.",
3155
- "multiple": false,
3156
- "exclusive": [
3157
- "url"
3158
- ]
3159
- },
3160
- "url": {
3161
- "name": "url",
3162
- "type": "option",
3163
- "char": "l",
3164
- "description": "URL of the function to run.",
3165
- "hidden": true,
3166
- "multiple": false,
3167
- "exclusive": [
3168
- "function-url"
3169
- ]
3170
- },
3171
- "headers": {
3172
- "name": "headers",
3173
- "type": "option",
3174
- "char": "H",
3175
- "description": "Set headers.",
3176
- "multiple": true
3177
- },
3178
- "payload": {
3179
- "name": "payload",
3180
- "type": "option",
3181
- "char": "p",
3182
- "description": "Set the payload of the cloudevent as a JSON object or a path to a file via @file.json.",
3183
- "multiple": false
3184
- },
3185
- "structured": {
3186
- "name": "structured",
3187
- "type": "boolean",
3188
- "char": "s",
3189
- "description": "Set the cloudevent to be emitted as a structured JSON cloudevent.",
3190
- "allowNo": false
3191
- },
3192
- "connected-org": {
3193
- "name": "connected-org",
3194
- "type": "option",
3195
- "char": "o",
3196
- "description": "Username or alias for the target org; overrides default target org.",
3197
- "multiple": false
3198
- }
3199
- },
3200
- "args": {}
3201
- },
3202
- "whoami:functions": {
3203
- "id": "whoami:functions",
3204
- "summary": "Show information on your Salesforce Functions login.",
3205
- "description": "Returns your email and ID. Use '--show-token' to show your Salesforce Functions token.",
3206
- "strict": true,
3207
- "pluginName": "@salesforce/plugin-functions",
3208
- "pluginAlias": "@salesforce/plugin-functions",
3209
- "pluginType": "jit",
3210
- "aliases": [],
3211
- "examples": [
3212
- "Get account information:\n<%= config.bin %> <%= command.id %>",
3213
- "Show token and output result as JSON:\n<%= config.bin %> <%= command.id %> --show-token --json"
3214
- ],
3215
- "flags": {
3216
- "json": {
3217
- "name": "json",
3218
- "type": "boolean",
3219
- "description": "Format output as json.",
3220
- "helpGroup": "GLOBAL",
3221
- "allowNo": false
3222
- },
3223
- "show-token": {
3224
- "name": "show-token",
3225
- "type": "boolean",
3226
- "description": "Show the stored functions token.",
3227
- "hidden": true,
3228
- "allowNo": false
3229
- }
3230
- },
3231
- "args": {}
3232
- },
3233
- "env:create:compute": {
3234
- "id": "env:create:compute",
3235
- "summary": "Create a compute environment for use with Salesforce Functions.",
3236
- "description": "Compute environments must be connected to a Salesforce org. By default the command uses your local environment's connected org. Use the '--connected-org' flag to specify a specific org. Run 'sf env list' to see a list of environments.",
3237
- "strict": true,
3238
- "pluginName": "@salesforce/plugin-functions",
3239
- "pluginAlias": "@salesforce/plugin-functions",
3240
- "pluginType": "jit",
3241
- "aliases": [],
3242
- "examples": [
3243
- "Create a compute environment to run Salesforce Functions:\n<%= config.bin %> <%= command.id %>",
3244
- "Connect the environment to a specific org:\n<%= config.bin %> <%= command.id %> --connected-org=org-alias",
3245
- "Create an alias for the compute environment:\n<%= config.bin %> <%= command.id %> --alias environment-alias"
3246
- ],
3247
- "flags": {
3248
- "json": {
3249
- "name": "json",
3250
- "type": "boolean",
3251
- "description": "Format output as json.",
3252
- "helpGroup": "GLOBAL",
3253
- "allowNo": false
3254
- },
3255
- "connected-org": {
3256
- "name": "connected-org",
3257
- "type": "option",
3258
- "char": "o",
3259
- "description": "Username or alias for the org that the compute environment should be connected to.",
3260
- "required": false,
3261
- "multiple": false
3262
- },
3263
- "alias": {
3264
- "name": "alias",
3265
- "type": "option",
3266
- "char": "a",
3267
- "description": "Alias for the created environment.",
3268
- "multiple": false
3269
- }
3270
- },
3271
- "args": {}
3272
- },
3273
- "env:log:tail": {
3274
- "id": "env:log:tail",
3275
- "summary": "Stream log output for an environment.",
3276
- "strict": true,
3277
- "pluginName": "@salesforce/plugin-functions",
3278
- "pluginAlias": "@salesforce/plugin-functions",
3279
- "pluginType": "jit",
3280
- "aliases": [],
3281
- "examples": [
3282
- "Stream log output:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
3283
- ],
3284
- "flags": {
3285
- "target-compute": {
3286
- "name": "target-compute",
3287
- "type": "option",
3288
- "char": "e",
3289
- "description": "Compute environment name to retrieve logs.",
3290
- "required": false,
3291
- "multiple": false,
3292
- "exclusive": [
3293
- "environment"
3294
- ]
3295
- },
3296
- "environment": {
3297
- "name": "environment",
3298
- "type": "option",
3299
- "char": "e",
3300
- "description": "Environment name.",
3301
- "hidden": true,
3302
- "required": false,
3303
- "multiple": false,
3304
- "exclusive": [
3305
- "target-compute"
3306
- ]
3307
- }
3308
- },
3309
- "args": {}
3310
- },
3311
- "env:logdrain:add": {
3312
- "id": "env:logdrain:add",
3313
- "summary": "Add log drain to a specified environment.",
3314
- "description": "Both '--target-compute' and '--url' are required flags. '--url' should be a HTTP or HTTPS URL that can receive the log drain messages.",
3315
- "strict": true,
3316
- "pluginName": "@salesforce/plugin-functions",
3317
- "pluginAlias": "@salesforce/plugin-functions",
3318
- "pluginType": "jit",
3319
- "aliases": [],
3320
- "examples": [
3321
- "Add a log drain:\n<%= config.bin %> <%= command.id %> --target-compute environment-name --url https://path/to/logdrain"
3322
- ],
3323
- "flags": {
3324
- "json": {
3325
- "name": "json",
3326
- "type": "boolean",
3327
- "description": "Format output as json.",
3328
- "helpGroup": "GLOBAL",
3329
- "allowNo": false
3330
- },
3331
- "target-compute": {
3332
- "name": "target-compute",
3333
- "type": "option",
3334
- "char": "e",
3335
- "description": "Environment name.",
3336
- "required": false,
3337
- "multiple": false,
3338
- "exclusive": [
3339
- "environment"
3340
- ]
3341
- },
3342
- "environment": {
3343
- "name": "environment",
3344
- "type": "option",
3345
- "char": "e",
3346
- "description": "Environment name.",
3347
- "hidden": true,
3348
- "required": false,
3349
- "multiple": false,
3350
- "exclusive": [
3351
- "target-compute"
3352
- ]
3353
- },
3354
- "drain-url": {
3355
- "name": "drain-url",
3356
- "type": "option",
3357
- "char": "l",
3358
- "description": "Endpoint that will receive sent logs.",
3359
- "multiple": false,
3360
- "exclusive": [
3361
- "url"
3362
- ]
3363
- },
3364
- "url": {
3365
- "name": "url",
3366
- "type": "option",
3367
- "char": "u",
3368
- "description": "Endpoint that will receive sent logs.",
3369
- "hidden": true,
3370
- "multiple": false,
3371
- "exclusive": [
3372
- "drain-url"
3373
- ]
3374
- }
3375
- },
3376
- "args": {}
3377
- },
3378
- "env:logdrain:list": {
3379
- "id": "env:logdrain:list",
3380
- "summary": "List log drains connected to a specified environment.",
3381
- "strict": true,
3382
- "pluginName": "@salesforce/plugin-functions",
3383
- "pluginAlias": "@salesforce/plugin-functions",
3384
- "pluginType": "jit",
3385
- "aliases": [],
3386
- "examples": [
3387
- "List log drains:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
3388
- "List log drains as json:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --json"
3389
- ],
3390
- "flags": {
3391
- "json": {
3392
- "name": "json",
3393
- "type": "boolean",
3394
- "description": "Format output as json.",
3395
- "helpGroup": "GLOBAL",
3396
- "allowNo": false
3397
- },
3398
- "target-compute": {
3399
- "name": "target-compute",
3400
- "type": "option",
3401
- "char": "e",
3402
- "description": "Environment name.",
3403
- "required": false,
3404
- "multiple": false,
3405
- "exclusive": [
3406
- "environment"
3407
- ]
3408
- },
3409
- "environment": {
3410
- "name": "environment",
3411
- "type": "option",
3412
- "char": "e",
3413
- "description": "Environment name.",
3414
- "hidden": true,
3415
- "required": false,
3416
- "multiple": false,
3417
- "exclusive": [
3418
- "target-compute"
3419
- ]
3420
- }
3421
- },
3422
- "args": {}
3423
- },
3424
- "env:logdrain:remove": {
3425
- "id": "env:logdrain:remove",
3426
- "summary": "Remove log drain from a specified environment.",
3427
- "description": "Both '--target-compute' and '--drain-url' are required flags.",
3428
- "strict": true,
3429
- "pluginName": "@salesforce/plugin-functions",
3430
- "pluginAlias": "@salesforce/plugin-functions",
3431
- "pluginType": "jit",
3432
- "aliases": [],
3433
- "examples": [
3434
- "Remove a logdrain:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --url https://path/to/logdrain"
3435
- ],
3436
- "flags": {
3437
- "json": {
3438
- "name": "json",
3439
- "type": "boolean",
3440
- "description": "Format output as json.",
3441
- "helpGroup": "GLOBAL",
3442
- "allowNo": false
3443
- },
3444
- "target-compute": {
3445
- "name": "target-compute",
3446
- "type": "option",
3447
- "char": "e",
3448
- "description": "Environment name.",
3449
- "required": false,
3450
- "multiple": false,
3451
- "exclusive": [
3452
- "environment"
3453
- ]
3454
- },
3455
- "environment": {
3456
- "name": "environment",
3457
- "type": "option",
3458
- "char": "e",
3459
- "description": "Environment name.",
3460
- "hidden": true,
3461
- "required": false,
3462
- "multiple": false,
3463
- "exclusive": [
3464
- "target-compute"
3465
- ]
3466
- },
3467
- "drain-url": {
3468
- "name": "drain-url",
3469
- "type": "option",
3470
- "char": "l",
3471
- "description": "Log drain url to remove.",
3472
- "multiple": false,
3473
- "exclusive": [
3474
- "url"
3475
- ]
3476
- },
3477
- "url": {
3478
- "name": "url",
3479
- "type": "option",
3480
- "char": "u",
3481
- "description": "Log drain url to remove.",
3482
- "hidden": true,
3483
- "multiple": false,
3484
- "exclusive": [
3485
- "drain-url"
3486
- ]
3487
- }
3488
- },
3489
- "args": {}
3490
- },
3491
- "env:var:get": {
3492
- "id": "env:var:get",
3493
- "summary": "Display a single config variable for an environment.",
3494
- "description": "You must provide the '--target-compute' flag and the key to retrieve.",
3495
- "strict": true,
3496
- "pluginName": "@salesforce/plugin-functions",
3497
- "pluginAlias": "@salesforce/plugin-functions",
3498
- "pluginType": "jit",
3499
- "aliases": [],
3500
- "examples": [
3501
- "Get a config variable:\n<%= config.bin %> <%= command.id %> [KEY] --target-compute environment-alias"
3502
- ],
3503
- "flags": {
3504
- "json": {
3505
- "name": "json",
3506
- "type": "boolean",
3507
- "description": "Format output as json.",
3508
- "helpGroup": "GLOBAL",
3509
- "allowNo": false
3510
- },
3511
- "target-compute": {
3512
- "name": "target-compute",
3513
- "type": "option",
3514
- "char": "e",
3515
- "description": "Environment name.",
3516
- "required": false,
3517
- "multiple": false,
3518
- "exclusive": [
3519
- "environment"
3520
- ]
3521
- },
3522
- "environment": {
3523
- "name": "environment",
3524
- "type": "option",
3525
- "char": "e",
3526
- "description": "Environment name.",
3527
- "hidden": true,
3528
- "required": false,
3529
- "multiple": false,
3530
- "exclusive": [
3531
- "target-compute"
3532
- ]
3533
- }
3534
- },
3535
- "args": {
3536
- "key": {
3537
- "name": "key",
3538
- "required": true
3539
- }
3540
- }
3541
- },
3542
- "env:var:list": {
3543
- "id": "env:var:list",
3544
- "summary": "List your environment's config vars in a table.",
3545
- "description": "Use the '--json' flag to return config vars in JSON format.",
3546
- "strict": true,
3547
- "pluginName": "@salesforce/plugin-functions",
3548
- "pluginAlias": "@salesforce/plugin-functions",
3549
- "pluginType": "jit",
3550
- "aliases": [],
3551
- "examples": [
3552
- "List config vars:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias",
3553
- "List in JSON format:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias --json"
3554
- ],
3555
- "flags": {
3556
- "json": {
3557
- "name": "json",
3558
- "type": "boolean",
3559
- "description": "Format output as json.",
3560
- "helpGroup": "GLOBAL",
3561
- "allowNo": false
3562
- },
3563
- "target-compute": {
3564
- "name": "target-compute",
3565
- "type": "option",
3566
- "char": "e",
3567
- "description": "Environment name.",
3568
- "required": false,
3569
- "multiple": false,
3570
- "exclusive": [
3571
- "environment"
3572
- ]
3573
- },
3574
- "environment": {
3575
- "name": "environment",
3576
- "type": "option",
3577
- "char": "e",
3578
- "description": "Environment name.",
3579
- "hidden": true,
3580
- "required": false,
3581
- "multiple": false,
3582
- "exclusive": [
3583
- "target-compute"
3584
- ]
3585
- }
3586
- },
3587
- "args": {}
3588
- },
3589
- "env:var:set": {
3590
- "id": "env:var:set",
3591
- "summary": "Set a single config value for an environment.",
3592
- "strict": false,
3593
- "pluginName": "@salesforce/plugin-functions",
3594
- "pluginAlias": "@salesforce/plugin-functions",
3595
- "pluginType": "jit",
3596
- "aliases": [],
3597
- "examples": [
3598
- "Set a config value:\n<%= config.bin %> <%= command.id %> [KEY]=[VALUE] --target-compute environment-alias"
3599
- ],
3600
- "flags": {
3601
- "json": {
3602
- "name": "json",
3603
- "type": "boolean",
3604
- "description": "Format output as json.",
3605
- "helpGroup": "GLOBAL",
3606
- "allowNo": false
3607
- },
3608
- "target-compute": {
3609
- "name": "target-compute",
3610
- "type": "option",
3611
- "char": "e",
3612
- "description": "Environment name.",
3613
- "required": false,
3614
- "multiple": false,
3615
- "exclusive": [
3616
- "environment"
3617
- ]
3618
- },
3619
- "environment": {
3620
- "name": "environment",
3621
- "type": "option",
3622
- "char": "e",
3623
- "description": "Environment name.",
3624
- "hidden": true,
3625
- "required": false,
3626
- "multiple": false,
3627
- "exclusive": [
3628
- "target-compute"
3629
- ]
3630
- }
3631
- },
3632
- "args": {}
3633
- },
3634
- "env:var:unset": {
3635
- "id": "env:var:unset",
3636
- "summary": "Unset a single config value for an environment.",
3637
- "description": "Run 'sf env var list' to see a list of config values that can be unset.",
3638
- "strict": false,
3639
- "pluginName": "@salesforce/plugin-functions",
3640
- "pluginAlias": "@salesforce/plugin-functions",
3641
- "pluginType": "jit",
3642
- "aliases": [],
3643
- "examples": [
3644
- "Unset a value:\n<%= config.bin %> <%= command.id %> --target-compute environment-alias"
3645
- ],
3646
- "flags": {
3647
- "json": {
3648
- "name": "json",
3649
- "type": "boolean",
3650
- "description": "Format output as json.",
3651
- "helpGroup": "GLOBAL",
3652
- "allowNo": false
3653
- },
3654
- "target-compute": {
3655
- "name": "target-compute",
3656
- "type": "option",
3657
- "char": "e",
3658
- "description": "Environment name.",
3659
- "required": false,
3660
- "multiple": false,
3661
- "exclusive": [
3662
- "environment"
3663
- ]
3664
- },
3665
- "environment": {
3666
- "name": "environment",
3667
- "type": "option",
3668
- "char": "e",
3669
- "description": "Environment name.",
3670
- "hidden": true,
3671
- "required": false,
3672
- "multiple": false,
3673
- "exclusive": [
3674
- "target-compute"
3675
- ]
3676
- }
3677
- },
3678
- "args": {}
3679
- },
3680
- "login:functions:jwt": {
3681
- "id": "login:functions:jwt",
3682
- "summary": "Login using JWT instead of default web-based flow. This will authenticate you with both sf and Salesforce Functions.",
3683
- "description": "Use this command when executing from a script.",
3684
- "strict": true,
3685
- "pluginName": "@salesforce/plugin-functions",
3686
- "pluginAlias": "@salesforce/plugin-functions",
3687
- "pluginType": "jit",
3688
- "aliases": [],
3689
- "examples": [
3690
- "Log in using JWT:\n<%= config.bin %> <%= command.id %> --username example@username.org --keyfile file.key --clientid 123456",
3691
- "Log in and specify the org alias and URL, set as default org and default Dev Hub, and format output as JSON:\n<%= config.bin %> <%= command.id %> --username example@username.org --keyfile file.key --clientid 123456 --alias org-alias --set-default --set-default-dev-hub --instance-url https://path/to/instance --json"
3692
- ],
3693
- "flags": {
3694
- "json": {
3695
- "name": "json",
3696
- "type": "boolean",
3697
- "description": "Format output as json.",
3698
- "helpGroup": "GLOBAL",
3699
- "allowNo": false
3700
- },
3701
- "username": {
3702
- "name": "username",
3703
- "type": "option",
3704
- "char": "u",
3705
- "description": "Authentication username.",
3706
- "required": true,
3707
- "multiple": false
3708
- },
3709
- "keyfile": {
3710
- "name": "keyfile",
3711
- "type": "option",
3712
- "char": "f",
3713
- "description": "Path to JWT keyfile.",
3714
- "required": true,
3715
- "multiple": false
3716
- },
3717
- "clientid": {
3718
- "name": "clientid",
3719
- "type": "option",
3720
- "char": "i",
3721
- "description": "OAuth client ID.",
3722
- "required": true,
3723
- "multiple": false
3724
- },
3725
- "instance-url": {
3726
- "name": "instance-url",
3727
- "type": "option",
3728
- "char": "l",
3729
- "description": "The login URL of the instance the org lives on.",
3730
- "multiple": false,
3731
- "exclusive": [
3732
- "instanceurl"
3733
- ]
3734
- },
3735
- "instanceurl": {
3736
- "name": "instanceurl",
3737
- "type": "option",
3738
- "char": "l",
3739
- "description": "The login URL of the instance the org lives on.",
3740
- "hidden": true,
3741
- "multiple": false,
3742
- "exclusive": [
3743
- "instance-url"
3744
- ]
3745
- },
3746
- "alias": {
3747
- "name": "alias",
3748
- "type": "option",
3749
- "char": "a",
3750
- "description": "Alias for the org.",
3751
- "multiple": false
3752
- },
3753
- "set-default": {
3754
- "name": "set-default",
3755
- "type": "boolean",
3756
- "char": "d",
3757
- "description": "Set the org as the default that all org-related commands run against.",
3758
- "allowNo": false
3759
- },
3760
- "set-default-dev-hub": {
3761
- "name": "set-default-dev-hub",
3762
- "type": "boolean",
3763
- "char": "v",
3764
- "description": "Set the org as the default Dev Hub for scratch org creation.",
3765
- "allowNo": false
3766
- }
3767
- },
3768
- "args": {}
3769
- },
3770
- "run:function:start": {
3771
- "id": "run:function:start",
3772
- "summary": "Build and run a Salesforce Function.",
3773
- "description": "Run this command from the directory of your Salesforce Functions project.\n\nThis command will run the target function locally (on the same operating system as this CLI), just like the `local` subcommand.",
3774
- "strict": true,
3775
- "pluginName": "@salesforce/plugin-functions",
3776
- "pluginAlias": "@salesforce/plugin-functions",
3777
- "pluginType": "jit",
3778
- "aliases": [],
3779
- "examples": [
3780
- "Build a function and start the invoker\n<%= config.bin %> <%= command.id %>",
3781
- "Start the invoker with a specific language and port\n<%= config.bin %> <%= command.id %> --port 5000 --language javascript"
3782
- ],
3783
- "flags": {
3784
- "path": {
3785
- "name": "path",
3786
- "type": "option",
3787
- "description": "Path to function directory.",
3788
- "hidden": true,
3789
- "multiple": false,
3790
- "default": "/home/runner/work/plugin-functions/plugin-functions"
3791
- },
3792
- "port": {
3793
- "name": "port",
3794
- "type": "option",
3795
- "char": "p",
3796
- "description": "Port for running the function.",
3797
- "multiple": false,
3798
- "default": 8080
3799
- },
3800
- "debug-port": {
3801
- "name": "debug-port",
3802
- "type": "option",
3803
- "char": "b",
3804
- "description": "Port for remote debugging.",
3805
- "multiple": false,
3806
- "default": 9229
3807
- },
3808
- "language": {
3809
- "name": "language",
3810
- "type": "option",
3811
- "char": "l",
3812
- "description": "The language that the function runs in.",
3813
- "multiple": false,
3814
- "options": [
3815
- "auto",
3816
- "java",
3817
- "javascript",
3818
- "typescript"
3819
- ],
3820
- "default": "auto"
3821
- },
3822
- "verbose": {
3823
- "name": "verbose",
3824
- "type": "boolean",
3825
- "char": "v",
3826
- "description": "Output additional logs.",
3827
- "allowNo": false
3828
- }
3829
- },
3830
- "args": {}
3831
- },
3832
- "env:compute:collaborator:add": {
3833
- "id": "env:compute:collaborator:add",
3834
- "summary": "Add a Heroku user as a collaborator on this Functions account, allowing them to attach Heroku add-ons to compute environments.",
3835
- "strict": true,
3836
- "pluginName": "@salesforce/plugin-functions",
3837
- "pluginAlias": "@salesforce/plugin-functions",
3838
- "pluginType": "jit",
3839
- "aliases": [],
3840
- "examples": [
3841
- "Add a Heroku user as a collaborator on this Functions account.\n<%= config.bin %> <%= command.id %> --heroku-user example@heroku.com"
3842
- ],
3843
- "flags": {
3844
- "heroku-user": {
3845
- "name": "heroku-user",
3846
- "type": "option",
3847
- "char": "h",
3848
- "description": "Email address of the Heroku user you're adding as a collaborator.",
3849
- "required": true,
3850
- "multiple": false
3851
- }
3852
- },
3853
- "args": {}
3854
- },
3855
- "run:function:start:container": {
3856
- "id": "run:function:start:container",
3857
- "strict": true,
3858
- "pluginName": "@salesforce/plugin-functions",
3859
- "pluginAlias": "@salesforce/plugin-functions",
3860
- "pluginType": "jit",
3861
- "hidden": false,
3862
- "aliases": [],
3863
- "flags": {},
3864
- "args": {}
3865
- },
3866
- "run:function:start:local": {
3867
- "id": "run:function:start:local",
3868
- "description": "Build and run a Salesforce Function locally.",
3869
- "strict": true,
3870
- "pluginName": "@salesforce/plugin-functions",
3871
- "pluginAlias": "@salesforce/plugin-functions",
3872
- "pluginType": "jit",
3873
- "aliases": [],
3874
- "examples": [
3875
- "Build a function and start the invoker\n<%= config.bin %> <%= command.id %>",
3876
- "Start the invoker with a specific language and port\n<%= config.bin %> <%= command.id %> --port 5000 --language javascript"
3877
- ],
3878
- "flags": {
3879
- "path": {
3880
- "name": "path",
3881
- "type": "option",
3882
- "description": "Path to function directory.",
3883
- "hidden": true,
3884
- "multiple": false,
3885
- "default": "/home/runner/work/plugin-functions/plugin-functions"
3886
- },
3887
- "port": {
3888
- "name": "port",
3889
- "type": "option",
3890
- "char": "p",
3891
- "description": "Port to bind the invoker to.",
3892
- "multiple": false,
3893
- "default": 8080
3894
- },
3895
- "debug-port": {
3896
- "name": "debug-port",
3897
- "type": "option",
3898
- "char": "b",
3899
- "description": "Port to use for debugging the function.",
3900
- "multiple": false,
3901
- "default": 9229
3902
- },
3903
- "language": {
3904
- "name": "language",
3905
- "type": "option",
3906
- "char": "l",
3907
- "description": "The language in which the function is written.",
3908
- "multiple": false,
3909
- "options": [
3910
- "auto",
3911
- "java",
3912
- "javascript",
3913
- "typescript"
3914
- ],
3915
- "default": "auto"
3916
- }
3917
- },
3918
- "args": {}
3919
- },
3920
2663
  "org:create:shape": {
3921
2664
  "aliases": [
3922
2665
  "force:org:shape:create"
@@ -5660,5 +4403,5 @@
5660
4403
  ]
5661
4404
  }
5662
4405
  },
5663
- "version": "2.75.0"
4406
+ "version": "2.75.2"
5664
4407
  }