Skip to content

Commit

Permalink
Update web-browser.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Goodman authored Aug 13, 2024
1 parent b5eab26 commit 90a3c81
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions docs/web-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,29 @@ from an indexed database. The web browser also implements a feature [requested](
by Phil Eaton: being able to quickly find functions that share the same function signature.
The underlying analysis for finding same-typed functions is its own [tool](group-functions.md).

To run the web browser, first install NiceGUI using `pip install nicegui`. Then:


To run the web browser, first download a [pre-built release for Linux](https://github.com/trailofbits/multiplier/releases) of Multiplier. Then,
follow the [instructions to index a codebase](INDEXING.MD). In this example, I indexed OpenSSH.

If you're using a pre-built release extracted to `/path/to/multiplier/release`, then you'll want to set up a Python virtual environment as follows:

```shell
$ python3.12 -m venv /path/multiplier/release
$ source /path/multiplier/release/bin/activate
(multiplier) $
```

Next, install NiceGUI into the Python virtual environment:

```shell
(multiplier) $ python -m pip install nicegui
```

Finally, invoke [WebBrowser.py](../bin/Examples/WebBrowser.py) from a *source checkout* of Multiplier.

```shell
python /path/to/multiplier/checkout/bin/Examples/WebBrowser.py --db /tmp/openssh.db
(multiplier) $ python /path/to/multiplier/source/bin/Examples/WebBrowser.py --db /tmp/openssh.db
```

Using and indexed OpenSSH as an example, here is what the web browser looks like
Expand All @@ -31,4 +50,4 @@ References are both clickable, triggering redirects to their definitions
Clicking each of the right click menu options for the `addr_unicast_masklen` function
shows the following for references to, references from, and same-typed functions:

![File tree view](images/web-browser-3.png)
![File tree view](images/web-browser-3.png)

0 comments on commit 90a3c81

Please sign in to comment.