summaryrefslogtreecommitdiff
path: root/python/pluginmanager.py
diff options
context:
space:
mode:
authorKyleMiles <krm504@nyu.edu>2024-06-08 00:25:45 -0400
committerKyleMiles <krm504@nyu.edu>2024-06-14 15:26:02 -0400
commit51c0684340555c3a2f85461224f327402a546287 (patch)
treef502882689adc8e7030ddc7be8855f9acbc94cb1 /python/pluginmanager.py
parent8b0b1add74d6944b03d55ad7be2019f91a4a5ef3 (diff)
Correct doc comment about not being able to remove plugin repositories; Also add doc comment for #2987
Diffstat (limited to 'python/pluginmanager.py')
-rw-r--r--python/pluginmanager.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/python/pluginmanager.py b/python/pluginmanager.py
index 237ab9fb..94232e2f 100644
--- a/python/pluginmanager.py
+++ b/python/pluginmanager.py
@@ -386,9 +386,10 @@ class RepositoryManager:
"""
``add_repository`` adds a new plugin repository for the manager to track.
- There is currently no function to remove a repository. If you want to
- remove a repository, you must delete the directory and remove the
- plugin_status.json entries from repositories/ file in the User Folder
+ To remove a repository, restart Binary Ninja (and don't re-add the repository!).
+ File artifacts will remain on disk under repositories/ file in the User Folder.
+
+ Before you can query plugin metadata from a repository, you need to call ``check_for_updates``.
:param str url: URL to the plugins.json containing the records for this repository
:param str repopath: path to where the repository will be stored on disk locally
@@ -399,6 +400,7 @@ class RepositoryManager:
>>> mgr = RepositoryManager()
>>> mgr.add_repository("https://raw.githubusercontent.com/Vector35/community-plugins/master/plugins.json", "community")
True
+ >>> mgr.check_for_updates()
>>>
"""
if not isinstance(url, str) or not isinstance(repopath, str):