Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
21b892a
refactor: rename webapp dev command and plugin to ui-bundle
deepu-mungamuri94 Mar 27, 2026
e3c9bf5
refactor: rename webapp references to ui-bundle and update package im…
deepu-mungamuri94 Mar 29, 2026
cdcde2c
Merge branch 'main' into rename-webapp-to-ui-bundle
deepu-mungamuri94 Mar 29, 2026
5dbfaf5
docs: update SF_UI_BUNDLE_DEV_GUIDE with ui-bundle naming
deepu-mungamuri94 Mar 29, 2026
58596ad
docs: replace app-based example names with bundle in messages
deepu-mungamuri94 Mar 29, 2026
1e84822
fix: align moduleResolution with ui-bundle package build target
deepu-mungamuri94 Mar 29, 2026
3545a5f
chore: switch @salesforce/ui-bundle from local file link to npm ^1.117.2
deepu-mungamuri94 Mar 29, 2026
204790b
Update schemas/ui__bundle-dev.json
deepu-mungamuri94 Mar 29, 2026
e1d731a
docs: update COMMANDS.md and README.md to ui-bundle naming
deepu-mungamuri94 Mar 29, 2026
f396f44
chore: regenerate json schema after description update
deepu-mungamuri94 Mar 29, 2026
cc79fd5
docs: update package name references to plugin-ui-bundle-dev in README
deepu-mungamuri94 Mar 29, 2026
0068ce1
chore: bump @salesforce/ui-bundle to ^1.117.3
deepu-mungamuri94 Mar 29, 2026
c500f88
fix: update Vite proxy test helper header from WebApp to UiBundle
deepu-mungamuri94 Mar 29, 2026
3cddf3d
Merge branch 'main' into rename-webapp-to-ui-bundle
deepu-mungamuri94 Mar 30, 2026
211001a
docs: expand UI bundle description in command help
garychangsf Mar 30, 2026
6f6f0d1
fix: simplify schema description for command result
garychangsf Mar 30, 2026
7b07fad
docs: update error message examples to use camelCase naming convention
garychangsf Mar 30, 2026
5230a6a
fix: regenerate yarn.lock using yarn registry URLs
garychangsf Mar 30, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.template
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Option A: AUTH_URL (simplest — recommended for getting started)
# 1. sf org login web --alias nut-org
# 2. sf org display -o nut-org --json | jq -r .result.sfdxAuthUrl
# 2. sf org display -o nut-org --verbose --json | jq -r .result.sfdxAuthUrl
Comment thread
garychangsf marked this conversation as resolved.
Outdated
# 3. Paste the value below
# TESTKIT_AUTH_URL=

Expand Down
40 changes: 22 additions & 18 deletions COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,43 +2,47 @@

<!-- commands -->

