You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ni...@apache.org on 2016/01/26 22:52:38 UTC
[1/2] cordova-cli git commit: Update help docs - add examples and
make them consistent
Repository: cordova-cli
Updated Branches:
refs/heads/master 4d5b59e82 -> 9aecfb8f2
Update help docs - add examples and make them consistent
Project: http://git-wip-us.apache.org/repos/asf/cordova-cli/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-cli/commit/75dbae56
Tree: http://git-wip-us.apache.org/repos/asf/cordova-cli/tree/75dbae56
Diff: http://git-wip-us.apache.org/repos/asf/cordova-cli/diff/75dbae56
Branch: refs/heads/master
Commit: 75dbae564ef5eae311ee56242554c6a6a6831cc1
Parents: 4d5b59e
Author: Nikhil Khandelwal <ni...@microsoft.com>
Authored: Mon Jan 25 15:09:44 2016 -0800
Committer: Nikhil Khandelwal <ni...@microsoft.com>
Committed: Tue Jan 26 13:51:56 2016 -0800
----------------------------------------------------------------------
doc/build.txt | 11 ++++----
doc/clean.txt | 3 +++
doc/compile.txt | 7 +++++
doc/cordova.txt | 20 +++++++-------
doc/create.txt | 16 ++++++-----
doc/emulate.txt | 2 +-
doc/platform.txt | 59 +++++++++++++++++++---------------------
doc/plugin.txt | 68 ++++++++++++++++++++++++++---------------------
doc/prepare.txt | 9 ++++---
doc/requirements.txt | 3 +++
doc/run.txt | 16 +++++------
11 files changed, 120 insertions(+), 94 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/build.txt
----------------------------------------------------------------------
diff --git a/doc/build.txt b/doc/build.txt
index 9059a80..a3670a4 100644
--- a/doc/build.txt
+++ b/doc/build.txt
@@ -22,12 +22,11 @@ all/the specified platforms.
--buildConfig....................... Use the specified build configuration
instead of default build.json
- --browserify ....................... Compile plugin JS at build time instead of runtime
- using browserify. Replaces cordovajs file with one
- that includes the JS of the installed plugins.
-
+ --browserify ....................... Compile plugin JS at build time using
+ browserify instead of runtime.
+
To provide platform specific options, you must include them after `--`.
Example
-
- cordova build android --release --buildConfig=..\myBuildConfig.json
+ cordova-cli build android windows --debug --device
+ cordova-cli build android --release --buildConfig=..\myBuildConfig.json
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/clean.txt
----------------------------------------------------------------------
diff --git a/doc/clean.txt b/doc/clean.txt
index 09c9e31..e50eccf 100644
--- a/doc/clean.txt
+++ b/doc/clean.txt
@@ -6,3 +6,6 @@ Cleans the build artifacts for the specified platform, or all platforms
by running platform-provided clean script.
To provide platform specific options, you must include them after `--`.
+
+Example
+ corodva-cli clean android
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/compile.txt
----------------------------------------------------------------------
diff --git a/doc/compile.txt b/doc/compile.txt
index 22a8288..4614a9b 100644
--- a/doc/compile.txt
+++ b/doc/compile.txt
@@ -10,6 +10,8 @@ Synopsis
Builds the app for specified platforms, or all platforms
+Options
+
--debug ............................ Deploy a debug build
--release .......................... Deploy a release build
@@ -18,3 +20,8 @@ Builds the app for specified platforms, or all platforms
--target ........................... Deploy to a specific target
To provide platform specific options, you must include them after `--`.
+
+Examples
+
+ cordova-cli compile android windows --debug --device
+ cordova-cli compile android --release
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/cordova.txt
----------------------------------------------------------------------
diff --git a/doc/cordova.txt b/doc/cordova.txt
index 2bf8b46..4cb03c2 100644
--- a/doc/cordova.txt
+++ b/doc/cordova.txt
@@ -1,14 +1,11 @@
Synopsis
-
cordova-cli command [options]
Global Commands
-
create ............................. Create a project
help ............................... Get help for a command
Project Commands
-
info ............................... Generate project information
requirements ....................... Checks and print out all the requirements
for platforms specified
@@ -24,16 +21,21 @@ Project Commands
(including prepare && compile)
serve .............................. Run project with a local webserver
(including prepare)
-
-aliases:
+Aliases
build -> cordova-cli prepare && cordova-cli compile
emulate -> cordova-cli run --emulator
-Command-line Flags/Options
-
+Options
-v, --version ...................... prints out this utility's version
-d, --verbose ...................... debug mode produces verbose log output for all activity,
- including output of sub-commands cordova-cli invokes
--no-update-notifier ............... disables check for CLI updates
--nohooks .......................... suppress executing hooks
- (taking RegExp hook patterns as parameters)
+ (taking RegExp hook patterns as parameters)
+
+Examples
+ cordova-cli create myApp org.apache.cordova.myApp myApp
+ cordova-cli plugin add cordova-plugin-camera --save
+ cordova-cli platform add android --save
+ cordova-cli requirements android
+ cordova-cli buid android --verbose
+ cordova-cli run android
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/create.txt
----------------------------------------------------------------------
diff --git a/doc/create.txt b/doc/create.txt
index d3cab64..39c37ca 100644
--- a/doc/create.txt
+++ b/doc/create.txt
@@ -5,12 +5,16 @@ Synopsis
Create a Cordova project
PATH ......................... Where to create the project
- ID ........................... reverse-domain-style package name - used in <widget id>
- NAME ......................... human readable field
+ ID ........................... Reverse-domain-style package name - used in <widget id>
+ NAME ......................... Human readable name
CONFIG ....................... json string whose key/values will be included in
[PATH]/.cordova-cli/config.json
- Options:
- --template=<PATH|NPM PACKAGE|GIT URL> ... use a custom template located locally, in NPM, or GitHub.
- --copy-from|src=<PATH> .................. deprecated, use --template instead.
- --link-to=<PATH> ........................ symlink to custom www assets without creating a copy.
\ No newline at end of file
+Options
+
+ --template=<PATH|NPM PACKAGE|GIT URL> ... use a custom template located locally, in NPM, or GitHub.
+ --copy-from|src=<PATH> .................. deprecated, use --template instead.
+ --link-to=<PATH> ........................ symlink to custom www assets without creating a copy.
+
+Example
+ cordova-cli create myapp com.mycompany.myteam.myapp MyApp
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/emulate.txt
----------------------------------------------------------------------
diff --git a/doc/emulate.txt b/doc/emulate.txt
index b15db20..c2272fd 100644
--- a/doc/emulate.txt
+++ b/doc/emulate.txt
@@ -2,6 +2,6 @@ Synopsis
cordova-cli emulate [PLATFORM...] [-- [platformopts]]
-Alias for `cordova-cli run --emulator`
+Alias for `cordova-cli run --emulator`. Use 'cordova-cli help run' for details on options.
To provide platform specific options, you must include them after `--`.
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/platform.txt
----------------------------------------------------------------------
diff --git a/doc/platform.txt b/doc/platform.txt
index 3be63e9..1c0395d 100644
--- a/doc/platform.txt
+++ b/doc/platform.txt
@@ -4,48 +4,45 @@ Synopsis
Manage project platforms
- add <plat-spec> [...].............. add specified platforms
- --save ........................ save specified platforms into config.xml after installing them
+ add <plat-spec> [...].............. Add specified platforms
+ --save ........................ Save specified platforms into config.xml after installing them
- --link ........................ when <plat-spec> is a local path, links the platform
+ --link ........................ When <plat-spec> is a local path, links the platform
library directly instead of making a copy of it (support
varies by platform; useful for platform development)
- remove <platform> [...] ........... remove specified platforms
- --save ........................ delete specified platforms from config.xml after removing them
+ remove <platform> [...] ........... Remove specified platforms
+ --save ........................ Delete specified platforms from config.xml after removing them
- list .............................. list all installed and available platforms
- update <plat-spec> ................ update the version of Cordova used for a specific platform;
- update to the latest <version> if no <version>, <path> or <url> is specified
+ update <plat-spec> ................ Update the version of Cordova used for a specific platform;
+ update to the latest <version> if no <plat-spec> is specified
- --save ........................ save the latest versions for specified platforms into config.xml
+ --save ........................ Save the latest versions for specified platforms into config.xml
- check ............................. list platforms which can be updated by `cordova-cli platform update`
+ list .............................. List all installed and available platforms
+ check ............................. List platforms which can be updated by `cordova-cli platform update`
Syntax
- <plat-spec>:
- <platform-ver>|<path>|<git-url>
-
- <platform-ver>:
- <platform>[@<version>]
-
- <git-url>:
- <url>[#<branch>]
-
- <platform> ........................ platform (typically from npm registry)
-
- <path> ............................ path to a directory containing a platform
- name of platform to be retrieved from npm registry
-
- <url> ............................. url to a git repository containing a platform
-
- <version> ......................... major.minor.patch version specifier
-
- <branch> .......................... name of the branch to checkout after cloning the git repo
- if none is specified, the 'master' branch will be checked out
-aliases:
+ <plat-spec> : <platform>[@<version>]|<path>|<url>[#<commit-ish>]
+
+ <platform> ........................ Platform name e.g. android, ios, windows etc.
+ <path> ............................ Path to a directory containing a platform
+ <url> ............................. Url to a git repository containing a platform
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
+
+Aliases
platforms -> platform
rm -> remove
ls -> list
+
+Examples
+ cordova-cli platform add android --save
+ cordova-cli platform add android@^5.0.0 --save
+ cordova-cli platform add https://github.com/myfork/cordova-android.git#4.0.0 --save
+ cordova-cli platform add ../android --save
+ cordova-cli platform add ../cordova-android.tgz --save
+ cordova-cli platform rm android --save
+ cordova-cli platform ls
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/plugin.txt
----------------------------------------------------------------------
diff --git a/doc/plugin.txt b/doc/plugin.txt
index 73d9689..a57a168 100644
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -4,41 +4,49 @@ Synopsis
Manage project plugins
- add <pluginid>|<directory>|<giturl> [...] ..... add specified plugins
- pluginid will be matched in --searchpath / registry
- directory is a directory containing a plugin
- giturl is a git repo containing a plugin
-
- [--searchpath <directory>] ................ when looking up plugins by ID, look in this directory and
- each of its subdirectories for the plugin before hitting the registry.
- Multiple search paths can be used by either specifying the flag multiple
- times, or by separating paths with a delimiter (: on 'nix, ; on Windows).
-
- [--noregistry] ............................ don't search the registry for plugins
-
- [--link] .................................. when installing from a local path, creates a symbolic link to the plugin
- instead of copying files. The extent to which files are linked vs copied
- varies by platform. Useful for plugin development.
- [--save] .................................. save the information for specified plugin into config.xml
- [--shrinkwrap] ............................ used together with --save, saves the installed version number to config.xml
-
-
-
- remove <pluginid> [...] ....................... remove plugins with the given IDs
+ add <plugin-spec> [...] ............ Add specified plugins
+ --searchpath <directory> ....... When looking up plugins by ID, look in this directory and
+ each of its subdirectories before hitting the registry.
+ Multiple search paths can be specified.
+
+ --noregistry ................... Don't search the registry for plugins
+
+ --link ......................... When installing from a local path, creates a symbolic link
+ instead of copying files. The extent to which files are linked
+ varies by platform. Useful for plugin development.
+ --save ......................... Save the information for specified plugin into config.xml
+ --shrinkwrap ................... Used together with --save, saves the
+ installed version numbers to config.xml
+ --browserify ................... Compile plugin JS at build time using
+ browserify instead of runtime.
+
+ remove <pluginid>|<name> [...] ..... Remove plugins with the given IDs/name.
- [--save] ................................... remove the information for specified plugin into config.xml
+ --save ......................... Remove the information for specified plugin into config.xml
+
+ list .............................. List currently installed plugins
+ search [<keyword>] [...] .......... Search http://plugins.cordova.io for plugins matching the keywords
+
+Syntax
+ <plugin-spec> : <pluginID>[@<version>]|<directory>|<url>[#<commit-ish>]
- list .......................................... list currently installed plugins
- search [<keyword>] [...] ...................... search the plugin registry for plugins matching the keywords
+ <plugin> .......................... Plugin id (id of plugin in npm registry or --searchPath)
+ <directory> ....................... Directory containing plugin.xml
+ <url> ............................. Url to a git repository containing a plugin.xml
+ <version> ......................... Major.minor.patch version specifier using semver
+ <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
-aliases:
+Aliases
plugins -> plugin
rm -> remove
ls -> list
-
-Experimental Flags
-
- --browserify .......................... Plugins javascript gets loaded at build time instead of runtime using browserify.
- Replaces cordovajs file with one that includes the JS of the installed plugins.
+Examples
+ cordova-cli plugin add cordova-plugin-camera --save
+ cordova-cli plugin add cordova-plugin-camera@^2.0.0 --save --searchpath ~/plugins
+ cordova-cli plugin add https://github.com/myfork/cordova-plugin-camera.git#2.0.0 --save
+ cordova-cli plugin add ../cordova-plugin-camera --save
+ cordova-cli plugin add ../cordova-plugin-camera.tgz --save
+ cordova-cli plugin rm camera --save
+ cordova-cli plugin ls
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/prepare.txt
----------------------------------------------------------------------
diff --git a/doc/prepare.txt b/doc/prepare.txt
index 10b61d6..984f86a 100644
--- a/doc/prepare.txt
+++ b/doc/prepare.txt
@@ -5,6 +5,9 @@ Synopsis
Copies files for specified platforms, or all platforms,
so that the project is ready to build with each SDK.
- --browserify ...................... Compile plugin JS at build time instead of runtime
- using browserify. Replaces cordovajs file with one
- that includes the JS of the installed plugins.
+Options
+ --browserify .............................. Compile plugin JS at build time using
+ browserify instead of runtime.
+
+Example
+ cordova-cli prepare --browserify
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/requirements.txt
----------------------------------------------------------------------
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 44217b4..0a79d33 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -5,3 +5,6 @@ Synopsis
Checks and print out all the requirements for platforms specified (or all platforms added
to project if none specified). If all requirements for each platform are met, exits with code 0
otherwise exits with non-zero code.
+
+Example
+ cordova-cli requirements android
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/75dbae56/doc/run.txt
----------------------------------------------------------------------
diff --git a/doc/run.txt b/doc/run.txt
index 9374ddb..3d28571 100644
--- a/doc/run.txt
+++ b/doc/run.txt
@@ -29,6 +29,9 @@ Deploys app on specified platform devices / emulators
--buildConfig....................... Use the specified build configuration
instead of default build.json
+ --browserify ....................... Compile plugin JS at build time using
+ browserify instead of runtime.
+
To provide platform specific options, you must include them after `--`.
Technical details
@@ -36,11 +39,8 @@ Technical details
calls PLATFORM run
PLATFORM run calls PLATFORM build (unless --nobuild)
-Experimental Flags
-
- --browserify ....................... Plugins javascript gets loaded at build time instead of runtime using browserify.
- Replaces cordovajs file with one that includes the JS of the installed plugins.
-
-Example
-
- cordova run android --release --buildConfig=..\myBuildConfig.json --target=myEmulator
+Examples
+ cordova-cli run android --release --buildConfig=..\myBuildConfig.json --target=myEmulator
+ cordova-cli run android --nobuild
+ cordova-cli run ios --device
+ cordova-cli run ios --list
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org
[2/2] cordova-cli git commit: CB-10348 Addressed code review
feedback. This closes #232
Posted by ni...@apache.org.
CB-10348 Addressed code review feedback. This closes #232
Project: http://git-wip-us.apache.org/repos/asf/cordova-cli/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-cli/commit/9aecfb8f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-cli/tree/9aecfb8f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-cli/diff/9aecfb8f
Branch: refs/heads/master
Commit: 9aecfb8f2edccc1984c749b8e7b14cfcb26bfff8
Parents: 75dbae5
Author: Nikhil Khandelwal <ni...@microsoft.com>
Authored: Tue Jan 26 12:56:38 2016 -0800
Committer: Nikhil Khandelwal <ni...@microsoft.com>
Committed: Tue Jan 26 13:51:58 2016 -0800
----------------------------------------------------------------------
doc/build.txt | 1 +
doc/clean.txt | 2 +-
doc/cordova.txt | 8 ++++++--
doc/emulate.txt | 3 ++-
doc/platform.txt | 4 ++--
doc/plugin.txt | 8 ++++----
6 files changed, 16 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/build.txt
----------------------------------------------------------------------
diff --git a/doc/build.txt b/doc/build.txt
index a3670a4..3d254bb 100644
--- a/doc/build.txt
+++ b/doc/build.txt
@@ -30,3 +30,4 @@ To provide platform specific options, you must include them after `--`.
Example
cordova-cli build android windows --debug --device
cordova-cli build android --release --buildConfig=..\myBuildConfig.json
+ cordova-cli build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/clean.txt
----------------------------------------------------------------------
diff --git a/doc/clean.txt b/doc/clean.txt
index e50eccf..6d8de2d 100644
--- a/doc/clean.txt
+++ b/doc/clean.txt
@@ -8,4 +8,4 @@ by running platform-provided clean script.
To provide platform specific options, you must include them after `--`.
Example
- corodva-cli clean android
\ No newline at end of file
+ cordova-cli clean android
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/cordova.txt
----------------------------------------------------------------------
diff --git a/doc/cordova.txt b/doc/cordova.txt
index 4cb03c2..2a80f44 100644
--- a/doc/cordova.txt
+++ b/doc/cordova.txt
@@ -21,6 +21,9 @@ Project Commands
(including prepare && compile)
serve .............................. Run project with a local webserver
(including prepare)
+
+Learn more about command options using 'cordova-cli help <command>'
+
Aliases
build -> cordova-cli prepare && cordova-cli compile
emulate -> cordova-cli run --emulator
@@ -37,5 +40,6 @@ Examples
cordova-cli plugin add cordova-plugin-camera --save
cordova-cli platform add android --save
cordova-cli requirements android
- cordova-cli buid android --verbose
- cordova-cli run android
\ No newline at end of file
+ cordova-cli build android --verbose
+ cordova-cli run android
+ cordova-cli build android --release -- --keystore="..\android.keystore" --storePassword=android --alias=mykey
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/emulate.txt
----------------------------------------------------------------------
diff --git a/doc/emulate.txt b/doc/emulate.txt
index c2272fd..7209320 100644
--- a/doc/emulate.txt
+++ b/doc/emulate.txt
@@ -2,6 +2,7 @@ Synopsis
cordova-cli emulate [PLATFORM...] [-- [platformopts]]
-Alias for `cordova-cli run --emulator`. Use 'cordova-cli help run' for details on options.
+Alias for `cordova-cli run --emulator`. Launches the emulator instead of device.
+Use 'cordova-cli help run' for details on options.
To provide platform specific options, you must include them after `--`.
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/platform.txt
----------------------------------------------------------------------
diff --git a/doc/platform.txt b/doc/platform.txt
index 1c0395d..c9140e5 100644
--- a/doc/platform.txt
+++ b/doc/platform.txt
@@ -31,7 +31,7 @@ Syntax
<path> ............................ Path to a directory containing a platform
<url> ............................. Url to a git repository containing a platform
<version> ......................... Major.minor.patch version specifier using semver
- <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
+ <commit-ish> ...................... Commit/tag/bramch reference. If none is specified, 'master' is used
Aliases
platforms -> platform
@@ -39,7 +39,7 @@ Aliases
ls -> list
Examples
- cordova-cli platform add android --save
+ cordova-cli platform add android ios --save
cordova-cli platform add android@^5.0.0 --save
cordova-cli platform add https://github.com/myfork/cordova-android.git#4.0.0 --save
cordova-cli platform add ../android --save
http://git-wip-us.apache.org/repos/asf/cordova-cli/blob/9aecfb8f/doc/plugin.txt
----------------------------------------------------------------------
diff --git a/doc/plugin.txt b/doc/plugin.txt
index a57a168..3d7116e 100644
--- a/doc/plugin.txt
+++ b/doc/plugin.txt
@@ -35,7 +35,7 @@ Syntax
<directory> ....................... Directory containing plugin.xml
<url> ............................. Url to a git repository containing a plugin.xml
<version> ......................... Major.minor.patch version specifier using semver
- <commit-ish> ...................... Commit/tag reference. If none is specified, 'master' is used
+ <commit-ish> ...................... Commit/tag/branch reference. If none is specified, 'master' is used
Aliases
plugins -> plugin
@@ -43,9 +43,9 @@ Aliases
ls -> list
Examples
- cordova-cli plugin add cordova-plugin-camera --save
- cordova-cli plugin add cordova-plugin-camera@^2.0.0 --save --searchpath ~/plugins
- cordova-cli plugin add https://github.com/myfork/cordova-plugin-camera.git#2.0.0 --save
+ cordova-cli plugin add cordova-plugin-camera cordova-plugin-file --save --searchpath ~/plugins
+ cordova-cli plugin add cordova-plugin-camera@^2.0.0 --save
+ cordova-cli plugin add https://github.com/myfork/cordova-plugin-camera.git#2.1.0 --save
cordova-cli plugin add ../cordova-plugin-camera --save
cordova-cli plugin add ../cordova-plugin-camera.tgz --save
cordova-cli plugin rm camera --save
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org