Commit from GitHub Actions (Update Plugin Repository)

README.md

@@ -13,6 +13,7 @@
 |[BD Viewer](https://github.com/PistonMiner/binaryninja-bindiff-viewer)|[Linus S. (aka PistonMiner)](https://github.com/PistonMiner)|View BinDiff results and port symbols|2022-07-26|helper, ui|MIT|
 |[Binary Ninja Ollama](https://github.com/ahaggard2013/binaryninja-ollama)|[Austin Haggard](https://github.com/ahaggard2013)|Binary Ninja Ollama integrates with your own locally hosted ollama server to rename functions and variables with AI|2024-07-16|architecture, binaryview, core, helper, ui|MIT|
 |[Binary Ninja Type Manager](https://github.com/Ayrx/binja-typemanager)|[Terry Chia](https://github.com/Ayrx)|Manage custom type libraries.|2021-01-30|helper|MIT|
+|[BinAssist](https://github.com/jtang613/BinAssist)|[Jason Tang](https://github.com/jtang613)|A plugin that provides LLM helpers to explain code and assist in RE.|2024-09-11|helper, ui|MIT|
 |[Binja IPython console](https://github.com/skr0x1c0/ipybinja)|[skr0x1c0](https://github.com/skr0x1c0)|IPython console widget for Binary Ninja|2022-12-12|binaryview, core, helper, ui|MIT|
 |[binja-doc-lookup](https://github.com/riskydissonance/binja-doc-lookup)|[riskydissonance](https://github.com/riskydissonance)|Lookup documentation for the selected token|2024-06-20|helper, ui|MIT|
 |[binja-win-docs](https://github.com/matteyeux/binja-win-docs)|[matteyeux](https://github.com/matteyeux)|Binary Ninja plugin to display the documentation of a Windows function in a sidebar widget.|2024-04-11|helper, ui|Apache-2.0|

plugins.json

@@ -1,4 +1,164 @@
 [
+    {
+        "pluginmetadataversion": 2,
+        "name": "BinAssist",
+        "type": [
+            "ui",
+            "helper"
+        ],
+        "api": [
+            "python3"
+        ],
+        "description": "A plugin that provides LLM helpers to explain code and assist in RE.",
+        "longdescription": "This is a LLM plugin aimed at enabling the use of local LLM's (ollama, text-generation-webui, lm-studio, etc) for assisting with binary exploration and reverse engineering. It supports any OpenAI v1-compatible API. Recommended models are LLaMA-based models such as llama3.1:8b, but others should work as well.\n\nCurrent features include:\n* Explain the current function - Works at all IL levels.\n* Explain the current instruction - Works at all IL levels.\n* General query - Query the LLM directly from the UI.\n* Propose actions - Provide a list of proposed actions to apply.\n* Function calling - Allow agent to call functions to navigate the binary, rename functions and variables.\n* RLHF dataset generation - To enable model fine tuning.\n* RAG augmentation - Supports adding contextual documents to refine query effectiveness.\n* Settings to modify API host, key, model name and max tokens.\n\nFuture Roadmap:\n* Agentic assistant - Use Autogen or similar framework for self-guided binary RE.\n* Model fine tuning - Leverage the RLHF dataset to fine tune the model.\n\n## Screenshot\n![Screenshot](/res/screenshots.gif)\n\n## Homepage\nhttps://github.com/jtang613/BinAssist",
+        "license": {
+            "name": "MIT",
+            "text": "Copyright (c) 2024 Jason Tang\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
+        },
+        "platforms": [
+            "Linux",
+            "Windows",
+            "Darwin"
+        ],
+        "installinstructions": {
+            "Linux": "An OpenAI compatible API is required. For local LLM support, use Ollama, LMStudio, Open-WebUI, Text-Generation-WebUI, etc.",
+            "Windows": "Untested but should work. Submit an Issue or Pull Request for support.",
+            "Darwin": "Untested but should work. Submit an Issue or Pull Request for support."
+        },
+        "dependencies": "openai\npysqlite3\nmarkdown\nhttpx\nchromadb\nsentence-transformers",
+        "version": "0.1.0",
+        "author": "Jason Tang",
+        "minimumbinaryninjaversion": 3164,
+        "lastUpdated": 1726087901,
+        "projectUrl": "https://github.com/jtang613/BinAssist",
+        "projectData": {
+            "id": 837757379,
+            "node_id": "R_kgDOMe8pww",
+            "name": "BinAssist",
+            "full_name": "jtang613/BinAssist",
+            "private": false,
+            "owner": {
+                "login": "jtang613",
+                "id": 11688468,
+                "node_id": "MDQ6VXNlcjExNjg4NDY4",
+                "avatar_url": "https://avatars.githubusercontent.com/u/11688468?v=4",
+                "gravatar_id": "",
+                "url": "https://api.github.com/users/jtang613",
+                "html_url": "https://github.com/jtang613",
+                "followers_url": "https://api.github.com/users/jtang613/followers",
+                "following_url": "https://api.github.com/users/jtang613/following{/other_user}",
+                "gists_url": "https://api.github.com/users/jtang613/gists{/gist_id}",
+                "starred_url": "https://api.github.com/users/jtang613/starred{/owner}{/repo}",
+                "subscriptions_url": "https://api.github.com/users/jtang613/subscriptions",
+                "organizations_url": "https://api.github.com/users/jtang613/orgs",
+                "repos_url": "https://api.github.com/users/jtang613/repos",
+                "events_url": "https://api.github.com/users/jtang613/events{/privacy}",
+                "received_events_url": "https://api.github.com/users/jtang613/received_events",
+                "type": "User",
+                "site_admin": false
+            },
+            "html_url": "https://github.com/jtang613/BinAssist",
+            "description": "Binary Ninja plugin to provide LLM assistance analyzing binaries.",
+            "fork": false,
+            "url": "https://api.github.com/repos/jtang613/BinAssist",
+            "forks_url": "https://api.github.com/repos/jtang613/BinAssist/forks",
+            "keys_url": "https://api.github.com/repos/jtang613/BinAssist/keys{/key_id}",
+            "collaborators_url": "https://api.github.com/repos/jtang613/BinAssist/collaborators{/collaborator}",
+            "teams_url": "https://api.github.com/repos/jtang613/BinAssist/teams",
+            "hooks_url": "https://api.github.com/repos/jtang613/BinAssist/hooks",
+            "issue_events_url": "https://api.github.com/repos/jtang613/BinAssist/issues/events{/number}",
+            "events_url": "https://api.github.com/repos/jtang613/BinAssist/events",
+            "assignees_url": "https://api.github.com/repos/jtang613/BinAssist/assignees{/user}",
+            "branches_url": "https://api.github.com/repos/jtang613/BinAssist/branches{/branch}",
+            "tags_url": "https://api.github.com/repos/jtang613/BinAssist/tags",
+            "blobs_url": "https://api.github.com/repos/jtang613/BinAssist/git/blobs{/sha}",
+            "git_tags_url": "https://api.github.com/repos/jtang613/BinAssist/git/tags{/sha}",
+            "git_refs_url": "https://api.github.com/repos/jtang613/BinAssist/git/refs{/sha}",
+            "trees_url": "https://api.github.com/repos/jtang613/BinAssist/git/trees{/sha}",
+            "statuses_url": "https://api.github.com/repos/jtang613/BinAssist/statuses/{sha}",
+            "languages_url": "https://api.github.com/repos/jtang613/BinAssist/languages",
+            "stargazers_url": "https://api.github.com/repos/jtang613/BinAssist/stargazers",
+            "contributors_url": "https://api.github.com/repos/jtang613/BinAssist/contributors",
+            "subscribers_url": "https://api.github.com/repos/jtang613/BinAssist/subscribers",
+            "subscription_url": "https://api.github.com/repos/jtang613/BinAssist/subscription",
+            "commits_url": "https://api.github.com/repos/jtang613/BinAssist/commits{/sha}",
+            "git_commits_url": "https://api.github.com/repos/jtang613/BinAssist/git/commits{/sha}",
+            "comments_url": "https://api.github.com/repos/jtang613/BinAssist/comments{/number}",
+            "issue_comment_url": "https://api.github.com/repos/jtang613/BinAssist/issues/comments{/number}",
+            "contents_url": "https://api.github.com/repos/jtang613/BinAssist/contents/{+path}",
+            "compare_url": "https://api.github.com/repos/jtang613/BinAssist/compare/{base}...{head}",
+            "merges_url": "https://api.github.com/repos/jtang613/BinAssist/merges",
+            "archive_url": "https://api.github.com/repos/jtang613/BinAssist/{archive_format}{/ref}",
+            "downloads_url": "https://api.github.com/repos/jtang613/BinAssist/downloads",
+            "issues_url": "https://api.github.com/repos/jtang613/BinAssist/issues{/number}",
+            "pulls_url": "https://api.github.com/repos/jtang613/BinAssist/pulls{/number}",
+            "milestones_url": "https://api.github.com/repos/jtang613/BinAssist/milestones{/number}",
+            "notifications_url": "https://api.github.com/repos/jtang613/BinAssist/notifications{?since,all,participating}",
+            "labels_url": "https://api.github.com/repos/jtang613/BinAssist/labels{/name}",
+            "releases_url": "https://api.github.com/repos/jtang613/BinAssist/releases{/id}",
+            "deployments_url": "https://api.github.com/repos/jtang613/BinAssist/deployments",
+            "created_at": "2024-08-03T23:56:37Z",
+            "updated_at": "2024-09-11T20:51:41",
+            "pushed_at": "2024-09-11T20:50:46Z",
+            "git_url": "git://github.com/jtang613/BinAssist.git",
+            "ssh_url": "[email protected]:jtang613/BinAssist.git",
+            "clone_url": "https://github.com/jtang613/BinAssist.git",
+            "svn_url": "https://github.com/jtang613/BinAssist",
+            "homepage": "",
+            "size": 4576,
+            "stargazers_count": 0,
+            "watchers_count": 0,
+            "language": "Python",
+            "has_issues": true,
+            "has_projects": true,
+            "has_downloads": true,
+            "has_wiki": true,
+            "has_pages": false,
+            "has_discussions": false,
+            "forks_count": 0,
+            "mirror_url": null,
+            "archived": false,
+            "disabled": false,
+            "open_issues_count": 0,
+            "license": {
+                "key": "mit",
+                "name": "MIT License",
+                "spdx_id": "MIT",
+                "url": "https://api.github.com/licenses/mit",
+                "node_id": "MDc6TGljZW5zZTEz"
+            },
+            "allow_forking": true,
+            "is_template": false,
+            "web_commit_signoff_required": false,
+            "topics": [
+                "ai",
+                "llm",
+                "ml",
+                "reverse-engineering"
+            ],
+            "visibility": "public",
+            "forks": 0,
+            "open_issues": 0,
+            "watchers": 0,
+            "default_branch": "master",
+            "permissions": {
+                "admin": false,
+                "maintain": false,
+                "push": false,
+                "triage": false,
+                "pull": true
+            },
+            "temp_clone_token": "",
+            "network_count": 0,
+            "subscribers_count": 2
+        },
+        "authorUrl": "https://github.com/jtang613",
+        "packageUrl": "https://api.github.com/repos/jtang613/BinAssist/zipball/refs/tags/0.1.0",
+        "packageShortUrl": "https://v35.us/uff0jcv",
+        "path": "jtang613_BinAssist",
+        "commit": "68ae4f6870fda9e553b3efd3f4b4d0cdf9e9f0c1",
+        "minimumBinaryNinjaVersion": 0
+    },
     {
         "pluginmetadataversion": 2,
         "name": "MobiCore Loader Format",