https://github.com/mmrlapp/pty-x
A Pseudoterminal built for WebUI X
https://github.com/mmrlapp/pty-x
Last synced: 12 months ago
JSON representation
A Pseudoterminal built for WebUI X
- Host: GitHub
- URL: https://github.com/mmrlapp/pty-x
- Owner: MMRLApp
- License: gpl-3.0
- Created: 2025-06-29T20:09:48.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-06-29T22:03:25.000Z (12 months ago)
- Last Synced: 2025-06-29T22:34:14.371Z (12 months ago)
- Language: C++
- Size: 123 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PTY X for WebUI X
A Pseudoterminal built for WebUI X
## Install
Install the APK from GitHub Releases and paste the following into a choosen module. Or use the new Plugin editor in WebUI X: Portable
> [!IMPORTANT]
> This plugin requires at least WebUI X: Portable `v130`!
`/data/adb/.config//config.webroot.json`
```jsonc
{
// ... other configuration
"dexFiles": [
{
"type": "apk",
"path": "dev.mmrl.wxu.pty",
"className": "dev.mmrl.wxu.pty.Shell",
// Never disable the cached mode. It will crash when you close the WebUI and you re-open it.
"cache": true
}
]
}
```
After this have been done, you can use the PTY API
```ts
export {};
interface Shell {
start(sh: String, argsJson: String | null, envJson: String | null): void;
start(
sh: String,
argsJson: String,
envJson: String,
cols: number,
rows: number
): void;
write(data: String): void;
kill(): void;
resize(cols: number, rows: number): void;
}
declare global {
interface Window {
pty: Shell;
}
}
```
Basic usage
```js
import { WXEventHandler } from "https://esm.sh/webuix";
const wx = new WXEventHandler();
// Handle terminal data
wx.on(window, "pty-data", (event) => {
if (event.wx) {
console.log(event.wx);
}
});
// Handle terminal exit
wx.on(window, "pty-exit", (event) => {
console.log(`Process exited with code ${event.wx}`);
});
// Start the terminal when the window is loaded
window.addEventListener("load", () => {
const args = JSON.stringify([]);
const env = JSON.stringify({
PWD: "$(pwd)",
USER: "$(id -un)",
HOSTNAME: "$(uname -n)",
PATH: "/data/adb/ksu/bin:/data/adb/ap/bin:/data/adb/magisk:/system/bin:/sbin:/vendor/bin:/system/sbin:/system/xbin:/system/product/bin:/system/system_ext/bin",
});
window.pty.start("/system/bin/su", args, env);
// Alternative if you want it raw
// window.pty.start("/system/bin/su", null, null);
});
```