sf webapp dev command @W-20242483@ (#6)

Author: deepu-mungamuri94

COMMANDS.md

@@ -3,7 +3,6 @@
 <!-- commands -->
 
 - [`sf webapp dev`](#sf-webapp-dev)
-- [`sf webapp generate`](#sf-webapp-generate)
 
 ## `sf webapp dev`
 
@@ -42,42 +41,4 @@ EXAMPLES
     $ sf webapp dev --name myWebApp --port 8080
 ```
 
-## `sf webapp generate`
-
-Create a web app and associated metadata.
-
-```
-USAGE
-  $ sf webapp generate -n <value> -l <value> [--json] [--flags-dir <value>] [-t <value>] [-w]
-
-FLAGS
-  -l, --label=<value>     (required) Human readable name of your web app
-  -n, --name=<value>      (required) Name of your web app
-  -t, --template=<value>  [default: empty] Template to use for web app generation (pulls from central solution)
-  -w, --wizard            Run in interactive wizard mode
-
-GLOBAL FLAGS
-  --flags-dir=<value>  Import flag values from a directory.
-  --json               Format output as json.
-
-DESCRIPTION
-  Create a web app and associated metadata.
-
-  This command creates a new web app with the specified configuration, including the basic structure and metadata
-  files.
-
-EXAMPLES
-  Create an empty web app:
-
-    $ sf webapp generate --name "myWebApp" --label "My first Web App"
-
-  Create a web app with a specific template:
-
-    $ sf webapp generate --name "myWebApp" --label "My Web App" --template "React app starter"
-
-  Create a web app using the wizard:
-
-    $ sf webapp generate --name "myWebApp" --label "My Web App" --wizard
-```
-
 <!-- commandsstop -->

LICENSE.txt

@@ -1,6 +1,6 @@
 Apache License Version 2.0
 
-Copyright (c) 2025 Salesforce, Inc.
+Copyright (c) 2026 Salesforce, Inc.
 All rights reserved.
 
                                  Apache License

README.md

@@ -40,12 +40,69 @@ Additionally, there are some additional tests that the Salesforce CLI will enfor
 - [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
 - [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
 
-# Everything past here is only a suggestion as to what should be in your specific plugin's description
+# Salesforce CLI Webapp Plugin
+
+A Salesforce CLI plugin for building and deploying web applications that integrate with Salesforce. This plugin provides tools for local development, packaging, and deployment of webapps with built-in Salesforce authentication.
 
 This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
 
 We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
 
+## Features
+
+- 🔐 **Local Development Proxy** - Run webapps locally with automatic Salesforce authentication
+- 🌐 **Intelligent Request Routing** - Automatically routes requests between Salesforce APIs and dev servers
+- 🔄 **Dev Server Management** - Spawns and monitors dev servers (Vite, CRA, Next.js)
+- 🎨 **Beautiful Error Handling** - HTML error pages with auto-refresh and diagnostics
+- 💚 **Health Monitoring** - Periodic health checks with status updates
+- 🔧 **Hot Config Reload** - Detects `webapp.json` changes automatically
+
+## Quick Start
+
+1. **Install the plugin:**
+
+   ```bash
+   sf plugins install @salesforce/plugin-webapp
+   ```
+
+2. **Authenticate with Salesforce:**
+
+   ```bash
+   sf org login web --alias myorg
+   ```
+
+3. **Create webapp.json:**
+
+   ```json
+   {
+     "name": "myapp",
+     "label": "My Web App",
+     "version": "1.0.0",
+     "apiVersion": "60.0",
+     "outputDir": "dist",
+     "dev": {
+       "command": "npm run dev"
+     }
+   }
+   ```
+
+4. **Start development:**
+   ```bash
+   sf webapp dev --name myapp --target-org myorg --open
+   ```
+
+## Documentation
+
+📚 **[Complete Guide](SF_WEBAPP_DEV_GUIDE.md)** - Comprehensive documentation covering:
+- Overview and architecture
+- Getting started (5-minute quick start)
+- Building the plugin
+- Command usage and options
+- File structure and components
+- VSCode integration
+- Advanced features (hot reload, error capture, etc.)
+- Troubleshooting and FAQ
+
 ## Install
 
 ```bash
@@ -105,45 +162,65 @@ sf plugins
 
 ## Commands
 
-<!-- commands -->
+### `sf webapp dev`
 
-- [`sf hello world`](#sf-hello-world)
+Start a local development proxy server for webapp development with Salesforce authentication.
 
-## `sf hello world`
-
-Say hello.
-
-```
+```bash
 USAGE
-  $ sf hello world [--json] [--flags-dir <value>] [-n <value>]
+  $ sf webapp dev --name <webapp-name> --target-org <org-alias> [options]
+
+REQUIRED FLAGS
+  -n, --name=<value>         Name of the webapp (must match webapp.json)
+  -o, --target-org=<value>   Salesforce org to authenticate against
 
-FLAGS
-  -n, --name=<value>  [default: World] The name of the person you'd like to say hello to.
+OPTIONAL FLAGS
+  -u, --url=<value>          Dev server URL (overrides webapp.json)
+  -p, --port=<value>         Proxy server port (default: 4545)
+  --open                     Open browser automatically
 
 GLOBAL FLAGS
-  --flags-dir=<value>  Import flag values from a directory.
-  --json               Format output as json.
+  --flags-dir=<value>        Import flag values from a directory
+  --json                     Format output as json
 
 DESCRIPTION
-  Say hello.
+  Start a local development proxy server for webapp development.
 
-  Say hello either to the world or someone you know.
+  This command starts a local HTTP proxy server that handles Salesforce
+  authentication and routes requests between your local dev server and
+  Salesforce APIs. It automatically spawns and monitors your dev server,
+  detects the URL, and provides health monitoring.
 
 EXAMPLES
-  Say hello to the world:
+  Start proxy with automatic dev server management:
 
-    $ sf hello world
+    $ sf webapp dev --name myapp --target-org myorg --open
 
-  Say hello to someone you know:
+  Use existing dev server:
 
-    $ sf hello world --name Astro
+    $ sf webapp dev --name myapp --target-org myorg --url http://localhost:5173 --open
 
-FLAG DESCRIPTIONS
-  -n, --name=<value>  The name of the person you'd like to say hello to.
+  Use custom proxy port:
 
-    This person can be anyone in the world!
-```
+    $ sf webapp dev --name myapp --target-org myorg --port 8080 --open
 
-_See code: [src/commands/hello/world.ts](https://github.com/salesforcecli/plugin-webapp/blob/1.1.73/src/commands/hello/world.ts)_
+SUPPORTED DEV SERVERS
+  - Vite
+  - Create React App (Webpack)
+  - Next.js
+  - Any server that outputs http://localhost:PORT
+
+FEATURES
+  - Automatic Salesforce authentication injection
+  - Intelligent request routing (Salesforce vs dev server)
+  - WebSocket support for Hot Module Replacement (HMR)
+  - Beautiful HTML error pages with auto-refresh
+  - Periodic health monitoring (every 5s)
+  - Configuration file watching (webapp.json)
+  - Graceful shutdown on Ctrl+C
+
+SEE ALSO
+  - Complete Guide: SF_WEBAPP_DEV_GUIDE.md
+```
 
 <!-- commandsstop -->