- [`sf webapp dev`](#sf-webapp-dev)
- [`sf ui-bundle dev`](#sf-webui-dev)

## `sf webapp dev`
## `sf ui-bundle dev`

Preview a web app locally without needing to deploy
Start a local development proxy server for webui ui-bundle development with Salesforce authentication.
Comment thread
deepu-mungamuri94 marked this conversation as resolved.
Outdated

```
USAGE
$ sf webapp dev -n <value> [--json] [--flags-dir <value>] [-t <value>] [-p <value>]
$ sf ui-bundle dev -n <value> -o <value> [--json] [--flags-dir <value>] [-u <value>] [-p <value>] [--open]

FLAGS
-n, --name=<value> (required) Identifies the Web Application
-p, --port=<value> [default: 5173] Port for the dev server
-t, --target=<value> Selects which Web Application target to use for the preview (e.g., Lightning App, Site)
REQUIRED FLAGS
-n, --name=<value> Name of the webapp (must match webapplication.json)
Comment thread
deepu-mungamuri94 marked this conversation as resolved.
Outdated
-o, --target-org=<value> Salesforce org to authenticate against

OPTIONAL FLAGS
-u, --url=<value> Dev server URL. Command mode: override default 5173. URL-only: required (server must be running)
-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.

DESCRIPTION
Preview a web app locally without needing to deploy

Starts a local development server for a Web Application, using the local project files. This enables rapid
development with hot reloading and immediate feedback.
Starts a local HTTP proxy that injects Salesforce authentication and routes
requests between your dev server and Salesforce APIs. In command mode,
spawns and monitors the dev server (default URL: localhost:5173). In
URL-only mode, connects to an already-running dev server.

EXAMPLES
Start the development server:
Command mode (CLI starts dev server, default port 5173):

$ sf webapp dev --name myWebApp
$ sf ui-bundle dev --name myapp --target-org myorg --open
Comment thread
deepu-mungamuri94 marked this conversation as resolved.
Outdated

Start the development server with a specific target:
URL-only mode (dev server already running):

$ sf webapp dev --name myWebApp --target "LightningApp"
$ sf ui-bundle dev --name myapp --target-org myorg --url http://localhost:5173 --open

Start the development server on a custom port:
Custom proxy port:

$ sf webapp dev --name myWebApp --port 8080
$ sf ui-bundle dev --name myapp --target-org myorg --port 8080 --open
```

<!-- commandsstop -->
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# plugin-app-dev
# plugin-ui-bundle-dev

[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-app-dev.svg?label=@salesforce/plugin-app-dev)](https://www.npmjs.com/package/@salesforce/plugin-app-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-app-dev.svg)](https://npmjs.org/package/@salesforce/plugin-app-dev) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-ui-bundle-dev.svg?label=@salesforce/plugin-ui-bundle-dev)](https://www.npmjs.com/package/@salesforce/plugin-ui-bundle-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-ui-bundle-dev.svg)](https://npmjs.org/package/@salesforce/plugin-ui-bundle-dev) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)

# Salesforce CLI App Dev Plugin

Expand All @@ -24,7 +24,7 @@ We always recommend using the latest version of these commands bundled with the
1. **Install the plugin:**

```bash
sf plugins install @salesforce/plugin-app-dev
sf plugins install @salesforce/plugin-ui-bundle-dev
```

2. **Authenticate with Salesforce:**
Expand All @@ -50,12 +50,12 @@ We always recommend using the latest version of these commands bundled with the

4. **Start development:**
```bash
sf webapp dev --name myapp --target-org myorg --open
sf ui-bundle dev --name myapp --target-org myorg --open
```

## Documentation

📚 **[Complete Guide](SF_WEBAPP_DEV_GUIDE.md)** - Comprehensive documentation covering:
📚 **[Complete Guide](SF_UI_BUNDLE_DEV_GUIDE.md)** - Comprehensive documentation covering:

- Overview and architecture
- Getting started (5-minute quick start)
Expand All @@ -69,7 +69,7 @@ We always recommend using the latest version of these commands bundled with the
## Install

```bash
sf plugins install @salesforce/plugin-app-dev@x.y.z
sf plugins install @salesforce/plugin-ui-bundle-dev@x.y.z
```

## Issues
Expand Down Expand Up @@ -101,7 +101,7 @@ To build the plugin locally, make sure to have yarn installed and run the follow

```bash
# Clone the repository
git clone git@github.com:salesforcecli/plugin-app-dev
git clone git@github.com:salesforcecli/plugin-ui-bundle-dev

# Install the dependencies and compile
yarn && yarn build
Expand All @@ -125,9 +125,9 @@ sf plugins

## Commands

### `sf webapp dev`
### `sf ui-bundle dev`

Start a local development proxy server for webapp development with Salesforce authentication.
Start a local development proxy server for ui-bundle development with Salesforce authentication.

**Two operating modes:**

Expand All @@ -136,7 +136,7 @@ Start a local development proxy server for webapp development with Salesforce au

```bash
USAGE
$ sf webapp dev --name <webapp-name> --target-org <org-alias> [options]
$ sf ui-bundle dev --name <webapp-name> --target-org <org-alias> [options]

REQUIRED FLAGS
-n, --name=<value> Name of the webapp (must match webapplication.json)
Expand All @@ -156,18 +156,18 @@ DESCRIPTION
EXAMPLES
Command mode (CLI starts dev server, default port 5173):

$ sf webapp dev --name myapp --target-org myorg --open
$ sf ui-bundle dev --name myapp --target-org myorg --open

URL-only mode (dev server already running):

$ sf webapp dev --name myapp --target-org myorg --url http://localhost:5173 --open
$ sf ui-bundle dev --name myapp --target-org myorg --url http://localhost:5173 --open

Custom proxy port:

$ sf webapp dev --name myapp --target-org myorg --port 8080 --open
$ sf ui-bundle dev --name myapp --target-org myorg --port 8080 --open

SEE ALSO
- Complete Guide: SF_WEBAPP_DEV_GUIDE.md
- Complete Guide: SF_UI_BUNDLE_DEV_GUIDE.md
```

<!-- commandsstop -->
Loading
Loading