{"id":13668375,"url":"https://github.com/forcedotcom/lwc-dev-mobile","last_synced_at":"2025-06-19T05:11:46.396Z","repository":{"id":42544045,"uuid":"249553552","full_name":"forcedotcom/lwc-dev-mobile","owner":"forcedotcom","description":null,"archived":false,"fork":false,"pushed_at":"2025-06-12T20:45:31.000Z","size":2421,"stargazers_count":25,"open_issues_count":10,"forks_count":11,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-06-12T21:48:06.085Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/forcedotcom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-23T21:59:32.000Z","updated_at":"2025-02-21T19:26:39.000Z","dependencies_parsed_at":"2024-01-14T16:14:10.621Z","dependency_job_id":"bfb03fb0-8a81-4574-8f0f-98d26164b528","html_url":"https://github.com/forcedotcom/lwc-dev-mobile","commit_stats":{"total_commits":309,"total_committers":12,"mean_commits":25.75,"dds":0.5275080906148868,"last_synced_commit":"1b6eedf70ac3eaa1a54c88a1cdd7c37b15764c64"},"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/forcedotcom/lwc-dev-mobile","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcedotcom%2Flwc-dev-mobile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcedotcom%2Flwc-dev-mobile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcedotcom%2Flwc-dev-mobile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcedotcom%2Flwc-dev-mobile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/forcedotcom","download_url":"https://codeload.github.com/forcedotcom/lwc-dev-mobile/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/forcedotcom%2Flwc-dev-mobile/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260690921,"owners_count":23047102,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T08:00:33.203Z","updated_at":"2025-06-19T05:11:41.386Z","avatar_url":"https://github.com/forcedotcom.png","language":"TypeScript","funding_links":[],"categories":["Official plugins/modules from Salesforce"],"sub_categories":[],"readme":"[![codecov](https://codecov.io/gh/forcedotcom/lwc-dev-mobile/branch/main/graph/badge.svg?token=K8NM7ABTL1)](https://codecov.io/gh/forcedotcom/lwc-dev-mobile)\n[![MIT license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)\n[![npm (scoped)](https://img.shields.io/npm/v/@salesforce/lwc-dev-mobile?color=blue)](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)\n[![npm (scoped)](https://img.shields.io/npm/v/@salesforce/lwc-dev-mobile/beta?color=orange)](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)\n[![Downloads](https://img.shields.io/npm/dt/@salesforce/lwc-dev-mobile)](https://www.npmjs.com/package/@salesforce/lwc-dev-mobile?activeTab=versions)\n\n# Salesforce CLI Mobile Extensions\n\nThe Salesforce CLI Mobile Extensions allow you to extend the local preview capabilities of the [Local Development Server plug-in](https://developer.salesforce.com/tools/vscode/en/localdev/lwclocaldev). You can see live previews of your Lightning Web Components on virtual mobile devices for iOS and Android.\n\n\n**Note:** This feature is in beta, and may contain significant problems, undergo major changes, or be discontinued. If you encounter any problems, or want to request an enhancement, please open a [GitHub Issue](https://github.com/forcedotcom/lwc-dev-mobile/issues).\n\n# Setup\n\n## System Requirements\n\n- Developer Hub-enabled org\n- Most recent stable version of Chrome, Firefox, Safari, or Edge web browser\n- Supported Windows versions: Windows 10 or later\n- Supported Mac versions: macOS 10.14.4 or later\n- Salesforce CLI\n\nTo develop Lightning web components, use your favorite code editor. We recommend using Visual Studio Code because its [Salesforce Extensions for VS Code](https://developer.salesforce.com/tools/extension_vscode) provide powerful features for development on Lightning Platform.\n\n## Installation\n\n1. Open a new terminal window and run the following command to install the Mobile Extensions:\n\n        sfdx plugins:install @salesforce/lwc-dev-mobile\n        \n2. Check for updates to the plug-in:\n\n        sfdx plugins:update\n\n## Running\n\n### Prerequisites\n\nThe Mobile Extensions plug-in can run only in the context of an SFDX project.  See the [installation instructions](https://www.npmjs.com/package/@salesforce/lwc-dev-server#installation) of the Local Development plug-in for all SFDX project setup requirements.\n\n### Usage\n\nThe Mobile Extensions plug-in supports two commands.\n\n#### Setup\n\nSetup helps you set up virtual mobile devices—iOS simulators and Android emulators—in your local environment.\n\n\n```\nsfdx force:lightning:local:setup -p \u003cmobile platform\u003e\n```\n\n- `-p, --platform=platform` Specify platform (iOS or Android)\n\nFor example:\n\n```sh-session\n$ sfdx force:lightning:local:setup -p iOS\n```\n\n#### Preview\n\nPreview extends the local preview capabilities of the [Local Development Server plug-in](https://developer.salesforce.com/tools/vscode/en/localdev/lwclocaldev). With Mobile Extensions, you can use this plug-in to preview your Lightning Web Components on virtual mobile devices.\n\n```\nsfdx force:lightning:lwc:preview -n \u003ccomponent name\u003e -p \u003cmobile platform\u003e] [-t \u003ctarget\u003e]\n```\n\n- `-n, --componentname=componentname` The LWC component name\n- `-p, --platform=platform` Specify platform (iOS or Android)\n- `-t, --target=target` Specify name of target simulator or emulator\n\nFor example:\n\n```sh-session\n$ sfdx force:lightning:lwc:preview -p Android -t LWCEmulator -n HelloWorldLwcComponent\n```\n\n## Visual Studio Code\n\nWe also provide a Visual Studio Code extension that exposes the Preview functionality through the IDE. That functionality is currently developed as part of the [Salesforce Extensions for VS Code](https://github.com/forcedotcom/salesforcedx-vscode).\n\n## Plugin Development\n\nIf you intend to develop or test drive the plug-in locally, this section will help you set up your development environment.\n\n### Checkout and Build Locally\n\nAfter you clone or fork this repo, run the following commands in the root folder of your local repo:\n\n```sh-session\n$ yarn install \u0026\u0026 yarn build\n$ yarn test \n```\n\n### Install the Plug-in\n\nFrom the top-level folder of the plug-in:\n\n```sh-session\n$ sfdx plugins:link .\n```\n\n### Uninstall the Plug-in\n\nFrom the top-level folder of the plug-in:\n\n```sh-session\n$ sfdx plugins:uninstall . \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforcedotcom%2Flwc-dev-mobile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fforcedotcom%2Flwc-dev-mobile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fforcedotcom%2Flwc-dev-mobile/lists"}