Skip to content

Commit 655048a

Browse files
committed
docs: update README with comprehensive features, installation instructions, and usage guide
1 parent 1ebbcb3 commit 655048a

File tree

2 files changed

+108
-1
lines changed

2 files changed

+108
-1
lines changed

README.md

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,108 @@
11
# frida-ui
2-
Interact with Frida devices, processes, and scripts directly from your browser.
2+
3+
A modern, web-based user interface for [Frida](https://frida.re/), allowing you to interact with devices, processes, and scripts directly from your browser.
4+
5+
## Features
6+
7+
### 📱 Device Management
8+
9+
- **Auto-discovery**: Automatically detects connected USB and local devices.
10+
- **Remote Devices**: Easily add and manage remote Frida servers (e.g., `192.168.1.x:27042`).
11+
- **Device Info**: View detailed system parameters (OS, Arch, API Level) for selected devices.
12+
13+
### 🚀 Process & App Control
14+
15+
- **Application List**: View installed applications and running processes.
16+
- **Search**: Real-time filtering of applications by name or identifier.
17+
- **Session Management**:
18+
- **Attach**: Connect to running processes.
19+
- **Spawn**: Launch installed applications.
20+
- **Spawn & Run**: Launch an app and immediately inject a script (early instrumentation).
21+
- **Kill/Detach**: Terminate processes or gracefully disconnect.
22+
23+
### 💻 Scripting & Instrumentation
24+
25+
- **Script Editor**: Built-in editor for writing Frida scripts.
26+
- **File Loading**: Load scripts from local files or drag-and-drop `.js` files into the editor.
27+
- **CodeShare Integration**:
28+
- Import scripts directly from [Frida CodeShare](https://codeshare.frida.re/).
29+
- Create a "Queue" of CodeShare scripts to inject sequentially.
30+
31+
### 📊 Console & Logging
32+
33+
- **Real-time Output**: View `console.log`, `send()`, and error messages from your scripts.
34+
- **Log History**: Persistent logs per application session.
35+
- **Export**: Download console logs as `.txt` files for analysis.
36+
37+
### 🎨 UI/UX
38+
39+
- **Dark Theme**: Clean, consistent dark mode interface.
40+
- **Persistence**: Remembers your selected device, application, and window sizes.
41+
- **Responsive**: Adjustable panes for sidebar, editor, and console.
42+
43+
## Quick Start
44+
45+
### Prerequisites
46+
47+
- Python 3.7+
48+
- [uv](https://docs.astral.sh/uv/) (recommended)
49+
50+
### Installation
51+
52+
1. Clone the repository:
53+
54+
```bash
55+
git clone https://github.com/adityatelange/frida-ui.git
56+
cd frida-ui
57+
```
58+
59+
2. Install frida-ui using uv:
60+
61+
```bash
62+
uv tool install .
63+
```
64+
65+
> To customize the Frida version used by frida-ui, pass the desired version to uv when installing. For example:
66+
>
67+
> ```bash
68+
> uv tool install . --with frida==16.7.19
69+
> ```
70+
71+
### Running
72+
73+
Start the server:
74+
75+
```bash
76+
frida-ui
77+
```
78+
79+
Or with custom options:
80+
81+
```bash
82+
frida-ui --host 127.0.0.1 --port 8000 --reload
83+
```
84+
85+
- `--host`: Specify the host (default: 127.0.0.1)
86+
- `--port`: Specify the port (default: 8000)
87+
- `--reload`: Enable auto-reload for development
88+
89+
Open **http://localhost:8000** in your browser.
90+
91+
## Usage Guide
92+
93+
1. **Select a Device**: Choose a device from the dropdown in the top header.
94+
2. **Select an App**: Click on an application in the sidebar.
95+
3. **Write/Load Script**:
96+
- Type JS in the editor.
97+
- Or drag & drop a file.
98+
- Or add scripts URL from CodeShare.
99+
4. **Action**:
100+
- Click **Attach** to inject into a running process.
101+
- Click **Spawn** to start the app.
102+
- Click **Spawn & Run** to start the app with your script injected immediately.
103+
5. **Monitor**: Watch the console for output.
104+
105+
## Security Warning
106+
107+
> [!NOTE]
108+
> This tool allows executing arbitrary JavaScript in target processes. Only expose frida-ui to trusted networks and users. Executing untrusted scripts can compromise your system and data. The web server runs locally by default but exposes powerful instrumentation capabilities.

setup.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
long_description=desc,
1515
long_description_content_type="text/markdown",
1616
author="adityatelange",
17+
license="MIT",
1718
url="https://github.com/adityatelange/frida-ui",
1819
download_url="https://github.com/adityatelange/frida-ui/archive/v%s.zip"
1920
% __import__("frida_ui").__version__,

0 commit comments

Comments
 (0)