Salesforce CLI plugin for creating mobile apps based on the Salesforce Mobile SDK
npm install sfdx-mobilesdk-pluginA 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.
1. Install the Salesforce CLI (https://developer.salesforce.com/tools/salesforcecli).
2. Clone the repository: git clone git@github.com:forcedotcom/SalesforceMobileSDK-Package
3. Install npm modules: npm install
4. Generate oclif command classes ./sfdx/generate_oclif.js
5. Link the plugin: sf plugins link sfdx
1. Install plugin: sf plugins install sfdx-mobilesdk-plugin
-> sf mobilesdk --help
create mobile apps based on the Salesforce Mobile SDKUSAGE
$ sf 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
$3
-> sf mobilesdk ios --help
create an iOS native mobile applicationUSAGE
$ sf 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
$3
-> sf mobilesdk ios create --help
create an iOS native mobile applicationUSAGE
$ sf mobilesdk ios create -n -k -o [-t ] [-d
]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-t, --apptype= application type (native_swift or native, leave
empty for native_swift)
DESCRIPTION
create an iOS native mobile application
This command initiates creation of a new app based on the standard Mobile SDK
template.
$3
-> sf mobilesdk ios listtemplates --help
list available Mobile SDK templates to create an iOS native mobile applicationUSAGE
$ sf mobilesdk ios listtemplates
DESCRIPTION
list available Mobile SDK templates to create an iOS native mobile application
This command displays the list of available Mobile SDK templates. You can copy
repo paths from the output for use with the createwithtemplate command.
$3
-> sf mobilesdk ios createwithtemplate --help
create an iOS native mobile application from a templateUSAGE
$ sf mobilesdk ios createwithtemplate -r -n -k -o [-d
]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-r, --templaterepouri= (required) template repo URI or Mobile SDK
template name
DESCRIPTION
create an iOS native mobile application from a template
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.met
a/mobile_sdk/ios_new_project_template.htm for information on custom templates.
$3
-> sf mobilesdk ios checkconfig --help
validate store or syncs configurationUSAGE
$ sf mobilesdk ios checkconfig -p -t
FLAGS
-p, --configpath= (required) path to store or syncs config to validate
-t, --configtype= (required) type of config to validate (store or
syncs)
DESCRIPTION
validate store or syncs configuration
This command checks whether the given store or syncs configuration is valid
according to its JSON schema.
Create a native Android application
$3
-> sf mobilesdk android --help
create an Android native mobile applicationUSAGE
$ sf 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
$3
-> sf mobilesdk android create --help
create an Android native mobile applicationUSAGE
$ sf mobilesdk android create -n -k -o [-t ] [-d
]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-t, --apptype= application type (native_kotlin or native, leave
empty for native_kotlin)
DESCRIPTION
create an Android native mobile application
This command initiates creation of a new app based on the standard Mobile SDK
template.
$3
-> sf mobilesdk android listtemplates --help
list available Mobile SDK templates to create an Android native mobile applicationUSAGE
$ sf mobilesdk android listtemplates
DESCRIPTION
list available Mobile SDK templates to create an Android native mobile
application
This command displays the list of available Mobile SDK templates. You can copy
repo paths from the output for use with the createwithtemplate command.
$3
-> sf mobilesdk android createwithtemplate --help
create an Android native mobile application from a templateUSAGE
$ sf mobilesdk android createwithtemplate -r -n -k -o [-d
]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-r, --templaterepouri= (required) template repo URI or Mobile SDK
template name
DESCRIPTION
create an Android native mobile application from a template
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.met
a/mobile_sdk/ios_new_project_template.htm for information on custom templates.
$3
-> sf mobilesdk android checkconfig --help
validate store or syncs configurationUSAGE
$ sf mobilesdk android checkconfig -p -t
FLAGS
-p, --configpath= (required) path to store or syncs config to validate
-t, --configtype= (required) type of config to validate (store or
syncs)
DESCRIPTION
validate store or syncs configuration
This command checks whether the given store or syncs configuration is valid
according to its JSON schema.
Create an hybrid application
$3
-> sf mobilesdk hybrid --help
create a hybrid mobile applicationUSAGE
$ sf 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
$3
-> sf mobilesdk hybrid create --help
create a hybrid mobile applicationUSAGE
$ sf mobilesdk hybrid create -p -n -k -o [-t
] [-s ] [-d ]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-p, --platform= (required) comma-separated list of platforms (ios,
android)
-s, --startpage= app start page (the start page of your remote app;
required for hybrid_remote apps only)
-t, --apptype= application type (hybrid_local or hybrid_remote,
leave empty for hybrid_local)
DESCRIPTION
create a hybrid mobile application
This command initiates creation of a new app based on the standard Mobile SDK
template.
$3
-> sf mobilesdk hybrid listtemplates --help
list available Mobile SDK templates to create a hybrid mobile applicationUSAGE
$ sf mobilesdk hybrid listtemplates
DESCRIPTION
list available Mobile SDK templates to create a hybrid mobile application
This command displays the list of available Mobile SDK templates. You can copy
repo paths from the output for use with the createwithtemplate command.
$3
-> sf mobilesdk hybrid createwithtemplate --help
create a hybrid mobile application from a templateUSAGE
$ sf mobilesdk hybrid createwithtemplate -p -r -n -k -o
[-s ] [-d ]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-p, --platform= (required) comma-separated list of platforms
(ios, android)
-r, --templaterepouri= (required) template repo URI or Mobile SDK
template name
-s, --startpage= app start page (the start page of your remote
app; required for hybrid_remote apps only)
DESCRIPTION
create a hybrid mobile application from a template
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.met
a/mobile_sdk/ios_new_project_template.htm for information on custom templates.
$3
-> sf mobilesdk hybrid checkconfig --help
validate store or syncs configurationUSAGE
$ sf mobilesdk hybrid checkconfig -p -t
FLAGS
-p, --configpath= (required) path to store or syncs config to validate
-t, --configtype= (required) type of config to validate (store or
syncs)
DESCRIPTION
validate store or syncs configuration
This command checks whether the given store or syncs configuration is valid
according to its JSON schema.
Create a React Native application
$3
-> sf mobilesdk reactnative --help
create a React Native mobile applicationUSAGE
$ sf 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
$3
-> sf mobilesdk reactnative create --help
create a React Native mobile applicationUSAGE
$ sf mobilesdk reactnative create -p -n -k -o [-t
] [-d ]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-p, --platform= (required) comma-separated list of platforms (ios,
android)
-t, --apptype= application type (react_native_typescript or
react_native, leave empty for
react_native_typescript)
DESCRIPTION
create a React Native mobile application
This command initiates creation of a new app based on the standard Mobile SDK
template.
$3
-> sf mobilesdk reactnative listtemplates --help
list available Mobile SDK templates to create a React Native mobile applicationUSAGE
$ sf mobilesdk reactnative listtemplates
DESCRIPTION
list available Mobile SDK templates to create a React Native mobile
application
This command displays the list of available Mobile SDK templates. You can copy
repo paths from the output for use with the createwithtemplate command.
$3
-> sf mobilesdk reactnative createwithtemplate --help
create a React Native mobile application from a templateUSAGE
$ sf mobilesdk reactnative createwithtemplate -p -r -n -k -o
[-d ]
FLAGS
-d, --outputdir= output directory (leave empty for current
directory)
-k, --packagename= (required) app package identifier (e.g.
com.mycompany.myapp)
-n, --appname= (required) application name
-o, --organization= (required) organization name (your
company's/organization's name)
-p, --platform= (required) comma-separated list of platforms
(ios, android)
-r, --templaterepouri= (required) template repo URI or Mobile SDK
template name
DESCRIPTION
create a React Native mobile application from a template
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.met
a/mobile_sdk/ios_new_project_template.htm for information on custom templates.
$3
-> sf mobilesdk reactnative checkconfig --help
validate store or syncs configurationUSAGE
$ sf mobilesdk reactnative checkconfig -p -t
FLAGS
-p, --configpath= (required) path to store or syncs config to validate
-t, --configtype= (required) type of config to validate (store or
syncs)
DESCRIPTION
validate store or syncs configuration
This command checks whether the given store or syncs configuration is valid
according to its JSON schema.