Skip to content

Updated README for our CLIs #315

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wmathurin merged 3 commits into from
Oct 7, 2025
Merged

Updated README for our CLIs #315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5eba1f6
Updated README.md
wmathurin Oct 6, 2025
d0c27b9
Revert "Updated README.md"
wmathurin Oct 6, 2025
92b1ec1
Updated README for our CLIs
wmathurin Oct 6, 2025
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
30 changes: 22 additions & 8 deletions android/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Usage:

# create an Android native mobile application
forcedroid create
[--apptype=application type (native or native_kotlin, leave empty for native_kotlin)]
[--apptype=application type (native_kotlin or native, leave empty for native_kotlin)]
--appname=application name
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
Expand All @@ -44,16 +44,35 @@ forcedroid create

# create an Android native mobile application from a template
forcedroid createwithtemplate
--templaterepouri=template repo URI or Mobile SDK template name
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--templaterepouri=template repo URI or Mobile SDK template name]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
--appname=application name
--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)]

OR

# list available Mobile SDK templates
# show version of Mobile SDK
forcedroid version

OR

# list available Mobile SDK templates to create an Android native mobile application
forcedroid listtemplates
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

# list details for a specific Mobile SDK template to create an Android native mobile application
forcedroid describetemplate
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

Expand All @@ -62,11 +81,6 @@ forcedroid checkconfig
--configpath=path to store or syncs config to validate
--configtype=type of config to validate (store or syncs)

OR

# show version of Mobile SDK
forcedroid version

OR

forcedroid
Expand Down
29 changes: 22 additions & 7 deletions hybrid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,36 @@ forcehybrid create
# create a hybrid mobile application from a template
forcehybrid createwithtemplate
--platform=comma-separated list of platforms (ios, android)
--templaterepouri=template repo URI or Mobile SDK template name
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--templaterepouri=template repo URI or Mobile SDK template name]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
--appname=application name
--packagename=app package identifier (e.g. com.mycompany.myapp)
--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)]

OR

# list available Mobile SDK templates
# show version of Mobile SDK
forcehybrid version

OR

# list available Mobile SDK templates to create a hybrid mobile application
forcehybrid listtemplates
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

# list details for a specific Mobile SDK template to create a hybrid mobile application
forcehybrid describetemplate
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

Expand All @@ -67,11 +87,6 @@ forcehybrid checkconfig

OR

# show version of Mobile SDK
forcehybrid version

OR

forcehybrid
```

Expand Down
28 changes: 21 additions & 7 deletions ios/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,35 @@ forceios create

# create an iOS native mobile application from a template
forceios createwithtemplate
--templaterepouri=template repo URI or Mobile SDK template name
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--templaterepouri=template repo URI or Mobile SDK template name]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
--appname=application name
--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)]

OR

# list available Mobile SDK templates
# show version of Mobile SDK
forceios version

OR

# list available Mobile SDK templates to create an iOS native mobile application
forceios listtemplates
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

# list details for a specific Mobile SDK template to create an iOS native mobile application
forceios describetemplate
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

Expand All @@ -64,11 +83,6 @@ forceios checkconfig

OR

# show version of Mobile SDK
forceios version

OR

forceios
```

Expand Down
29 changes: 22 additions & 7 deletions react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Usage:
# create a React Native mobile application
forcereact create
--platform=comma-separated list of platforms (ios, android)
[--apptype=application type (react_native_typescript or react_native, leave empty for react_native_typescript)]
--appname=application name
--packagename=app package identifier (e.g. com.mycompany.myapp)
--organization=organization name (your company's/organization's name)
Expand All @@ -45,16 +46,35 @@ forcereact create
# create a React Native mobile application from a template
forcereact createwithtemplate
--platform=comma-separated list of platforms (ios, android)
--templaterepouri=template repo URI or Mobile SDK template name
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--templaterepouri=template repo URI or Mobile SDK template name]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
--appname=application name
--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)]

OR

# list available Mobile SDK templates
# show version of Mobile SDK
forcereact version

OR

# list available Mobile SDK templates to create a React Native mobile application
forcereact listtemplates
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

# list details for a specific Mobile SDK template to create a React Native mobile application
forcereact describetemplate
[--templatesource=git repo URL (optionally with #branch) or local path to a templates suite (root must contain templates.json)]
[--template=template name within the templates suite (e.g. ReactNativeTemplate)]
[--doc=include verbose documentation from template.json files]
[--json=output response in JSON format]

OR

Expand All @@ -65,11 +85,6 @@ forcereact checkconfig

OR

# show version of Mobile SDK
forcereact version

OR

forcereact
```

Expand Down
Loading