UNPKG

fonteva-sfdx/README.md

Version:
30.9 kBMarkdownView Raw
1fonteva-sfdx
2============
3
4
5
6[![Version](https://img.shields.io/npm/v/fonteva-sfdx.svg)](https://npmjs.org/package/fonteva-sfdx)
7[![CircleCI](https://circleci.com/gh/parmarg/fonteva-sfdx/tree/master.svg?style=shield)](https://circleci.com/gh/parmarg/fonteva-sfdx/tree/master)
8[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/parmarg/fonteva-sfdx?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/fonteva-sfdx/branch/master)
9[![Codecov](https://codecov.io/gh/parmarg/fonteva-sfdx/branch/master/graph/badge.svg)](https://codecov.io/gh/parmarg/fonteva-sfdx)
10[![Greenkeeper](https://badges.greenkeeper.io/parmarg/fonteva-sfdx.svg)](https://greenkeeper.io/)
11[![Known Vulnerabilities](https://snyk.io/test/github/parmarg/fonteva-sfdx/badge.svg)](https://snyk.io/test/github/parmarg/fonteva-sfdx)
12[![Downloads/week](https://img.shields.io/npm/dw/fonteva-sfdx.svg)](https://npmjs.org/package/fonteva-sfdx)
13[![License](https://img.shields.io/npm/l/fonteva-sfdx.svg)](https://github.com/parmarg/fonteva-sfdx/blob/master/package.json)
14
15<!-- toc -->
16* [Debugging your plugin](#debugging-your-plugin)
17<!-- tocstop -->
18<!-- install -->
19<!-- usage -->
20```sh-session
21$ npm install -g fonteva-sfdx
22$ sfdx COMMAND
23running command...
24$ sfdx (-v|--version|version)
25fonteva-sfdx/0.3.13 darwin-x64 node-v13.8.0
26$ sfdx --help [COMMAND]
27USAGE
28  $ sfdx COMMAND
29...
30```
31<!-- usagestop -->
32<!-- commands -->
33* [`sfdx fonteva:build:devorg -p <string> -t <string> -s <string> [-h] [-d] [-c] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevabuilddevorg--p-string--t-string--s-string--h--d--c--v-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
34* [`sfdx fonteva:community:apply [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevacommunityapply--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
35* [`sfdx fonteva:deploy [-m <string>] [-p <string>] [-x <string>] [-q <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevadeploy--m-string--p-string--x-string--q-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
36* [`sfdx fonteva:fls:run [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevaflsrun--p-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
37* [`sfdx fonteva:install:dependencies [-p <string>] [-d] [-P <string>] [-c] [--dryrun] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevainstalldependencies--p-string--d--p-string--c---dryrun--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
38* [`sfdx fonteva:layouts:apply -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevalayoutsapply--p-string--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
39* [`sfdx fonteva:ns:swap [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevansswap--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
40* [`sfdx fonteva:ns:swapSfdx [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevansswapsfdx--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
41* [`sfdx fonteva:push [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevapush--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
42* [`sfdx fonteva:sfpm:copy [-n <string>] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevasfpmcopy--n-string--d--v---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
43* [`sfdx fonteva:sfpm:install [-s] [-n <string>] [-k] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevasfpminstall--s--n-string--k--d--v---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
44* [`sfdx fonteva:sharingSets:deploy [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevasharingsetsdeploy--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
45* [`sfdx fonteva:swapAndDeploy [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevaswapanddeploy--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
46
47## `sfdx fonteva:build:devorg -p <string> -t <string> -s <string> [-h] [-d] [-c] [-v <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
48
49Setup an org for development. Deploy dependent packages, FLS, and deploy code.
50
51```
52USAGE
53  $ sfdx fonteva:build:devorg -p <string> -t <string> -s <string> [-h] [-d] [-c] [-v <string>] [--apiversion <string>] 
54  [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
55
56OPTIONS
57  -c, --allcoredeps                                                                 All Core Deps
58  -d, --isproduction                                                                If Is Production
59  -h, --pushsource                                                                  Push Source
60
61  -p, --packagename=packagename                                                     (required) Package to install deps
62                                                                                    for
63
64  -s, --scratchorgconfig=scratchorgconfig                                           (required) Scratch Org Config
65
66  -t, --username=username                                                           (required) target user name
67
68  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
69                                                                                    org; overrides default dev hub org
70
71  --apiversion=apiversion                                                           override the api version used for
72                                                                                    api requests made by this command
73
74  --json                                                                            format output as json
75
76  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
77                                                                                    this command invocation
78
79EXAMPLE
80  $ sfdx install:dependencies --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
81     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
82     My hub org id is: 00Dxx000000001234
83```
84
85_See code: [src/commands/fonteva/build/devorg.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/build/devorg.ts)_
86
87## `sfdx fonteva:community:apply [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
88
89Configure the community in an LTE DevOrg
90
91```
92USAGE
93  $ sfdx fonteva:community:apply [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
94  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
95
96OPTIONS
97  -u, --targetusername=targetusername                                               username or alias for the target
98                                                                                    org; overrides default target org
99
100  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
101                                                                                    org; overrides default dev hub org
102
103  --apiversion=apiversion                                                           override the api version used for
104                                                                                    api requests made by this command
105
106  --json                                                                            format output as json
107
108  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
109                                                                                    this command invocation
110```
111
112_See code: [src/commands/fonteva/community/apply.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/community/apply.ts)_
113
114## `sfdx fonteva:deploy [-m <string>] [-p <string>] [-x <string>] [-q <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
115
116Meta-target for installs. Runs sfpm, then deploy
117
118```
119USAGE
120  $ sfdx fonteva:deploy [-m <string>] [-p <string>] [-x <string>] [-q <string>] [-u <string>] [--apiversion <string>] 
121  [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
122
123OPTIONS
124  -m, --metadata=metadata                                                           comma-separated list of metadata
125                                                                                    component names
126
127  -p, --sourcepath=sourcepath                                                       comma-separated list of paths to the
128                                                                                    local source files to deploy
129
130  -q, --validateddeployrequestid=validateddeployrequestid                           request ID of the validated
131                                                                                    deployment to run a Quick Deploy
132
133  -u, --targetusername=targetusername                                               username or alias for the target
134                                                                                    org; overrides default target org
135
136  -x, --manifest=manifest                                                           file path for manifest (package.xml)
137                                                                                    of components to deploy
138
139  --apiversion=apiversion                                                           override the api version used for
140                                                                                    api requests made by this command
141
142  --json                                                                            format output as json
143
144  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
145                                                                                    this command invocation
146```
147
148_See code: [src/commands/fonteva/deploy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/deploy.ts)_
149
150## `sfdx fonteva:fls:run [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
151
152Run the FLS utility, granting access to Fonteva custom objects.
153
154```
155USAGE
156  $ sfdx fonteva:fls:run [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
157  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
158
159OPTIONS
160  -p, --profile=profile                                                             Profile
161
162  -u, --targetusername=targetusername                                               username or alias for the target
163                                                                                    org; overrides default target org
164
165  --apiversion=apiversion                                                           override the api version used for
166                                                                                    api requests made by this command
167
168  --json                                                                            format output as json
169
170  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
171                                                                                    this command invocation
172
173EXAMPLE
174  $ sfdx fonteva:fls:run --targetusername=myOrg@example.com
175```
176
177_See code: [src/commands/fonteva/fls/run.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/fls/run.ts)_
178
179## `sfdx fonteva:install:dependencies [-p <string>] [-d] [-P <string>] [-c] [--dryrun] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
180
181Install dependent packages.
182
183```
184USAGE
185  $ sfdx fonteva:install:dependencies [-p <string>] [-d] [-P <string>] [-c] [--dryrun] [-v <string>] [-u <string>] 
186  [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
187
188ARGUMENTS
189  PACKAGE  (Optional) The Fonteva package to install (e.g. 'Framework')
190
191OPTIONS
192  -P, --patch=patch                                                                 If Is Patch - provide the patch args
193                                                                                    (e.g. --patch=2019.1)
194
195  -c, --allcoredeps                                                                 All Core Deps
196
197  -d, --isproduction                                                                If Is Production
198
199  -p, --packagename=packagename                                                     Package to install deps for (e.g.
200                                                                                    "OrderApi" will install PagesApi &
201                                                                                    Framework)
202
203  -u, --targetusername=targetusername                                               username or alias for the target
204                                                                                    org; overrides default target org
205
206  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
207                                                                                    org; overrides default dev hub org
208
209  --apiversion=apiversion                                                           override the api version used for
210                                                                                    api requests made by this command
211
212  --dryrun                                                                          Dry Run - don't install anything
213
214  --json                                                                            format output as json
215
216  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
217                                                                                    this command invocation
218
219EXAMPLE
220  $ sfdx install:dependencies --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
221     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
222     My hub org id is: 00Dxx000000001234
223```
224
225_See code: [src/commands/fonteva/install/dependencies.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/install/dependencies.ts)_
226
227## `sfdx fonteva:layouts:apply -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
228
229Apply useful layouts for Fonteva custom objects.
230
231```
232USAGE
233  $ sfdx fonteva:layouts:apply -p <string> [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel 
234  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
235
236OPTIONS
237  -p, --packagename=packagename                                                     (required) Package to install
238                                                                                    layouts for
239
240  -u, --targetusername=targetusername                                               username or alias for the target
241                                                                                    org; overrides default target org
242
243  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
244                                                                                    org; overrides default dev hub org
245
246  --apiversion=apiversion                                                           override the api version used for
247                                                                                    api requests made by this command
248
249  --json                                                                            format output as json
250
251  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
252                                                                                    this command invocation
253
254EXAMPLE
255  $ sfdx install:dependencies --targetusername myOrg@example.com --targetdevhubusername devhub@org.com
256     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
257     My hub org id is: 00Dxx000000001234
258```
259
260_See code: [src/commands/fonteva/layouts/apply.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/layouts/apply.ts)_
261
262## `sfdx fonteva:ns:swap [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
263
264Do a namespace swap for a source-format project
265
266```
267USAGE
268  $ sfdx fonteva:ns:swap [-u <string>] [--apiversion <string>] [--json] [--loglevel 
269  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
270
271ARGUMENTS
272  NS  The namespace to swap to (takes precedence over the detected org namespace)
273
274OPTIONS
275  -u, --targetusername=targetusername                                               username or alias for the target
276                                                                                    org; overrides default target org
277
278  --apiversion=apiversion                                                           override the api version used for
279                                                                                    api requests made by this command
280
281  --json                                                                            format output as json
282
283  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
284                                                                                    this command invocation
285
286EXAMPLES
287  $ sfdx fonteva:ns:swap qa1234 // swaps to namespace "qa1234"
288  $ sfdx fonteva:ns:swap -u devorg123 // connects to the org specified, determines the namespace, then swaps
289```
290
291_See code: [src/commands/fonteva/ns/swap.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/ns/swap.ts)_
292
293## `sfdx fonteva:ns:swapSfdx [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
294
295Do a namespace swap for a source-format project
296
297```
298USAGE
299  $ sfdx fonteva:ns:swapSfdx [-u <string>] [--apiversion <string>] [--json] [--loglevel 
300  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
301
302ARGUMENTS
303  NS  The namespace to swap to (takes precedence over the detected org namespace)
304
305OPTIONS
306  -u, --targetusername=targetusername                                               username or alias for the target
307                                                                                    org; overrides default target org
308
309  --apiversion=apiversion                                                           override the api version used for
310                                                                                    api requests made by this command
311
312  --json                                                                            format output as json
313
314  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
315                                                                                    this command invocation
316
317EXAMPLES
318  $ sfdx fonteva:ns:swap qa1234 // swaps to namespace "qa1234"
319  $ sfdx fonteva:ns:swap -u devorg123 // connects to the org specified, determines the namespace, then swaps
320```
321
322_See code: [src/commands/fonteva/ns/swapSfdx.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/ns/swapSfdx.ts)_
323
324## `sfdx fonteva:push [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
325
326Meta-target for pushing code. Runs sfpm, then deploy
327
328```
329USAGE
330  $ sfdx fonteva:push [-u <string>] [--apiversion <string>] [--json] [--loglevel 
331  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
332
333OPTIONS
334  -u, --targetusername=targetusername                                               username or alias for the target
335                                                                                    org; overrides default target org
336
337  --apiversion=apiversion                                                           override the api version used for
338                                                                                    api requests made by this command
339
340  --json                                                                            format output as json
341
342  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
343                                                                                    this command invocation
344```
345
346_See code: [src/commands/fonteva/push.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/push.ts)_
347
348## `sfdx fonteva:sfpm:copy [-n <string>] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
349
350Salesforce Package Manager
351
352```
353USAGE
354  $ sfdx fonteva:sfpm:copy [-n <string>] [-d] [-v] [--json] [--loglevel 
355  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
356
357OPTIONS
358  -d, --debug                                                                       debug mode - don't clean up & print
359                                                                                    console messages
360
361  -n, --namespace=namespace                                                         passed on to webpack as
362                                                                                    output.library. Use to namespace
363                                                                                    javascript libraries.
364
365  -v, --verbose                                                                     verbose mode - don't clean up &
366                                                                                    print _extra_ console messages
367
368  --json                                                                            format output as json
369
370  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
371                                                                                    this command invocation
372```
373
374_See code: [src/commands/fonteva/sfpm/copy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/sfpm/copy.ts)_
375
376## `sfdx fonteva:sfpm:install [-s] [-n <string>] [-k] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
377
378Salesforce Package Manager
379
380```
381USAGE
382  $ sfdx fonteva:sfpm:install [-s] [-n <string>] [-k] [-d] [-v] [--json] [--loglevel 
383  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
384
385OPTIONS
386  -d, --debug                                                                       debug mode - don't clean up & print
387                                                                                    console messages
388
389  -k, --skip-npm                                                                    Skip the npm step. You probably
390                                                                                    shouldn't set this
391
392  -n, --namespace=namespace                                                         passed on to webpack as
393                                                                                    output.library. Use to namespace
394                                                                                    javascript libraries.
395
396  -s, --save                                                                        pass-thru to npm
397
398  -v, --verbose                                                                     verbose mode - don't clean up &
399                                                                                    print _extra_ console messages
400
401  --json                                                                            format output as json
402
403  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
404                                                                                    this command invocation
405```
406
407_See code: [src/commands/fonteva/sfpm/install.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/sfpm/install.ts)_
408
409## `sfdx fonteva:sharingSets:deploy [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
410
411Deploys sharing sets to your org
412
413```
414USAGE
415  $ sfdx fonteva:sharingSets:deploy [-u <string>] [--apiversion <string>] [--json] [--loglevel 
416  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
417
418OPTIONS
419  -u, --targetusername=targetusername                                               username or alias for the target
420                                                                                    org; overrides default target org
421
422  --apiversion=apiversion                                                           override the api version used for
423                                                                                    api requests made by this command
424
425  --json                                                                            format output as json
426
427  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
428                                                                                    this command invocation
429```
430
431_See code: [src/commands/fonteva/sharingSets/deploy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/sharingSets/deploy.ts)_
432
433## `sfdx fonteva:swapAndDeploy [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
434
435Do a namespace swap for a source-format project and deploy
436
437```
438USAGE
439  $ sfdx fonteva:swapAndDeploy [-u <string>] [--apiversion <string>] [--json] [--loglevel 
440  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
441
442OPTIONS
443  -u, --targetusername=targetusername                                               username or alias for the target
444                                                                                    org; overrides default target org
445
446  --apiversion=apiversion                                                           override the api version used for
447                                                                                    api requests made by this command
448
449  --json                                                                            format output as json
450
451  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
452                                                                                    this command invocation
453
454EXAMPLE
455  $ sfdx fonteva:swapAndDeploy -u devorg123 // connects to the org specified, determines the namespace, swaps namespace 
456  into a temp folder, then deploys
457```
458
459_See code: [src/commands/fonteva/swapAndDeploy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.13/src/commands/fonteva/swapAndDeploy.ts)_
460<!-- commandsstop -->
461<!-- debugging-your-plugin -->
462# Debugging your plugin
463We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
464
465To debug the `hello:org` command: 
4661. Start the inspector
467  
468If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch: 
469```sh-session
470$ sfdx hello:org -u myOrg@example.com --dev-suspend
471```
472  
473Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
474```sh-session
475$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
476```
477
4782. Set some breakpoints in your command code
4793. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
4804. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
4815. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program. 
4826. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
483<br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
484Congrats, you are debugging!