Library for KernelSU's module WebUI
npm install kernelsu``sh`
yarn add kernelsu
Spawns a root shell and runs a command within that shell, returning a Promise that resolves with the stdout and stderr outputs upon completion.
- command The command to run, with space-separated arguments.options
-
`javascript
import { exec } from 'kernelsu';
const { errno, stdout, stderr } = await exec('ls -l', { cwd: '/tmp' });
if (errno === 0) {
// success
console.log(stdout);
}
`
Spawns a new process using the given command in root shell, with command-line arguments in args. If omitted, args defaults to an empty array.
Returns a ChildProcess instance. Instances of ChildProcess represent spawned child processes.
- command The command to run.args
- List of string arguments.options
-
Example of running ls -lh /data, capturing stdout, stderr, and the exit code:
`javascript
import { spawn } from 'kernelsu';
const ls = spawn('ls', ['-lh', '/data']);
ls.stdout.on('data', (data) => {
console.log(stdout: ${data});
});
ls.stderr.on('data', (data) => {
console.log(stderr: ${data});
});
ls.on('exit', (code) => {
console.log(child process exited with code ${code});`
});
#### ChildProcess
##### Event 'exit'
- code The exit code if the child process exited on its own.
The 'exit' event is emitted when the child process ends. If the process exits, code contains the final exit code; otherwise, it is null.
##### Event 'error'
- err The error.
The 'error' event is emitted whenever:
- The process could not be spawned.
- The process could not be killed.
##### stdout
A Readable Stream that represents the child process's stdout.
`javascript
const subprocess = spawn('ls');
subprocess.stdout.on('data', (data) => {
console.log(Received chunk ${data});`
});
#### stderr
A Readable Stream that represents the child process's stderr.
Request the WebView enter/exit full screen.
`javascript`
import { fullScreen } from 'kernelsu';
fullScreen(true);
Request the WebView to set padding to 0 or safeDrawing insets
- tips: this is disabled by default but if you request resource from internal/insets.css, this will be enabled automatically.@import "https://mui.kernelsu.org/internal/insets.css";
- To get insets value and enable this automatically, you can
- add in css OR
- add in html.
`javascript`
import { enableEdgeToEdge } from 'kernelsu';
enableEdgeToEdge(true);
Show a toast message.
`javascript`
import { toast } from 'kernelsu';
toast('Hello, world!');
Get module info.
`javascript`
import { moduleInfo } from 'kernelsu';
// print moduleId in console
console.log(moduleInfo());
List installed packages.
Returns an array of package names.
- type The type of packages to list: "user", "system", or "all".
`javascript`
import { listPackages } from 'kernelsu';
// list user packages
const packages = listPackages("user");
- tips: when listPackages api is available, you can use ksu://icon/{packageName} to get app icon.
` javascript`
img.src = "ksu://icon/" + packageName;
Get information for a list of packages.
Returns an array of PackagesInfo objects.
- packages The list of package names.
`javascript`
import { getPackagesInfo } from 'kernelsu';
const packages = getPackagesInfo(['com.android.settings', 'com.android.shell']);
#### PackagesInfo
An object contains:
- packageName Package name of the application.versionName
- Version of the application.versionCode
- Version code of the application.appLabel
- Display name of the application.isSystem
- Whether the application is a system app.uid
- UID of the application.
Exit the current WebUI activity.
`javascript``
import { exit } from 'kernelsu';
exit();