Skip to content

Commit 50a7013

Browse files
wmathurinwmathurin
authored
Merge pull request #315 from wmathurin/dev
Updated README for our CLIs
2 parents 25cf46e + 92b1ec1 commit 50a7013

File tree

5 files changed

+187
-53
lines changed

5 files changed

+187
-53
lines changed

‎android/README.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Usage:
3434
3535
# create an Android native mobile application
3636
forcedroid create
37-
[--apptype=application type (native or native_kotlin, leave empty for native_kotlin)]
37+
[--apptype=application type (native_kotlin or native, leave empty for native_kotlin)]
3838
--appname=application name
3939
--packagename=app package identifier (e.g. com.mycompany.myapp)
4040
--organization=organization name (your company's/organization's name)
@@ -44,16 +44,35 @@ forcedroid create
4444
4545
# create an Android native mobile application from a template
4646
forcedroid createwithtemplate
47-
--templaterepouri=template repo URI or Mobile SDK template name
47+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
48+
[--templaterepouri=template repo URI or Mobile SDK template name]
49+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
4850
--appname=application name
4951
--packagename=app package identifier (e.g. com.mycompany.myapp)
5052
--organization=organization name (your company's/organization's name)
5153
[--outputdir=output directory (leave empty for current directory)]
5254
5355
OR
5456
55-
# list available Mobile SDK templates
57+
# show version of Mobile SDK
58+
forcedroid version
59+
60+
OR
61+
62+
# list available Mobile SDK templates to create an Android native mobile application
5663
forcedroid listtemplates
64+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
65+
[--doc=include verbose documentation from template.json files]
66+
[--json=output response in JSON format]
67+
68+
OR
69+
70+
# list details for a specific Mobile SDK template to create an Android native mobile application
71+
forcedroid describetemplate
72+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
73+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
74+
[--doc=include verbose documentation from template.json files]
75+
[--json=output response in JSON format]
5776
5877
OR
5978
@@ -62,11 +81,6 @@ forcedroid checkconfig
6281
--configpath=path to store or syncs config to validate
6382
--configtype=type of config to validate (store or syncs)
6483
65-
OR
66-
67-
# show version of Mobile SDK
68-
forcedroid version
69-
7084
OR
7185
7286
forcedroid

‎hybrid/README.md‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,36 @@ forcehybrid create
4747
# create a hybrid mobile application from a template
4848
forcehybrid createwithtemplate
4949
--platform=comma-separated list of platforms (ios, android)
50-
--templaterepouri=template repo URI or Mobile SDK template name
50+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
51+
[--templaterepouri=template repo URI or Mobile SDK template name]
52+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
5153
--appname=application name
5254
--packagename=app package identifier (e.g. com.mycompany.myapp)
5355
--organization=organization name (your company's/organization's name)
56+
[--startpage=app start page (the start page of your remote app; required for hybrid_remote apps only)]
5457
[--outputdir=output directory (leave empty for current directory)]
5558
5659
OR
5760
58-
# list available Mobile SDK templates
61+
# show version of Mobile SDK
62+
forcehybrid version
63+
64+
OR
65+
66+
# list available Mobile SDK templates to create a hybrid mobile application
5967
forcehybrid listtemplates
68+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
69+
[--doc=include verbose documentation from template.json files]
70+
[--json=output response in JSON format]
71+
72+
OR
73+
74+
# list details for a specific Mobile SDK template to create a hybrid mobile application
75+
forcehybrid describetemplate
76+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
77+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
78+
[--doc=include verbose documentation from template.json files]
79+
[--json=output response in JSON format]
6080
6181
OR
6282
@@ -67,11 +87,6 @@ forcehybrid checkconfig
6787
6888
OR
6989
70-
# show version of Mobile SDK
71-
forcehybrid version
72-
73-
OR
74-
7590
forcehybrid
7691
```
7792

‎ios/README.md‎

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,35 @@ forceios create
4444
4545
# create an iOS native mobile application from a template
4646
forceios createwithtemplate
47-
--templaterepouri=template repo URI or Mobile SDK template name
47+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
48+
[--templaterepouri=template repo URI or Mobile SDK template name]
49+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
4850
--appname=application name
4951
--packagename=app package identifier (e.g. com.mycompany.myapp)
5052
--organization=organization name (your company's/organization's name)
5153
[--outputdir=output directory (leave empty for current directory)]
5254
5355
OR
5456
55-
# list available Mobile SDK templates
57+
# show version of Mobile SDK
58+
forceios version
59+
60+
OR
61+
62+
# list available Mobile SDK templates to create an iOS native mobile application
5663
forceios listtemplates
64+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
65+
[--doc=include verbose documentation from template.json files]
66+
[--json=output response in JSON format]
67+
68+
OR
69+
70+
# list details for a specific Mobile SDK template to create an iOS native mobile application
71+
forceios describetemplate
72+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
73+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
74+
[--doc=include verbose documentation from template.json files]
75+
[--json=output response in JSON format]
5776
5877
OR
5978
@@ -64,11 +83,6 @@ forceios checkconfig
6483
6584
OR
6685
67-
# show version of Mobile SDK
68-
forceios version
69-
70-
OR
71-
7286
forceios
7387
```
7488

‎react/README.md‎

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Usage:
3535
# create a React Native mobile application
3636
forcereact create
3737
--platform=comma-separated list of platforms (ios, android)
38+
[--apptype=application type (react_native_typescript or react_native, leave empty for react_native_typescript)]
3839
--appname=application name
3940
--packagename=app package identifier (e.g. com.mycompany.myapp)
4041
--organization=organization name (your company's/organization's name)
@@ -45,16 +46,35 @@ forcereact create
4546
# create a React Native mobile application from a template
4647
forcereact createwithtemplate
4748
--platform=comma-separated list of platforms (ios, android)
48-
--templaterepouri=template repo URI or Mobile SDK template name
49+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
50+
[--templaterepouri=template repo URI or Mobile SDK template name]
51+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
4952
--appname=application name
5053
--packagename=app package identifier (e.g. com.mycompany.myapp)
5154
--organization=organization name (your company's/organization's name)
5255
[--outputdir=output directory (leave empty for current directory)]
5356
5457
OR
5558
56-
# list available Mobile SDK templates
59+
# show version of Mobile SDK
60+
forcereact version
61+
62+
OR
63+
64+
# list available Mobile SDK templates to create a React Native mobile application
5765
forcereact listtemplates
66+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
67+
[--doc=include verbose documentation from template.json files]
68+
[--json=output response in JSON format]
69+
70+
OR
71+
72+
# list details for a specific Mobile SDK template to create a React Native mobile application
73+
forcereact describetemplate
74+
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
75+
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
76+
[--doc=include verbose documentation from template.json files]
77+
[--json=output response in JSON format]
5878
5979
OR
6080
@@ -65,11 +85,6 @@ forcereact checkconfig
6585
6686
OR
6787
68-
# show version of Mobile SDK
69-
forcereact version
70-
71-
OR
72-
7388
forcereact
7489
```
7590

0 commit comments

Comments
 (0)