https://github.com/d4rken/RxShell

Easy shell access for Android apps using RxJava.
https://github.com/d4rken/RxShell

android root rxjava shell

Last synced: 3 months ago
JSON representation

Easy shell access for Android apps using RxJava.

• Host: GitHub
• URL: https://github.com/d4rken/RxShell
• Owner: d4rken
• License: apache-2.0
• Created: 2017-11-09T02:04:54.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:38:13.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T01:42:13.013Z (7 months ago)
• Topics: android, root, rxjava, shell
• Language: Java
• Homepage:
• Size: 341 KB
• Stars: 278
• Watchers: 34
• Forks: 89
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# RxShell

![Build](https://github.com/d4rken/RxShell/actions/workflows/android.yml/badge.svg)

[ ![Download](https://jitpack.io/v/d4rken/rxshell.svg)](https://jitpack.io/#d4rken/rxshell)

[ ![Coverage Status](https://coveralls.io/repos/github/d4rken/RxShell/badge.svg?branch=master)](https://coveralls.io/github/d4rken/RxShell?branch=master)

A library that helps your app interact with shells on Android.

## Quickstart

Include the library in your modules `build.gradle` file:

```groovy

implementation 'eu.darken.rxshell:'

```

Now your project is ready to use the library, let's quickly talk about a few core concepts:

1. You construct a shell using `RxCmdShell.builder()`.

2. The shell has to be opened before use (`shell.open()`), which will launch the process and give you a `RxCmdShell.Session` to work with.

3. Build your commands with `Cmd.builder("your command")`.

4. Commands are run with `session.submit(command)`, `cmd.submit(session)` or `cmd.execute(session)`.

5. Remember to `close()` the session to release resources.

### Examples

#### Single-Shot execution

If you pass a shell builder to the command it will be used for a single shot execution.

A shell is created and opened, used and closed.

`Cmd.execute(...)` is shorthand for `Cmd.submit(...).blockingGet()`, so don't run it from a UI thread.

```java

Cmd.Result result = Cmd.builder("echo hello").execute(RxCmdShell.builder());

```

#### Reusing a shell

If you want to issue multiple commands, you can reuse the shell which is faster and uses less resources.

```java

RxCmdShell.Session session = RxCmdShell.builder().build().open().blockingGet();

// Blocking

Cmd.Result result1 = Cmd.builder("echo straw").execute(session);

// Async

Cmd.builder("echo berry").submit(session).subscribe(result -> Log.i("ExitCode: " + result.getExitCode()));

shell.close().blockingGet();

```

The default shell process is launched using `sh`, if you want to open a root shell (using `su`) tell the ShellBuilder!

```java

Cmd.Result result = Cmd.builder("echo hello").execute(RxCmdShell.builder().root(true));

```

#### Checking root access

```java

// General info

new RootContext.Builder(getContext()).build().subscribe(c -> {/* c.getRoot().getState() */});

// Just root state

Root root = new Root.Builder().build().blockingGet();

if(root.getState() == Root.State.ROOTED) /* yay */

```

## Used by

* [SD Maid](https://github.com/d4rken/sdmaid-public), which was also the motivation for this library.

## Alternatives

While this is obviously :^) the best library, there are alternatives you could be interested in:

* [@Chainfire's](https://twitter.com/ChainfireXDA) [libsuperuser](https://github.com/Chainfire/libsuperuser)

* [@SpazeDog's](https://github.com/SpazeDog) [rootfw](https://github.com/SpazeDog/rootfw)

* [@topjohnwu's](https://twitter.com/topjohnwu) [libsu](https://github.com/topjohnwu/libsu)