summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2019-09-26 18:03:13 -0400
committerJordan Wiens <jordan@psifertex.com>2019-09-26 18:03:13 -0400
commit8e8594522f3d2e90540ebf01e470d9c15af6d6ea (patch)
tree2b209faf52fc1696bb1f047f53f38674303dd8e4 /docs/guide
parentc00e2e304e548ab03a69e81ce46e76772adc0ccd (diff)
fix repository documentation instructions and remove message about the API being disabled
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/plugins.md26
1 files changed, 16 insertions, 10 deletions
diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md
index 4c0e88f2..5347d79d 100644
--- a/docs/guide/plugins.md
+++ b/docs/guide/plugins.md
@@ -49,23 +49,28 @@ after cloning or else the submodules will not actually be downloaded.
### Installing via the API
-(NOTE THAT THIS API IS TEMPORARILY DISABLED TO BETTER SUPPORT A WIDER VARIETY OF LINUX DISTRIBUTIONS)
-
Binary Ninja now offers a [PluginManager API] which can simplify the process of finding and installing plugins. From the console:
```
>>> mgr = RepositoryManager()
>>> dir(mgr)
-['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'add_repository', 'check_for_updates', 'default_repository', 'disable_plugin', 'enable_plugin', 'handle', 'install_plugin', 'plugins', 'repositories', 'uninstall_plugin', 'update_plugin']
+['__class__', '__delattr__', '__dict__', '__dir__', '__doc__', '__eq__', '__format__', '__ge__', '__getattribute__', '__getitem__', '__gt__', '__hash__', '__init__', '__init_subclass__', '__le__', '__lt__', '__module__', '__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'add_repository', 'check_for_updates', 'default_repository', 'handle', 'plugins', 'repositories']
>>> mgr.plugins
-{'default': [<binaryninja-bookmarks not-installed/disabled>, <binaryninja-msp430 not-installed/disabled>, <binaryninja-radare2 not-installed/disabled>, <binaryninja-spu not-installed/disabled>, <binja-avr not-installed/disabled>, <binja_smali not-installed/disabled>, <binjatron not-installed/disabled>, <binoculars not-installed/disabled>, <easypatch not-installed/disabled>, <liil installed/enabled>, <list_comments not-installed/disabled>, <x64dbgbinja not-installed/disabled>]}
->>> mgr.install_plugin("easypatch")
+{'community': [<joshwatson_binaryninjamsp430 not-installed/disabled>, <Alex3434_BinjaSigMaker not-installed/disabled>, <toolCHAINZ_structor not-installed/disabled>, <Vascojofra_jumptablebrancheditor not-installed/disabled>, <zznop_bnida not-installed/disabled>, <zznop_bngenesis not-installed/disabled>, <zznop_bnkallsyms not-installed/disabled>, <zznop_binjago not-installed/disabled>, <zznop_bnrecursion not-installed/disabled>, <bkerler_annotate installed/enabled>, <verylazyguy_binaryninjavmndh not-installed/disabled>, <0x1F9F1_binjamsvc not-installed/disabled>, <fluxchief_binaryninja_avr not-installed/disabled>, <withzombies_bnilgraph installed/enabled>, <mechanicalnull_sourcery_pane not-installed/disabled>, <chame1eon_binaryninjafrida not-installed/disabled>, <Vascojofra_formatstringfinderbinja installed/enabled>, <shareef12_driveranalyzer not-installed/disabled>, <carstein_Syscaller not-installed/disabled>, <404d_peutils not-installed/disabled>, <ForAllSecure_bncov not-installed/disabled>, <ehntoo_binaryninjasvd not-installed/disabled>, <whitequark_binja_function_abi not-installed/disabled>, <bowline90_BinRida not-installed/disabled>, <wrigjl_binaryninjam68k not-installed/disabled>], 'official': [<Vector35_OpaquePredicatePatcher not-installed/disabled>, <Vector35_sample_plugin not-installed/disabled>]}
+>>> mgr.plugins['community'][0].installed
+False
+>>> mgr.plugins['community'][0].installed = True
+>>> mgr.plugins['community'][0].installed
True
->>> mgr.enable_plugin("easypatch")
+>>> mgr.plugins['community'][0].enabled
+False
+>>> mgr.plugins['community'][0].enabled = True
+>>> mgr.plugins['community'][0].enabled
+>>> mgr.plugins['community'][0].enabled
True
```
-Then just restart, and your plugin will be loaded.
+Then just restart, and your plugin will be loaded.
### Installing Prerequisites
@@ -78,7 +83,7 @@ pip.main(['install', '--quiet', 'packagename'])
_--quiet is required to minimize some of the normal output of pip that doesn't work within the context of our scripting console_
-For both OS X and Linux, Binary Ninja can utilize the built in system Python so any installed packages should be available there via whatever typical mechanism you use.
+Binary Ninja can also switch to a different installed version of Python using the [python.interpreter setting].
### Troubleshooting
@@ -104,7 +109,7 @@ To start, we suggest you download the [sample plugin] as a template since it con
### Plugin Debugging Mode
-Available via the [preferences] dialog, enabling plugin debugging mode will not only enable additional IL types via the UI.
+Available via [settings], enabling plugin debugging mode will enable additional IL types via the UI.
### UI Elements
@@ -129,4 +134,5 @@ For the Personal edition, we recommend simply commenting out the `register_` fun
[angr]: https://github.com/Vector35/binaryninja-api/blob/dev/python/examples/angr_plugin.py
[nampa]: https://github.com/kenoph/nampa
[installing the API]: https://github.com/Vector35/binaryninja-api/blob/dev/scripts/install_api.py
-[preferences the API]: https://docs.binary.ninja/getting-started.html#preferencesupdates
+[settings]: ../getting-started.html#ui.debugMode
+[python.interpreter setting]: ../getting-started.html#python.interpreter