22
33<!-- commands -->
44
5- - [ ` sf webapp deploy ` ] ( #sf-webapp-deploy )
65- [ ` sf webapp dev ` ] ( #sf-webapp-dev )
76- [ ` sf webapp generate ` ] ( #sf-webapp-generate )
8- - [ ` sf webapp retrieve ` ] ( #sf-webapp-retrieve )
9-
10- ## ` sf webapp deploy `
11-
12- Deploy the web app, its assets and associated metadata
13-
14- ```
15- USAGE
16- $ sf webapp deploy -n <value> [--json] [--flags-dir <value>] [-o build|validate]
17-
18- FLAGS
19- -n, --name=<value> (required) Name of your web app
20- -o, --options=<option> [default: build] Deployment options (build or validate)
21- <options: build|validate>
22-
23- GLOBAL FLAGS
24- --flags-dir=<value> Import flag values from a directory.
25- --json Format output as json.
26-
27- DESCRIPTION
28- Deploy the web app, its assets and associated metadata
29-
30- This command deploys your web app, its assets, and associated metadata to your Salesforce org. Use the build option
31- to build and deploy, or the validate option to check deployment without making changes.
32-
33- EXAMPLES
34- Deploy a web app:
35-
36- $ sf webapp deploy --name myWebApp
37-
38- Deploy a web app with specific options:
39-
40- $ sf webapp deploy --name myWebApp --options build
41- ```
427
438## ` sf webapp dev `
449
4510Preview a web app locally without needing to deploy
4611
4712```
4813USAGE
49- $ sf webapp dev -n <value> [--json] [--flags-dir <value>] [-t <value>] [-r <value>] [-p <value>]
50- [--host <value>] [--no-open]
14+ $ sf webapp dev -n <value> [--json] [--flags-dir <value>] [-t <value>] [-p <value>]
5115
5216FLAGS
53- -n, --name=<value> (required) Identifies the Web Application
54- -p, --port=<value> [default: 8080] Port for the dev server
55- -r, --root-dir=<value> Optional override for the local project root of the given Web Application
56- -t, --target=<value> Selects which Web Application target to use for the preview (e.g., Lightning App, Site)
57- --host=<value> [default: localhost] Host to bind to
58- --no-open Do not automatically open the browser
17+ -n, --name=<value> (required) Identifies the Web Application
18+ -p, --port=<value> [default: 5173] Port for the dev server
19+ -t, --target=<value> Selects which Web Application target to use for the preview (e.g., Lightning App, Site)
5920
6021GLOBAL FLAGS
6122 --flags-dir=<value> Import flag values from a directory.
@@ -76,34 +37,23 @@ EXAMPLES
7637
7738 $ sf webapp dev --name myWebApp --target "LightningApp"
7839
79- Start the development server on a custom port and host:
80-
81- $ sf webapp dev --name myWebApp --port 8080 --host 0.0.0.0
82-
83- Start the development server with custom root directory:
84-
85- $ sf webapp dev --name myWebApp --root-dir ./webapps/myWebApp
86-
87- Start the development server without opening the browser:
40+ Start the development server on a custom port:
8841
89- $ sf webapp dev --name myWebApp --no-open
42+ $ sf webapp dev --name myWebApp --port 8080
9043```
9144
9245## ` sf webapp generate `
9346
94- Create a web app and associated metadata
47+ Create a web app and associated metadata.
9548
9649```
9750USAGE
98- $ sf webapp generate -n <value> -l <value> [--json] [--flags-dir <value>] [-t Site|Embed|Lightning]
99- [-r <value>] [-w]
51+ $ sf webapp generate -n <value> -l <value> [--json] [--flags-dir <value>] [-t <value>] [-w]
10052
10153FLAGS
10254 -l, --label=<value> (required) Human readable name of your web app
10355 -n, --name=<value> (required) Name of your web app
104- -r, --template=<value> [default: empty] Template to use for web app generation (pulls from central solution)
105- -t, --target=<option> [default: empty] Target platform for the web app (Site, Embed, or Lightning)
106- <options: Site|Embed|Lightning>
56+ -t, --template=<value> [default: empty] Template to use for web app generation (pulls from central solution)
10757 -w, --wizard Run in interactive wizard mode
10858
10959GLOBAL FLAGS
@@ -121,54 +71,13 @@ EXAMPLES
12171
12272 $ sf webapp generate --name "myWebApp" --label "My first Web App"
12373
124- Create a web app with a specific target :
74+ Create a web app with a specific template :
12575
126- $ sf webapp generate --name "myWebApp" --label "My Web App" --target Site
76+ $ sf webapp generate --name "myWebApp" --label "My Web App" --template "React app starter"
12777
12878 Create a web app using the wizard:
12979
13080 $ sf webapp generate --name "myWebApp" --label "My Web App" --wizard
13181```
13282
133- ## ` sf webapp retrieve `
134-
135- Retrieve the web app, its assets and associated metadata
136-
137- ```
138- USAGE
139- $ sf webapp retrieve -n <value> [--json] [--flags-dir <value>] [--no-overwrite] [-i <value>]
140-
141- FLAGS
142- -i, --ignore=<value> File pattern to ignore during retrieval (e.g., "dist/**")
143- -n, --name=<value> (required) Name of your web app to retrieve
144- --no-overwrite Prevent overwriting existing local files
145-
146- GLOBAL FLAGS
147- --flags-dir=<value> Import flag values from a directory.
148- --json Format output as json.
149-
150- DESCRIPTION
151- Retrieve the web app, its assets and associated metadata
152-
153- This command retrieves your web app, its assets, and associated metadata from your Salesforce org to your local
154- environment. Useful for syncing remote changes or setting up a local development environment.
155-
156- EXAMPLES
157- Retrieve a web app:
158-
159- $ sf webapp retrieve --name myWebApp
160-
161- Retrieve a web app with overwrite protection:
162-
163- $ sf webapp retrieve --name myWebApp --no-overwrite
164-
165- Retrieve a web app while ignoring specific files:
166-
167- $ sf webapp retrieve --name myWebApp --ignore "dist/**"
168-
169- Retrieve with both options:
170-
171- $ sf webapp retrieve --name "myWebApp" --no-overwrite --ignore "dist/**"
172- ```
173-
17483<!-- commandsstop -->
0 commit comments