Sfdx-mobilesdk-plugin NPM

sfdx-mobilesdk-plugin

A plugin for the Salesforce CLI to create mobile applications to interface with the Salesforce Platform, leveraging the Salesforce Mobile SDK for iOS and the Salesforce Mobile SDK for Android repos.

Special Note Regarding SFDX and Oclif

SFDX now supports the Heroku "O"pen "CLI" "F"ramework and sfdx-mobilesdk-plugin v7.1.0 has been updated to be compatible. The new plugin will run in both version 6 and version 7 instances of the SFDX cli. However, older versions of the mobilesdk plugin will not work in the Oclif version of the CLI.

If there is a need to use an older plugin one must first uninstall V7 of the CLI and install a V6 instance.

To determine the latest version of v6 go here:

https://www.npmjs.com/package/sfdx-cli?activeTab=versions

The most reliable way to install a previous version of the CLI is via npm.

npm install sfdx-cli@<V6 version from npmjs> -g

Setup

Install from source

Install the SDFX CLI (https://developer.salesforce.com/tools/sfdxcli).
Clone the repository: git clone git@github.com:forcedotcom/SalesforceMobileSDK-Package
Install npm modules: npm install
Generate oclif command classes ./sfdx/generate_oclif.js
Link the plugin: sfdx plugins:link sfdx

Install as plugin

Install plugin: sfdx plugins:install sfdx-mobilesdk-plugin

Help

-> sfdx mobilesdk --help
create mobile apps based on the Salesforce Mobile SDK

USAGE
  $ sfdx mobilesdk:COMMAND

TOPICS
  mobilesdk:android      create an Android native mobile application
  mobilesdk:hybrid       create a hybrid mobile application
  mobilesdk:ios          create an iOS native mobile application
  mobilesdk:reactnative  create a React Native mobile application

Create a native iOS application

Help for iOS

-> sfdx mobilesdk:ios --help
create an iOS native mobile application

USAGE
  $ sfdx mobilesdk:ios:COMMAND

COMMANDS
  mobilesdk:ios:checkconfig         validate store or syncs configuration
  mobilesdk:ios:create              create an iOS native mobile application
  mobilesdk:ios:createwithtemplate  create an iOS native mobile application from
                                    a template
  mobilesdk:ios:listtemplates       list available Mobile SDK templates to
                                    create an iOS native mobile application
  mobilesdk:ios:version             show version of Mobile SDK

Create Objective-C (native) or Swift (native_swift) application

-> sfdx mobilesdk:ios:create --help
create an iOS native mobile application

USAGE
  $ sfdx mobilesdk:ios:create

OPTIONS
  -d, --outputdir=outputdir        output directory (leave empty for current
                                   directory)

  -k, --packagename=packagename    (required) app package identifier (e.g.
                                   com.mycompany.myapp)

  -n, --appname=appname            (required) application name

  -o, --organization=organization  (required) organization name (your
                                   company's/organization's name)

  -t, --apptype=apptype            application type (native_swift or native,
                                   leave empty for native_swift)

DESCRIPTION
  This command initiates creation of a new app based on the standard Mobile SDK 
  template.

List available native iOS templates

-> sfdx mobilesdk:ios:listtemplates --help
list available Mobile SDK templates to create an iOS native mobile application

USAGE
  $ sfdx mobilesdk:ios:listtemplates

DESCRIPTION
  This command displays the list of available Mobile SDK templates. You can copy 
  repo paths from the output for use with the createwithtemplate command.

Create iOS application from template

-> sfdx mobilesdk:ios:createwithtemplate --help
create an iOS native mobile application from a template

USAGE
  $ sfdx mobilesdk:ios:createwithtemplate

OPTIONS
  -d, --outputdir=outputdir              output directory (leave empty for
                                         current directory)

  -k, --packagename=packagename          (required) app package identifier (e.g.
                                         com.mycompany.myapp)

  -n, --appname=appname                  (required) application name

  -o, --organization=organization        (required) organization name (your
                                         company's/organization's name)

  -r, --templaterepouri=templaterepouri  (required) template repo URI or Mobile
                                         SDK template name

DESCRIPTION
  This command initiates creation of a new app based on the Mobile SDK template 
  that you specify. The template can be a specialized app for your app type that 
  Mobile SDK provides, or your own custom app that you've configured to use as a 
  template. See 
  https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/i
  os_new_project_template.htm for information on custom templates.

Check store or syncs config

-> sfdx mobilesdk:ios:checkconfig --help
validate store or syncs configuration

USAGE
  $ sfdx mobilesdk:ios:checkconfig

OPTIONS
  -p, --configpath=configpath  (required) path to store or syncs config to
                               validate

  -t, --configtype=configtype  (required) type of config to validate (store or
                               syncs)

DESCRIPTION
  This command checks whether the given store or syncs configuration is valid 
  according to its JSON schema.

Create a native Android application

Help for Android

-> sfdx mobilesdk:android --help
create an Android native mobile application

USAGE
  $ sfdx mobilesdk:android:COMMAND

COMMANDS
  mobilesdk:android:checkconfig         validate store or syncs configuration
  mobilesdk:android:create              create an Android native mobile
                                        application
  mobilesdk:android:createwithtemplate  create an Android native mobile
                                        application from a template
  mobilesdk:android:listtemplates       list available Mobile SDK templates to
                                        create an Android native mobile
                                        application
  mobilesdk:android:version             show version of Mobile SDK

Create Java (native) or Kotlin (native_kotlin) application

-> sfdx mobilesdk:android:create --help
create an Android native mobile application

USAGE
  $ sfdx mobilesdk:android:create

OPTIONS
  -d, --outputdir=outputdir        output directory (leave empty for current
                                   directory)

  -k, --packagename=packagename    (required) app package identifier (e.g.
                                   com.mycompany.myapp)

  -n, --appname=appname            (required) application name

  -o, --organization=organization  (required) organization name (your
                                   company's/organization's name)

  -t, --apptype=apptype            application type (native_kotlin or native,
                                   leave empty for native_kotlin)

DESCRIPTION
  This command initiates creation of a new app based on the standard Mobile SDK 
  template.

List available native Android templates

-> sfdx mobilesdk:android:listtemplates --help
list available Mobile SDK templates to create an Android native mobile application

USAGE
  $ sfdx mobilesdk:android:listtemplates

DESCRIPTION
  This command displays the list of available Mobile SDK templates. You can copy 
  repo paths from the output for use with the createwithtemplate command.

Create Android application from template

-> sfdx mobilesdk:android:createwithtemplate --help
create an Android native mobile application from a template

USAGE
  $ sfdx mobilesdk:android:createwithtemplate

OPTIONS
  -d, --outputdir=outputdir              output directory (leave empty for
                                         current directory)

  -k, --packagename=packagename          (required) app package identifier (e.g.
                                         com.mycompany.myapp)

  -n, --appname=appname                  (required) application name

  -o, --organization=organization        (required) organization name (your
                                         company's/organization's name)

  -r, --templaterepouri=templaterepouri  (required) template repo URI or Mobile
                                         SDK template name

DESCRIPTION
  This command initiates creation of a new app based on the Mobile SDK template 
  that you specify. The template can be a specialized app for your app type that 
  Mobile SDK provides, or your own custom app that you've configured to use as a 
  template. See 
  https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/i
  os_new_project_template.htm for information on custom templates.

Check store or syncs config

-> sfdx mobilesdk:android:checkconfig --help
validate store or syncs configuration

USAGE
  $ sfdx mobilesdk:android:checkconfig

OPTIONS
  -p, --configpath=configpath  (required) path to store or syncs config to
                               validate

  -t, --configtype=configtype  (required) type of config to validate (store or
                               syncs)

DESCRIPTION
  This command checks whether the given store or syncs configuration is valid 
  according to its JSON schema.

Create an hybrid application

Help for hybrid

-> sfdx mobilesdk:hybrid --help
create a hybrid mobile application

USAGE
  $ sfdx mobilesdk:hybrid:COMMAND

COMMANDS
  mobilesdk:hybrid:checkconfig         validate store or syncs configuration
  mobilesdk:hybrid:create              create a hybrid mobile application
  mobilesdk:hybrid:createwithtemplate  create a hybrid mobile application from a
                                       template
  mobilesdk:hybrid:listtemplates       list available Mobile SDK templates to
                                       create a hybrid mobile application
  mobilesdk:hybrid:version             show version of Mobile SDK

Create hybrid application

-> sfdx mobilesdk:hybrid:create --help
create a hybrid mobile application

USAGE
  $ sfdx mobilesdk:hybrid:create

OPTIONS
  -d, --outputdir=outputdir        output directory (leave empty for current
                                   directory)

  -k, --packagename=packagename    (required) app package identifier (e.g.
                                   com.mycompany.myapp)

  -n, --appname=appname            (required) application name

  -o, --organization=organization  (required) organization name (your
                                   company's/organization's name)

  -p, --platform=platform          (required) comma-separated list of platforms
                                   (ios, android)

  -s, --startpage=startpage        app start page (the start page of your remote
                                   app; required for hybrid_remote apps only)

  -t, --apptype=apptype            application type (hybrid_local or
                                   hybrid_remote or hybrid_lwc, leave empty for
                                   hybrid_local)

DESCRIPTION
  This command initiates creation of a new app based on the standard Mobile SDK 
  template.

List available hybrid templates

-> sfdx mobilesdk:hybrid:listtemplates --help
list available Mobile SDK templates to create a hybrid mobile application

USAGE
  $ sfdx mobilesdk:hybrid:listtemplates

DESCRIPTION
  This command displays the list of available Mobile SDK templates. You can copy 
  repo paths from the output for use with the createwithtemplate command.

Create hybrid application from template

-> sfdx mobilesdk:hybrid:createwithtemplate --help
create a hybrid mobile application from a template

USAGE
  $ sfdx mobilesdk:hybrid:createwithtemplate

OPTIONS
  -d, --outputdir=outputdir              output directory (leave empty for
                                         current directory)

  -k, --packagename=packagename          (required) app package identifier (e.g.
                                         com.mycompany.myapp)

  -n, --appname=appname                  (required) application name

  -o, --organization=organization        (required) organization name (your
                                         company's/organization's name)

  -p, --platform=platform                (required) comma-separated list of
                                         platforms (ios, android)

  -r, --templaterepouri=templaterepouri  (required) template repo URI or Mobile
                                         SDK template name

  -s, --startpage=startpage              app start page (the start page of your
                                         remote app; required for hybrid_remote
                                         apps only)

DESCRIPTION
  This command initiates creation of a new app based on the Mobile SDK template 
  that you specify. The template can be a specialized app for your app type that 
  Mobile SDK provides, or your own custom app that you've configured to use as a 
  template. See 
  https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/i
  os_new_project_template.htm for information on custom templates.

Check store or syncs config

-> sfdx mobilesdk:hybrid:checkconfig --help
validate store or syncs configuration

USAGE
  $ sfdx mobilesdk:hybrid:checkconfig

OPTIONS
  -p, --configpath=configpath  (required) path to store or syncs config to
                               validate

  -t, --configtype=configtype  (required) type of config to validate (store or
                               syncs)

DESCRIPTION
  This command checks whether the given store or syncs configuration is valid 
  according to its JSON schema.

Create a React Native application

Help for React Native

-> sfdx mobilesdk:reactnative --help
create a React Native mobile application

USAGE
  $ sfdx mobilesdk:reactnative:COMMAND

COMMANDS
  mobilesdk:reactnative:checkconfig         validate store or syncs
                                            configuration
  mobilesdk:reactnative:create              create a React Native mobile
                                            application
  mobilesdk:reactnative:createwithtemplate  create a React Native mobile
                                            application from a template
  mobilesdk:reactnative:listtemplates       list available Mobile SDK templates
                                            to create a React Native mobile
                                            application
  mobilesdk:reactnative:version             show version of Mobile SDK

Create React Native application

-> sfdx mobilesdk:reactnative:create --help
create a React Native mobile application

USAGE
  $ sfdx mobilesdk:reactnative:create

OPTIONS
  -d, --outputdir=outputdir        output directory (leave empty for current
                                   directory)

  -k, --packagename=packagename    (required) app package identifier (e.g.
                                   com.mycompany.myapp)

  -n, --appname=appname            (required) application name

  -o, --organization=organization  (required) organization name (your
                                   company's/organization's name)

  -p, --platform=platform          (required) comma-separated list of platforms
                                   (ios, android)

DESCRIPTION
  This command initiates creation of a new app based on the standard Mobile SDK 
  template.

List available React Native templates

-> sfdx mobilesdk:reactnative:listtemplates --help
list available Mobile SDK templates to create a React Native mobile application

USAGE
  $ sfdx mobilesdk:reactnative:listtemplates

DESCRIPTION
  This command displays the list of available Mobile SDK templates. You can copy 
  repo paths from the output for use with the createwithtemplate command.

Create React Native application from template

-> sfdx mobilesdk:reactnative:createwithtemplate --help
create a React Native mobile application from a template

USAGE
  $ sfdx mobilesdk:reactnative:createwithtemplate

OPTIONS
  -d, --outputdir=outputdir              output directory (leave empty for
                                         current directory)

  -k, --packagename=packagename          (required) app package identifier (e.g.
                                         com.mycompany.myapp)

  -n, --appname=appname                  (required) application name

  -o, --organization=organization        (required) organization name (your
                                         company's/organization's name)

  -p, --platform=platform                (required) comma-separated list of
                                         platforms (ios, android)

  -r, --templaterepouri=templaterepouri  (required) template repo URI or Mobile
                                         SDK template name

DESCRIPTION
  This command initiates creation of a new app based on the Mobile SDK template 
  that you specify. The template can be a specialized app for your app type that 
  Mobile SDK provides, or your own custom app that you've configured to use as a 
  template. See 
  https://developer.salesforce.com/docs/atlas.en-us.mobile_sdk.meta/mobile_sdk/i
  os_new_project_template.htm for information on custom templates.

Check store or syncs config

-> sfdx mobilesdk:reactnative:checkconfig --help
validate store or syncs configuration

USAGE
  $ sfdx mobilesdk:reactnative:checkconfig

OPTIONS
  -p, --configpath=configpath  (required) path to store or syncs config to
                               validate

  -t, --configtype=configtype  (required) type of config to validate (store or
                               syncs)

DESCRIPTION
  This command checks whether the given store or syncs configuration is valid 
  according to its JSON schema.