blob: 2f4fb58d89988a9be191d1eb227d1408a5dc1fde [file] [log] [blame]
plugman manages plugin.xml-compatible cordova plugins into cordova-generated projects.
Usage
=====
Install a plugin
----------------
$ plugman install --platform <platform> --project <directory> --plugin <plugin> [--variable NAME=VALUE]
Parameters:
- platform <platform>: One of android, ios, blackberry10, wp7 or wp8
- project <directory>: Path reference to a cordova-generated project of the platform you specify
- plugin <plugin>: One of a path reference to a local copy of a plugin, or a remote https: or git: URL pointing to a cordova plugin (optionally append #branch:subdir) or a plugin ID from http://plugins.cordova.io
- variable NAME=VALUE: Some plugins require install-time variables to be defined. These could be things like API keys/tokens or other app-specific variables.
Uninstall a plugin
------------------
$ plugman uninstall --platform <platform> --project <directory> --plugin <plugin-id>
Parameters:
- plugin <plugin-id>: The plugin to remove, identified by its id (see the plugin.xml's <plugin id> attribute)
Optional parameters
-------------------
- www <directory>: www assets for the plugin will be installed into this directory. Default is to install into the standard www directory for the platform specified
- plugins_dir <directory>: a copy of the plugin will be stored in this directory. Default is to install into the <project directory>/plugins folder
- searchpath <directory>: a directory to look in for a plugin with the provided ID before looking on http://plugins.cordova.io
Use the searchpath flag multiple times to specify several directories (searched in order). The search is not recursive and will only look one level down.
Optional flags
--------------
--debug|-d : Verbose mode
--help|-h : Displays this message
--version|-v : Displays version
Interacting with the registry
=============================
Add a user account
------------------
$ plugman adduser
Publish a plugin
----------------
$ plugman publish <directory>
Unpublish a plugin
------------------
$ plugman unpublish <name>@<version>
Search for a plugin
-------------------
$ plugman search <keyword1 keyword2 ...>
Display plugin information
-----------------------
$ plugman info plugin
Manage registry configuration
-----------------------------
$ plugman config set registry http://localhost:5984/registry/_design/app/_rewrite
$ plugman config get registry
Manage owners
-------------
$ plugman owner ls org.apache.cordova.core.file
$ plugman owner add username org.apache.cordova.core.file
$ plugman owner rm username org.apache.cordova.core.file