Skip to content

Commit ab9e793

Browse files
authored
Update README.md
1 parent d8e8114 commit ab9e793

1 file changed

Lines changed: 30 additions & 25 deletions

File tree

README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
# <img src="./images/banner.png">
2-
3-
# Official Binary Ninja Plugin for RevEng.AI
1+
<p align="center"><img src="./images/banner.png" ></p>
2+
Official Binary Ninja Plugin for RevEng.AI
43

54
### Features Supported
65

@@ -38,6 +37,7 @@ Expected output locations:
3837
4. Ensure the folder structure looks like this:
3938

4039
```
40+
Example in Linux...
4141
~/.binaryninja/plugins/
4242
└── revengai/
4343
└── [plugin files...]
@@ -47,67 +47,73 @@ Expected output locations:
4747
4848
### Step 3: Install Dependencies
4949

50-
In your system terminal (not inside Binary Ninja), install required dependencies using:
50+
In your system terminal (not inside Binary Ninja), move to the directory with the 'requirements.txt' file and install required dependencies using:
5151

5252
```bash
53-
pip install -r ~/.binaryninja/plugins/revengai/requirements.txt
53+
pip install -r requirements.txt
5454
```
5555

5656
Or directly from within Binary Ninja’s built-in Python terminal:
5757

5858
```python
5959
import subprocess
60-
subprocess.check_call(['pip', 'install', '-r', '/path/to/revengai/requirements.txt'])
60+
subprocess.check_call(['pip', 'install', '-r', '/path/to/requirements.txt']) # Change to your path to requirements.txt
6161
```
6262

6363
---
6464

6565
## Using the Plugin ⚙️
6666

67-
Once installed, you’ll find `RevEng.AI` in the Binary Ninja toolbar menu.
67+
Once installed, you’ll find `RevEng.AI` listed in the Binary Ninja plugins toolbar menu.
68+
69+
<img src="images/plugintoolbar.png" >
6870

69-
> 🖼️ *Insert screenshot of the RevEng.AI menu in Binary Ninja*
71+
Make sure to restart Binary Ninja completely after installation.
72+
Then, check the Plugins menu — the RevEng.AI plugin should be visible.
73+
Finally, load a binary and explore the features described below.
7074

7175
### 1. Configure the Plugin
7276

7377
Select `Configuration` from the menu to set up your API key and host.
7478

75-
> 🖼️ *Insert screenshot of configuration window*
79+
<img src="./images/config.png" >
7680

77-
Clicking "Continue" will validate your API key and auto-populate available models.
81+
Clicking "Continue" will validate your API key.
7882

7983
---
8084

81-
### 2. Choose Source Analysis
85+
### 2. Process a Binary
8286

83-
If you’ve already uploaded and processed a binary in the platform, you can select it as your working source.
87+
Upload the currently loaded binary to RevEng.AI:
8488

85-
> 🖼️ *Insert screenshot of the choose-source UI*
89+
- Select `RevEng.AI > Process Binary`
8690

87-
This is required before using some features like function matching or auto-unstrip.
91+
<img src="./images/processbinary.png" >
92+
93+
Before starting the process, you can add a PDB file and debug information, assign custom tags for better tracking, choose which AI model you want to use, and decide whether to keep the analysis private (default) or make it publicly available.
94+
The plugin will handle the upload and initiate the analysis. Once completed, an internal analysis ID is assigned.
8895

8996
---
9097

91-
### 3. Process a Binary
98+
### 3. Choose Source Analysis
9299

93-
Upload the currently loaded binary to RevEng.AI:
100+
If you have already processed your binary on the platform or if there are publicly available analyses, you can select one as your working source.
94101

95-
- Open your binary in Binary Ninja
96-
- Select `RevEng.AI > Process Binary`
102+
- Select `RevEng.AI > Choose Source`
97103

98-
> 🖼️ *Insert screenshot of binary processing prompt*
104+
<img src="./images/choosesource.png" >
99105

100-
The plugin will handle the upload and initiate the analysis. Once completed, an internal analysis ID is assigned.
106+
This is required before using some features like function matching or auto unstrip.
101107

102108
---
103109

104-
### 4. Auto-Unstrip
110+
### 4. Auto Unstrip
105111

106-
Bring back stripped symbol names automatically:
112+
Bring back symbol names automatically:
107113

108-
- Select `RevEng.AI > Auto-Unstrip`
114+
- Select `RevEng.AI > Auto Unstrip`
109115

110-
> 🖼️ *Insert screenshot of auto-unstrip in action*
116+
<img src="./images/autounstrip.png" >
111117

112118
Functions will be renamed with the most likely matching names from your configured collections.
113119

@@ -117,7 +123,6 @@ Functions will be renamed with the most likely matching names from your configur
117123

118124
Use function matching to identify similar functions in other binaries or collections:
119125

120-
- Open any function
121126
- Click `RevEng.AI > Match Functions`
122127

123128
> 🖼️ *Insert screenshot of match functions result*

0 commit comments

Comments
 (0)