You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dev/concepts.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ ILs in general are critical to how Binary Ninja analyzes binaries and we have mu
6
6
7
7
APIs that query these mappings are plural. So for example, while `current_hlil.llil` will give a single mapping, `current_hlil.llils` will return a list that may contain multiple mappings.
8
8
9
-

9
+

Copy file name to clipboardExpand all lines: docs/dev/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,17 @@
1
1
# Using the Binary Ninja API
2
2
3
-
Welcome to the Binary Ninja API documentation. Much like the [User Manual](/guide/), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right.
3
+
Welcome to the Binary Ninja API documentation. Much like the [User Manual](./guide/index.html), some larger sections have been split off into their own sections on the left, while the table of contents for this documentation is on the right.
4
4
5
5
## Language Specific Bindings
6
6
7
7
The Binary Ninja API is available through a [Core API](#core-api), through the [C++ API](#c-api), through a [Python API](#python-api), and a [Rust API](#rust-api).
8
8
9
9
### Python API
10
10
11
-
The most heavily documented of all of the APIs, the Python API serves as a useful documentation for the other APIs. Here's a list of the most important Python API documentation resources:
11
+
The Python API is the most common third-party API and is used in many [public plugins](https://github.com/vector35/community-plugins). Here's a list of the most important Python API documentation resources:
12
12
13
13
-[Writing Python Plugins](plugins.md)
14
-
-[Python API](https://api.binary.ninja/)
14
+
-[Python API Reference](https://api.binary.ninja/) (available offline via the Help menu)
Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](/guide/).
3
+
Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. If you're interested in more detailed information, check out the [User Manual](guide/index.md).
4
4
5
-

5
+

6
6
## Installing Binary Ninja
7
7
8
8
The download links you receive after purchasing expire after 72hrs but as long as you have [active support](https://binary.ninja/faq/#updates) you can [request download links](https://binary.ninja/recover/) any time!
@@ -23,35 +23,35 @@ When you first run Binary Ninja, it will prompt you for your license key. You sh
23
23
24
24
## Opening Files
25
25
26
-
While there are [more ways than shown here](/guide/#loading-files), the most common ways to open a file are:
26
+
While there are [more ways than shown here](./guide/index.md#loading-files), the most common ways to open a file are:
27
27
28
28
- Drag-and-drop
29
29
- File Open
30
30
- Run via CLI
31
31
32
-
But you can also change how analysis happens using [open with options](/guide/#loading-files).
32
+
But you can also change how analysis happens using [open with options](./guide/index.md#loading-files).
33
33
34
34
## UI Basics
35
35
36
-

36
+

37
37
38
38
By default, you'll see four main areas in Binary Ninja:
39
39
40
-
1. Symbol List (one of many [sidebars](guide/#the-sidebar))
1. Main View (defaults to High Level IL and can have many [panes](./guide/index.md#tiling-panes))
43
+
1.[Feature Map](guide/index.md#feature-map)
44
44
45
-
Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/#script-python-console) and log window.
45
+
Not enabled by default but can be made visible is the global area which includes the [scripting console](guide/index.md#script-python-console) and log window.
46
46
47
-
Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](guide/#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings)
47
+
Make sure to check out the many view options available in the various ☰ ("hamburger") menus. However, most configuration settings are available in the [settings](./guide/index.md#settings) menu. (`[CMD/CTRL] ,` is the hotkey for settings)
48
48
in the top right of each pane allows for additional customization, including locking the pane to a single function.
One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](/guide/#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](/guide/#custom-hotkeys). That said, here are a few of the more useful default hotkeys:
54
+
One of the most useful features of Binary Ninja is that everything can be quickly and easily accessed through a [command-palette](./guide/index.md#command-palette) (`[CMD/CTRL] p`). You'll be surprised how often it saves you from looking through menus to find out just what you need. Also, any action in the command-palette can be changed to a [custom hotkey](./guide/index.md#custom-hotkeys). That said, here are a few of the more useful default hotkeys:
55
55
56
56
-`[ESC]` : Navigate backward
57
57
-`[SPACE]` : Toggle between linear view and graph view
@@ -66,29 +66,29 @@ One of the most useful features of Binary Ninja is that everything can be quickl
66
66
-`r` : Change the data type to single ASCII character
67
67
-`o` : Create a pointer data type
68
68
69
-
For more hotkeys, see the [User Manual](/guide/).
69
+
For more hotkeys, see the [User Manual](./guide/index.md).
70
70
71
71
72
72
## Intermediate Languages
73
73
74
-
Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](/dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](/guide/#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings.
74
+
Binary Ninja is one of the most advanced binary analysis platforms, and it has a unique stack of related intermediate languages. If that gets you excited, you'll surely want to check out the [developer guide](./dev/bnil-overview.md) for more information. If it doesn't mean anything to you, no worries, here's a few tips to make your life easier. The default view is "High Level IL". It looks and reads almost like pseudo code. There's a few extra notations (usually just around comparisons for whether they are signed or not, or between moves of data indicating the size of the operation) but it should otherwise be very understandable. If you prefer disassembly or even [Pseudo C](./guide/index.md#pseudo-c) as your default view, no worries, just check out the `UI`/`view.graph` and `view.linear` settings.
75
75
76
76
## Using Plugins
77
77
78
-
Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](guide/#user-folder), or using the [Plugin Manager](guide/plugins.md#plugin-manager).
78
+
Plugins can be installed by one of two methods. First, they can be manually installed by copying the plugin to the appropriate [folder](./guide/index.md#user-folder), or using the [Plugin Manager](./guide/plugins.md#plugin-manager).
79
79
80
80
## Debugger
81
81
82
82
Binary Ninja includes a debugger that can debug executables on Windows, Linux, and macOS.
83
83
84
-
For more detailed information, see the [debugger guide](/guide/debugger.md).
84
+
For more detailed information, see the [debugger guide](./guide/debugger.md).
85
85
86
86
## Updates
87
87
88
-
While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](guide/#updates) dialog.
88
+
While Binary Ninja automatically updates itself, by default you will only use the Stable Branch and you can check out features much faster on the development branch using the [update channel](./guide/index.md#updates) dialog.
89
89
90
90
## What's next?
91
91
92
-
- Consider writing your first [plugin](/dev/)
92
+
- Consider writing your first [plugin](./dev/index.md)
0 commit comments