Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions android/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ forcedroid create
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand All @@ -51,6 +54,9 @@ forcedroid createwithtemplate
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand Down
6 changes: 6 additions & 0 deletions hybrid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ forcehybrid create
--organization=organization name (your company's/organization's name)
[--startpage=app start page (the start page of your remote app; required for hybrid_remote apps only)]
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand All @@ -55,6 +58,9 @@ forcehybrid createwithtemplate
--organization=organization name (your company's/organization's name)
[--startpage=app start page (the start page of your remote app; required for hybrid_remote apps only)]
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand Down
6 changes: 6 additions & 0 deletions ios/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ forceios create
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand All @@ -51,6 +54,9 @@ forceios createwithtemplate
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand Down
6 changes: 6 additions & 0 deletions react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ forcereact create
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand All @@ -53,6 +56,9 @@ forcereact createwithtemplate
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
[--outputdir=output directory (leave empty for current directory)]
[--consumerkey=OAuth consumer key for the Salesforce External Client App or Connected App]
[--callbackurl=OAuth callback URL for the Salesforce External Client App or Connected App]
[--loginserver=Login server URL for the Salesforce org]

OR

Expand Down
58 changes: 50 additions & 8 deletions sfdx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,23 @@ create an iOS native mobile application

USAGE
$ sf mobilesdk ios create -n <value> -k <value> -o <value> [-t <value>] [-d
<value>]
<value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
-t, --apptype=<value> application type (native_swift or native, leave
empty for native_swift)
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create an iOS native mobile application
Expand Down Expand Up @@ -122,22 +127,27 @@ create an iOS native mobile application from a template

USAGE
$ sf mobilesdk ios createwithtemplate -n <value> -k <value> -o <value> [-S <value>] [-r
<value>] [-m <value>] [-d <value>]
<value>] [-m <value>] [-d <value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-S, --templatesource=<value> git repo URL (optionally with #branch) or local
path to a templates suite (root must contain
templates.json)
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-m, --template=<value> template name within the templates suite (e.g.
ReactNativeTemplate)
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
-r, --templaterepouri=<value> template repo URI or Mobile SDK template name
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create an iOS native mobile application from a template
Expand Down Expand Up @@ -203,18 +213,23 @@ create an Android native mobile application

USAGE
$ sf mobilesdk android create -n <value> -k <value> -o <value> [-t <value>] [-d
<value>]
<value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
-t, --apptype=<value> application type (native_kotlin or native, leave
empty for native_kotlin)
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create an Android native mobile application
Expand Down Expand Up @@ -260,22 +275,27 @@ create an Android native mobile application from a template

USAGE
$ sf mobilesdk android createwithtemplate -n <value> -k <value> -o <value> [-S <value>] [-r
<value>] [-m <value>] [-d <value>]
<value>] [-m <value>] [-d <value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-S, --templatesource=<value> git repo URL (optionally with #branch) or local
path to a templates suite (root must contain
templates.json)
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-m, --template=<value> template name within the templates suite (e.g.
ReactNativeTemplate)
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
-r, --templaterepouri=<value> template repo URI or Mobile SDK template name
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create an Android native mobile application from a template
Expand Down Expand Up @@ -339,13 +359,16 @@ create a hybrid mobile application

USAGE
$ sf mobilesdk hybrid create -p <value> -n <value> -k <value> -o <value> [-t
<value>] [-s <value>] [-d <value>]
<value>] [-s <value>] [-d <value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
Expand All @@ -355,6 +378,8 @@ FLAGS
required for hybrid_remote apps only)
-t, --apptype=<value> application type (hybrid_local or hybrid_remote,
leave empty for hybrid_local)
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create a hybrid mobile application
Expand Down Expand Up @@ -399,16 +424,20 @@ create a hybrid mobile application from a template

USAGE
$ sf mobilesdk hybrid createwithtemplate -p <value> -n <value> -k <value> -o <value> [-S
<value>] [-r <value>] [-m <value>] [-s <value>] [-d <value>]
<value>] [-r <value>] [-m <value>] [-s <value>] [-d <value>] [-c <value>]
[-u <value>] [-l <value>]

FLAGS
-S, --templatesource=<value> git repo URL (optionally with #branch) or local
path to a templates suite (root must contain
templates.json)
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-m, --template=<value> template name within the templates suite (e.g.
ReactNativeTemplate)
-n, --appname=<value> (required) application name
Expand All @@ -419,6 +448,8 @@ FLAGS
-r, --templaterepouri=<value> template repo URI or Mobile SDK template name
-s, --startpage=<value> app start page (the start page of your remote
app; required for hybrid_remote apps only)
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create a hybrid mobile application from a template
Expand Down Expand Up @@ -485,13 +516,16 @@ create a React Native mobile application

USAGE
$ sf mobilesdk reactnative create -p <value> -n <value> -k <value> -o <value> [-t
<value>] [-d <value>]
<value>] [-d <value>] [-c <value>] [-u <value>] [-l <value>]

FLAGS
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-n, --appname=<value> (required) application name
-o, --organization=<value> (required) organization name (your
company's/organization's name)
Expand All @@ -500,6 +534,8 @@ FLAGS
-t, --apptype=<value> application type (react_native_typescript or
react_native, leave empty for
react_native_typescript)
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create a React Native mobile application
Expand Down Expand Up @@ -545,16 +581,20 @@ create a React Native mobile application from a template

USAGE
$ sf mobilesdk reactnative createwithtemplate -p <value> -n <value> -k <value> -o <value> [-S
<value>] [-r <value>] [-m <value>] [-d <value>]
<value>] [-r <value>] [-m <value>] [-d <value>] [-c <value>] [-u <value>]
[-l <value>]

