search

Vector35 / community-plugins

Repository for community provided Binary Ninja plugins
MIT License
411 stars 32 forks source link

[NewPlugin] WhatTheFuzz binaryninja-openai 1.0.0 #199

Closed WhatTheFuzz closed 1 year ago

WhatTheFuzz commented 1 year ago

Please add my plugin to the repository.

Yes, I've read the instructions, especially the part about creating an actual release and creating the tag.

I either used the UI, or the hub command to create a real release.

Author: Sean Deaton (@WhatTheFuzz) Repo name: binaryninja-openai Release: Initial Release

psifertex commented 1 year ago

Looks great, I'll add it shortly. Can I also suggest that maybe allowing people to use the settings system to put their openai key in would be useful?

psifertex commented 1 year ago

Added, thanks!

Also, few other notes:

Are you aware of https://github.com/mahaloz/DAILA

Secondly, you might consider removing the longdescription from your plugin.json. The newer plugin manager behavior is to just render the readme directly in that case which makes it easier to maintain. Though you do have to format the images in the readme a bit differently to have them render in a compatible way.

WhatTheFuzz commented 1 year ago

Looks great, I'll add it shortly. Can I also suggest that maybe allowing people to use the settings system to put their openai key in would be useful?

By this, do you mean there is an interface where a plugins can add entries that users can adjust in Binary Ninja's preferences?

Are you aware of https://github.com/mahaloz/DAILA

No, I wasn't aware of it. Looks like we share the same goals though. I've chatted with author before, so I'll have to reach out again! Thank you.

Secondly, you might consider removing the longdescription from your plugin.json. The newer plugin manager behavior is to just render the readme directly in that case which makes it easier to maintain. Though you do have to format the images in the readme a bit differently to have them render in a compatible way.

Easy fix. I will create an issue to address those in the next release. Thanks.

I appreciate you taking the time to address these points and introduce me to a new project!

psifertex commented 1 year ago

Looks great, I'll add it shortly. Can I also suggest that maybe allowing people to use the settings system to put their openai key in would be useful?

By this, do you mean there is an interface where a plugins can add entries that users can adjust in Binary Ninja's preferences?

Yup, any plugin that registers settings will have them show up in the UI which makes it a convenient place to store something like the openai key that might be used by multiple plugins potentially in the future.

Are you aware of https://github.com/mahaloz/DAILA

No, I wasn't aware of it. Looks like we share the same goals though. I've chatted with author before, so I'll have to reach out again! Thank you.

Secondly, you might consider removing the longdescription from your plugin.json. The newer plugin manager behavior is to just render the readme directly in that case which makes it easier to maintain. Though you do have to format the images in the readme a bit differently to have them render in a compatible way.

Easy fix. I will create an issue to address those in the next release. Thanks.

Saw the issue -- if I have time later I might take a stab at submitting a PR, just posted those ideas as I had them.

I appreciate you taking the time to address these points and introduce me to a new project!

Of course!

WhatTheFuzz commented 1 year ago

Registering keys in Settings was super easy and implemented in 218a681. I will cut a new release later today. Thanks Jordan.