1 | fonteva-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 |
|
16 | * [Debugging your plugin](#debugging-your-plugin)
|
17 |
|
18 |
|
19 |
|
20 | ```sh-session
|
21 | $ npm install -g fonteva-sfdx
|
22 | $ sfdx COMMAND
|
23 | running command...
|
24 | $ sfdx (-v|--version|version)
|
25 | fonteva-sfdx/0.3.17 darwin-x64 node-v13.8.0
|
26 | $ sfdx --help [COMMAND]
|
27 | USAGE
|
28 | $ sfdx COMMAND
|
29 | ...
|
30 | ```
|
31 |
|
32 |
|
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 [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevansswap---unpackaged--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
|
40 | * [`sfdx fonteva:ns:swapSfdx [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevansswapsfdx---unpackaged--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 [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-fontevaswapanddeploy---unpackaged--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 |
|
49 | Setup an org for development. Deploy dependent packages, FLS, and deploy code.
|
50 |
|
51 | ```
|
52 | USAGE
|
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 |
|
56 | OPTIONS
|
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 |
|
79 | EXAMPLE
|
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.17/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 |
|
89 | Configure the community in an LTE DevOrg
|
90 |
|
91 | ```
|
92 | USAGE
|
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 |
|
96 | OPTIONS
|
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.17/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 |
|
116 | Meta-target for installs. Runs sfpm, then deploy
|
117 |
|
118 | ```
|
119 | USAGE
|
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 |
|
123 | OPTIONS
|
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.17/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 |
|
152 | Run the FLS utility, granting access to Fonteva custom objects.
|
153 |
|
154 | ```
|
155 | USAGE
|
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 |
|
159 | OPTIONS
|
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 |
|
173 | EXAMPLE
|
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.17/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 |
|
181 | Install dependent packages.
|
182 |
|
183 | ```
|
184 | USAGE
|
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 |
|
188 | ARGUMENTS
|
189 | PACKAGE (Optional) The Fonteva package to install (e.g. 'Framework')
|
190 |
|
191 | OPTIONS
|
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 |
|
219 | EXAMPLE
|
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.17/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 |
|
229 | Apply useful layouts for Fonteva custom objects.
|
230 |
|
231 | ```
|
232 | USAGE
|
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 |
|
236 | OPTIONS
|
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 |
|
254 | EXAMPLE
|
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.17/src/commands/fonteva/layouts/apply.ts)_
|
261 |
|
262 | ## `sfdx fonteva:ns:swap [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
263 |
|
264 | Do a namespace swap for a source-format project
|
265 |
|
266 | ```
|
267 | USAGE
|
268 | $ sfdx fonteva:ns:swap [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
269 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
270 |
|
271 | ARGUMENTS
|
272 | NS The namespace to swap to (takes precedence over the detected org namespace)
|
273 |
|
274 | OPTIONS
|
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 |
|
286 | --unpackaged Deploy unpackaged code, not the main
|
287 | codebase.
|
288 |
|
289 | EXAMPLES
|
290 | $ sfdx fonteva:ns:swap qa1234 // swaps to namespace "qa1234"
|
291 | $ sfdx fonteva:ns:swap -u devorg123 // connects to the org specified, determines the namespace, then swaps
|
292 | ```
|
293 |
|
294 | _See code: [src/commands/fonteva/ns/swap.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/ns/swap.ts)_
|
295 |
|
296 | ## `sfdx fonteva:ns:swapSfdx [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
297 |
|
298 | Do a namespace swap for a source-format project
|
299 |
|
300 | ```
|
301 | USAGE
|
302 | $ sfdx fonteva:ns:swapSfdx [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
303 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
304 |
|
305 | ARGUMENTS
|
306 | NS The namespace to swap to (takes precedence over the detected org namespace)
|
307 |
|
308 | OPTIONS
|
309 | -u, --targetusername=targetusername username or alias for the target
|
310 | org; overrides default target org
|
311 |
|
312 | --apiversion=apiversion override the api version used for
|
313 | api requests made by this command
|
314 |
|
315 | --json format output as json
|
316 |
|
317 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
318 | this command invocation
|
319 |
|
320 | --unpackaged Deploy unpackaged code, not the main
|
321 | codebase.
|
322 |
|
323 | EXAMPLES
|
324 | $ sfdx fonteva:ns:swap qa1234 // swaps to namespace "qa1234"
|
325 | $ sfdx fonteva:ns:swap -u devorg123 // connects to the org specified, determines the namespace, then swaps
|
326 | ```
|
327 |
|
328 | _See code: [src/commands/fonteva/ns/swapSfdx.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/ns/swapSfdx.ts)_
|
329 |
|
330 | ## `sfdx fonteva:push [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
331 |
|
332 | Meta-target for pushing code. Runs sfpm, then deploy
|
333 |
|
334 | ```
|
335 | USAGE
|
336 | $ sfdx fonteva:push [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
337 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
338 |
|
339 | OPTIONS
|
340 | -u, --targetusername=targetusername username or alias for the target
|
341 | org; overrides default target org
|
342 |
|
343 | --apiversion=apiversion override the api version used for
|
344 | api requests made by this command
|
345 |
|
346 | --json format output as json
|
347 |
|
348 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
349 | this command invocation
|
350 | ```
|
351 |
|
352 | _See code: [src/commands/fonteva/push.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/push.ts)_
|
353 |
|
354 | ## `sfdx fonteva:sfpm:copy [-n <string>] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
355 |
|
356 | Salesforce Package Manager
|
357 |
|
358 | ```
|
359 | USAGE
|
360 | $ sfdx fonteva:sfpm:copy [-n <string>] [-d] [-v] [--json] [--loglevel
|
361 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
362 |
|
363 | OPTIONS
|
364 | -d, --debug debug mode - don't clean up & print
|
365 | console messages
|
366 |
|
367 | -n, --namespace=namespace passed on to webpack as
|
368 | output.library. Use to namespace
|
369 | javascript libraries.
|
370 |
|
371 | -v, --verbose verbose mode - don't clean up &
|
372 | print _extra_ console messages
|
373 |
|
374 | --json format output as json
|
375 |
|
376 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
377 | this command invocation
|
378 | ```
|
379 |
|
380 | _See code: [src/commands/fonteva/sfpm/copy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/sfpm/copy.ts)_
|
381 |
|
382 | ## `sfdx fonteva:sfpm:install [-s] [-n <string>] [-k] [-d] [-v] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
383 |
|
384 | Salesforce Package Manager
|
385 |
|
386 | ```
|
387 | USAGE
|
388 | $ sfdx fonteva:sfpm:install [-s] [-n <string>] [-k] [-d] [-v] [--json] [--loglevel
|
389 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
390 |
|
391 | OPTIONS
|
392 | -d, --debug debug mode - don't clean up & print
|
393 | console messages
|
394 |
|
395 | -k, --skip-npm Skip the npm step. You probably
|
396 | shouldn't set this
|
397 |
|
398 | -n, --namespace=namespace passed on to webpack as
|
399 | output.library. Use to namespace
|
400 | javascript libraries.
|
401 |
|
402 | -s, --save pass-thru to npm
|
403 |
|
404 | -v, --verbose verbose mode - don't clean up &
|
405 | print _extra_ console messages
|
406 |
|
407 | --json format output as json
|
408 |
|
409 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
410 | this command invocation
|
411 | ```
|
412 |
|
413 | _See code: [src/commands/fonteva/sfpm/install.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/sfpm/install.ts)_
|
414 |
|
415 | ## `sfdx fonteva:sharingSets:deploy [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
416 |
|
417 | Deploys sharing sets to your org
|
418 |
|
419 | ```
|
420 | USAGE
|
421 | $ sfdx fonteva:sharingSets:deploy [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
422 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
423 |
|
424 | OPTIONS
|
425 | -u, --targetusername=targetusername username or alias for the target
|
426 | org; overrides default target org
|
427 |
|
428 | --apiversion=apiversion override the api version used for
|
429 | api requests made by this command
|
430 |
|
431 | --json format output as json
|
432 |
|
433 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
434 | this command invocation
|
435 | ```
|
436 |
|
437 | _See code: [src/commands/fonteva/sharingSets/deploy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/sharingSets/deploy.ts)_
|
438 |
|
439 | ## `sfdx fonteva:swapAndDeploy [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
|
440 |
|
441 | Do a namespace swap for a source-format project and deploy
|
442 |
|
443 | ```
|
444 | USAGE
|
445 | $ sfdx fonteva:swapAndDeploy [--unpackaged] [-u <string>] [--apiversion <string>] [--json] [--loglevel
|
446 | trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
|
447 |
|
448 | OPTIONS
|
449 | -u, --targetusername=targetusername username or alias for the target
|
450 | org; overrides default target org
|
451 |
|
452 | --apiversion=apiversion override the api version used for
|
453 | api requests made by this command
|
454 |
|
455 | --json format output as json
|
456 |
|
457 | --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
|
458 | this command invocation
|
459 |
|
460 | --unpackaged Deploy unpackaged code, not the main
|
461 | codebase.
|
462 |
|
463 | EXAMPLE
|
464 | $ sfdx fonteva:swapAndDeploy -u devorg123 // connects to the org specified, determines the namespace, swaps namespace
|
465 | into a temp folder, then deploys
|
466 | ```
|
467 |
|
468 | _See code: [src/commands/fonteva/swapAndDeploy.ts](https://github.com/Fonteva/sfdx-plugin/blob/v0.3.17/src/commands/fonteva/swapAndDeploy.ts)_
|
469 |
|
470 |
|
471 | # Debugging your plugin
|
472 | We 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.
|
473 |
|
474 | To debug the `hello:org` command:
|
475 | 1. Start the inspector
|
476 |
|
477 | If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
|
478 | ```sh-session
|
479 | $ sfdx hello:org -u myOrg@example.com --dev-suspend
|
480 | ```
|
481 |
|
482 | Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
|
483 | ```sh-session
|
484 | $ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
|
485 | ```
|
486 |
|
487 | 2. Set some breakpoints in your command code
|
488 | 3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
|
489 | 4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
|
490 | 5. 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.
|
491 | 6. 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).
|
492 | <br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
|
493 | Congrats, you are debugging!
|