Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 3.08 KB

README.md

File metadata and controls

71 lines (50 loc) · 3.08 KB
Raw

Android Shell

Execute shell commands on Android.

API License Maven Central

Download the latest AAR or grab via Gradle:

compile 'com.jaredrummler:android-shell:1.0.0'

Usage

Common utility functions include:

CommandResult Shell.run(String shell, String... commands)
CommandResult Shell.SH.run(String... commands)
CommandResult Shell.SU.run(String... commands)

The result will contains the exit code, standard output (stdout), and standard error (stderr).

Example of running a command as root:

CommandResult result = Shell.SU.run("id");
if (result.isSuccessful()) {
  System.out.println(result.getStdout());
  // Example output on a rooted device:
  // uid=0(root) gid=0(root) groups=0(root) context=u:r:init:s0
}

You can open multiple shell instances using Shell.Builder or Shell.Console.Builder. Calling Shell.SU.run(String... commands) will keep a su session open in the background so additional calls will not create new superuser requests.

Fore more information please see http://su.chainfire.eu/

Acknowledgements

libsuperuser by Chainfire

License

Copyright (C) 2016 Jared Rummler
Copyright (C) 2012-2015 Jorrit "Chainfire" Jongma

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.