FLAGS
-S, --templatesource=<value> git repo URL (optionally with #branch) or local
path to a templates suite (root must contain
templates.json)
-c, --consumerkey=<value> OAuth consumer key for the Salesforce External
Client App or Connected App
-d, --outputdir=<value> output directory (leave empty for current
directory)
-k, --packagename=<value> (required) app package identifier (e.g.
com.mycompany.myapp)
-l, --loginserver=<value> Login server URL for the Salesforce org
-m, --template=<value> template name within the templates suite (e.g.
ReactNativeTemplate)
-n, --appname=<value> (required) application name
Expand All @@ -563,6 +603,8 @@ FLAGS
-p, --platform=<value> (required) comma-separated list of platforms
(ios, android)
-r, --templaterepouri=<value> template repo URI or Mobile SDK template name
-u, --callbackurl=<value> OAuth callback URL for the Salesforce External
Client App or Connected App

DESCRIPTION
create a React Native mobile application from a template
Expand Down
41 changes: 40 additions & 1 deletion shared/constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ module.exports = {
type: 'string',
hidden: true
},
sdkDependencies: {
sdkDependencies: {
name: 'sdkdependencies',
description: 'override sdk dependencies',
'char': 'd',
Expand Down Expand Up @@ -329,6 +329,39 @@ module.exports = {
required: false,
type: 'boolean',
hidden: false
},
consumerKey: {
name: 'consumerkey',
'char': 'c',
description: 'OAuth consumer key for the Salesforce External Client App or Connected App',
longDescription: 'The OAuth consumer key (client ID) for your Salesforce External Client App or Connected App. When provided, this will be automatically configured in the generated app.',
prompt: 'Enter your OAuth consumer key (leave empty to manually configure this value in the project\'s bootconfig file):',
error: cli => val => 'Invalid value for consumer key: \'' + val + '\'.',
validate: cli => val => val === undefined || val === '' || /\S+/.test(val),
required: false,
type: 'string'
},
callbackURL: {
name: 'callbackurl',
'char': 'u',
description: 'OAuth callback URL for the Salesforce External Client App or Connected App',
longDescription: 'The OAuth callback URL (redirect URI) for your Salesforce External Client App or Connected App. When provided, this will be automatically configured in the generated app.',
prompt: 'Enter your OAuth callback URL (leave empty to manually configure this value in the project\'s bootconfig file):',
error: cli => val => 'Invalid value for callback URL: \'' + val + '\'.',
validate: cli => val => val === undefined || val === '' || /\S+/.test(val),
required: false,
type: 'string'
},
loginServer: {
name: 'loginserver',
'char': 'l',
description: 'Login server URL for the Salesforce org',
longDescription: 'The login server URL for your Salesforce org (e.g. https://login.salesforce.com, https://test.salesforce.com, or custom domain). When provided, this will be automatically configured in the generated app.',
prompt: 'Enter your login server URL (leave empty for https://login.salesforce.com):',
error: cli => val => 'Invalid value for login server: \'' + val + '\'.',
validate: cli => val => val === undefined || val === '' || /\S+/.test(val),
required: false,
type: 'string'
}
},

Expand All @@ -342,6 +375,9 @@ module.exports = {
'organization',
cli.appTypes.indexOf('hybrid_remote') >=0 ? 'startPage' : null,
'outputDir',
'consumerKey',
'callbackURL',
'loginServer',
'verbose',
cli.name === 'forcehybrid' ? 'pluginRepoUri' : null,
'sdkDependencies'
Expand All @@ -361,6 +397,9 @@ module.exports = {
'organization',
cli.appTypes.indexOf('hybrid_remote') >=0 ? 'startPage' : null,
'outputDir',
'consumerKey',
'callbackURL',
'loginServer',
'verbose',
cli.name === 'forcehybrid' ? 'pluginRepoUri' : null,
'sdkDependencies'
Expand Down
Loading