Install Mobile Extensions

Install the Mobile Extensions Plug-in

1. If you haven’t yet installed Salesforce CLI on your development machine, see Install the Salesforce CLI.
2. Install the Mobile Extensions plug-in:
   1sf plugins install @salesforce/lwc-dev-mobile

   A message that the plug-in isn’t digitally signed is expected and isn’t a cause for concern.
3. If you’re prompted to continue installation, enter y.
4. To see the available commands, use grep with sf commands, which lists the commands with a space separator rather than a colon. Salesforce CLI commands accept either separator. For example, the setup command is in the force lightning local topic, while the preview command is in the force lightning lwc topic:
   1sf commands | grep "force lightning local" 
   2 force lightning local device create          Create a virtual mobile device                                                                                                                               
   3 force lightning local device list            List the available virtual mobile devices for Lightning Web Component development.                                                                           
   4 force lightning local device start           Start a virtual mobile device                                                                                                                                
   5 force lightning local setup                  Set up mobile environment for Lightning Web Component development.
   6
   7sf commands | grep "force lightning lwc"
   8 force lightning lwc preview                  Preview Lightning Web Components in a virtual mobile environment                                                                                             
   9 force lightning lwc start                    Develop Lightning Web Component modules and see live changes without publishing your components to an org.                                                   
   10 force lightning lwc test create              creates a Lightning web component test file with boilerplate code inside a __tests__ directory.                                                              
   11 force lightning lwc test run                 invokes Lightning Web Components Jest unit tests.                                                                                                            
   12 force lightning lwc test setup               install Jest unit testing tools for Lightning Web Components.                                                                                                
   13 force lightning lwc test ui mobile configure Create a configuration file for running UTAM tests on mobile.                                                                                                
   14 force lightning lwc test ui mobile run       Run UTAM test by specifying a WDIO configuration. Test specs to run can be explicitly specified by using a flag.

   To see the syntax of the available commands, call each command with the --help argument. For example:
   1sf force:lightning:local:setup --help
   2sf force:lightning:lwc:preview --help

Check Your Development Environment

To verify that your development environment meets Mobile Extensions requirements, run the setup command. This command runs a series of tests that checks the presence and versions of your mobile platform libraries, tools, and virtual device configurations. If the command detects problems, it prints hints for solving them in the Terminal console or Windows command prompt.

1sf force:lightning:local:setup -p <platform_name>

1. Check your Android setup status.
   1sf force:lightning:local:setup -p android

   1. If your setup is correct, this command prints “Passed” status for all tests. You’re ready to start previewing components on Android!
   2. If any test fails, follow the suggestions printed in the console to finish setting up your Android environment. To review setup instructions, see Set Up Android Studio.
   3. Repeat this step until all tests report “Passed”.
2. Check your iOS setup status.
   1sf force:lightning:local:setup -p ios

   1. If your setup is correct, this command prints “Passed” status for all tests. You’re ready to start previewing components on iOS!
   2. If any test fails, follow the suggestions printed in the console to finish setting up your iOS environment. To review setup instructions, see Set Up Xcode.
   3. Repeat this step until all tests report “Passed”.

Check Your Available Virtual Devices

1sf force:lightning:local:device:list -p <platform_name>

Create a Virtual Device

1sf force:lightning:local:device:create -n <name> -d <device_type> -p [ios|android] 
2    [-l <android_api_level>]

This command starts by running the force:lightning:local:setup command. If that command reports failures, address the first reported failure, and then retry the force:create command.

If you specify a device name that already exists on your machine, the command exits with the message “A virtual device with the name '<existing_name>' already exists.”

Start a Virtual Device

To launch a virtual device, use the following command.

1sf force:lightning:local:device:start -p [ios|android] -t <virtual_device_name>] 
2    [-w <true|false>]

• -p, --platform

  Mobile platform of the target device. Can be Android or iOS (case insensitive).

  -t, --target

  Name of the virtual device to launch.

  -w, --writablesystem

  (Optional, Android only) Doesn’t accept a value. If present, the virtual device launches with a writable system. Otherwise, the system is read-only.

• Two other parameters—--json and --loglevel—are standard Salesforce CLI conventions and aren’t part of the setup functionality.