@@ -108,41 +108,118 @@ sf plugins
108
108
109
109
<!-- commands -->
110
110
111
- - [ ` sf hello world ` ] ( #sf-hello-world )
111
+ - [ ` sf lightning dev app ` ] ( #sf-lightning-dev-app )
112
+ - [ ` sf lightning dev site ` ] ( #sf-lightning-dev-site )
112
113
113
- ## ` sf hello world `
114
+ ## ` sf lightning dev app `
114
115
115
- Say hello .
116
+ Preview a Lightning Experience app locally and in real-time, without deploying it .
116
117
117
118
```
118
119
USAGE
119
- $ sf hello world [--json] [--flags-dir <value>] [-n <value>]
120
+ $ sf lightning dev app -o <value> [--json] [--flags-dir <value>] [-n <value>] [-t desktop|ios|android] [-i <value>]
120
121
121
122
FLAGS
122
- -n, --name=<value> [default: World] The name of the person you'd like to say hello to.
123
+ -i, --device-id=<value> ID of the mobile device to display the preview if device type is set to `ios` or
124
+ `android`. The default value is the ID of the first available mobile device.
125
+ -n, --name=<value> Name of the Lightning Experience app to preview.
126
+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
127
+ configuration variable is already set.
128
+ -t, --device-type=<option> [default: desktop] Type of device to display the app preview.
129
+ <options: desktop|ios|android>
123
130
124
131
GLOBAL FLAGS
125
132
--flags-dir=<value> Import flag values from a directory.
126
- --json Format output as JSON .
133
+ --json Format output as json .
127
134
128
135
DESCRIPTION
129
- Say hello .
136
+ Preview a Lightning Experience app locally and in real-time, without deploying it .
130
137
131
- Say hello either to the world or someone you know.
138
+ Use Local Dev (Beta) to see local changes to your app in a real-time preview that you don't have to deploy or manually
139
+ refresh. To let you quickly iterate on your Lightning web components (LWCs) and pages, your app preview automatically
140
+ refreshes when Local Dev detects source code changes.
141
+
142
+ When you edit these local files with Local Dev enabled, your org automatically reflects these changes.
143
+
144
+ - Basic HTML and CSS edits to LWCs
145
+ - JavaScript changes to LWCs that don't affect the component's public API
146
+ - Importing new custom LWCs
147
+ - Importing another instance of an existing LWC
148
+
149
+ To apply any other local changes not listed above, you must deploy them to your org using the `sf project deploy
150
+ start` command.
151
+
152
+ When you make changes directly in your org (like saving new component properties), they're automatically deployed to
153
+ your live app. To update your local version of the app with those changes, you must retrieve them from your org using
154
+ the `sf project retrieve start` command.
155
+
156
+ To learn more about Local Dev enablement, considerations, and limitations, see the Lightning Web Components Developer
157
+ Guide.
132
158
133
159
EXAMPLES
134
- Say hello to the world:
160
+ Preview the default app for the target org "myOrg" in a desktop environment:
161
+
162
+ $ sf lightning dev app --target-org myOrg
163
+
164
+ Preview the app "myApp" for the target org "myOrg" in a desktop environment:
165
+
166
+ $ sf lightning dev app --name MyApp --target-org myOrg --device-type desktop
167
+
168
+ Preview the default app for target org "myOrg" on an iOS device:
169
+
170
+ $ sf lightning dev app --target-org myOrg --device-type ios --device-id "iPhone 15 Pro Max"
171
+ ```
172
+
173
+ _ See code: [ src/commands/lightning/dev/app.ts] ( https://github.com/salesforcecli/plugin-lightning-dev/blob/0.1.0-alpha.0/src/commands/lightning/dev/app.ts ) _
174
+
175
+ ## ` sf lightning dev site `
176
+
177
+ Preview an Experience Builder site locally and in real-time, without deploying it.
178
+
179
+ ```
180
+ USAGE
181
+ $ sf lightning dev site [--json] [--flags-dir <value>] [-n <value>] [--debug] [-o <value>]
182
+
183
+ FLAGS
184
+ -n, --name=<value> Name of the Experience Builder site to preview. It has to match a site name from the current
185
+ org.
186
+ -o, --target-org=<value> Username or alias of the target org. Not required if the `target-org` configuration variable
187
+ is already set.
188
+ --debug Enable Node Inspector to debug server-side rendering.
135
189
136
- $ sf hello world
190
+ GLOBAL FLAGS
191
+ --flags-dir=<value> Import flag values from a directory.
192
+ --json Format output as json.
193
+
194
+ DESCRIPTION
195
+ Preview an Experience Builder site locally and in real-time, without deploying it.
137
196
138
- Say hello to someone you know:
197
+ Enable Local Dev to see local changes to your site in a real-time preview that you don't have to deploy or manually
198
+ refresh. To let you quickly iterate on your Lightning web components (LWCs) and pages, your site preview automatically
199
+ refreshes when Local Dev detects source code changes.
139
200
140
- $ sf hello world --name Astro
201
+ When you edit these local files with Local Dev enabled, your org automatically reflects these changes.
141
202
142
- FLAG DESCRIPTIONS
143
- -n, --name=<value> The name of the person you'd like to say hello to.
203
+ - Basic HTML and CSS edits to LWCs
204
+ - JavaScript changes to LWCs that don't affect the component's public API
205
+ - Importing new custom LWCs
206
+ - Importing another instance of an existing LWC
144
207
145
- This person can be anyone in the world!
208
+ To apply any other local changes not listed above, you must deploy them to your org using the `sf project deploy
209
+ start` command. Then republish your site and restart the server for the Local Dev experience.
210
+
211
+ For more considerations and limitations, see the Lightning Web Components Developer Guide.
212
+
213
+ EXAMPLES
214
+ Preview the site "Partner Central" from the org "myOrg":
215
+
216
+ $ sf lightning dev site --name "Partner Central" --target-org myOrg
217
+
218
+ Preview the site "Partner Central" from the org "myOrg" with Node Inspector enabled:
219
+
220
+ $ sf lightning dev site --name "Partner Central" --target-org myOrg --debug
146
221
```
147
222
223
+ _ See code: [ src/commands/lightning/dev/site.ts] ( https://github.com/salesforcecli/plugin-lightning-dev/blob/0.1.0-alpha.0/src/commands/lightning/dev/site.ts ) _
224
+
148
225
<!-- commandsstop -->
0 commit comments