Apache Cordova Plugin to Execute Commands in Smartphone's Operating System Shell
Java JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/org/apache/cordova/plugin
www
LICENSE
README.md
package.json
plugin.xml

README.md

cordova-plugin-shell-exec

Apache Cordova Plugin to Execute Commands in Smartphone's Operating System Shell

Supported Platforms

  • Android

Installation

$ cordova plugin add https://github.com/petervojtek/cordova-plugin-shell-exec.git

Usage

window.ShellExec.exec(cmd, callback)

cmd can be either a single string or an array of string arguments.

callback function will return a hash with two keys - exitStatus and output.

Example:

window.ShellExec.exec('uptime', function(res){
  console.log('exit status: ' + res.exitStatus)
  console.log('cmd output: ' + res.output)
})

JS console output:

exit status: 0
cmd output: up time: 10 days, 05:16:51, idle time: 17 days, 01:22:57, sleep time: 5 days, 16:38:37

If command execution fails (e.g. you enter wrong command), you receive exit status 100.

Example with root:

window.ShellExec.exec(['su', '-c', 'touch /sdcard/test.txt'], function(res){
  console.log('exit status: ' + res.exitStatus)
  console.log('cmd output: ' + res.output)
})

How to Contribute

Use pull request.