Code Monkey home page Code Monkey logo

sidekick-public's Introduction

Sidekick Documentation

This README provides instructions for previewing the Sidekick documentation using mkdocs.

The source for the actual Sidekick plugin itself is proprietary, copyright Vector 35 and available via download through the Binary Ninja Plugin Manager rather than being hosted here on GitHub.

Prerequisites

To preview this documentation, you will need to have mkdocs installed on your system. If you don't have it installed, you can install it by running the following command:

pip install mkdocs

Preview the Documentation

To preview the documention:

  1. Navigate to the docs directory.

  2. Run the following command:

    mkdocs serve
  3. Open a web browser and navigate to http://localhost:8000.

This will start a development server and display a live preview of the documentation. You can edit the markdown files in the docs directory and the changes will be automatically reflected in the preview.

License

The license file (DOCS_LICENSE.txt) provided in this repository applies to the documentation in this repository.

sidekick-public's People

Contributors

kristopax avatar fuzyll avatar

Stargazers

Matei Martin avatar Glenn 'devalias' Grant avatar Christopher Carpenter avatar

Watchers

Alex Rønne Petersen avatar Jordan avatar Andrew Lamoureux avatar Peter LaFosse avatar  avatar

sidekick-public's Issues

Some feedback on the user plans

(I'm not sure if this is the appropriate place for feedback like this; please point me in the right direction if not!)

I just took a look at the pricing model for Sidekick. One thing that stood out to me is that the user plans don't seem well-suited to individuals like myself who use BN extensively during shorter periods, and not in a full-time work capacity. E.g. in my case, I tend to have some months of programming, followed by a month or two of reverse engineering, and so on.

I would have to frequently subscribe and then unsubscribe. And fair enough - maybe there's not really a good fix for that, it just is what it is. But it occurs to me that I'm probably not the only person in this boat; I would imagine that many personal/non-commercial users are similar. Such users would never be able to take advantage of the yearly discount, unless they can afford to pay for periods where they're not using BN as much or at all (which I'd argue defeats the discount anyway?).

I think the yearly discount makes a ton of sense for businesses, but it seems to me to not be a great fit for individuals. 🤔 But obviously I don't have any insight into your customer base, so this is all just my perspective/speculation.

Finally, the upfront cost for a year of Sidekick is also pretty steep for an individual. If you stick with the yearly subscription for individuals, I would suggest at least offering a model similar to Google Workspace where you can commit to a full year in advance, but still pay monthly or quarterly (or similar).

Regardless, speaking as someone who's otherwise wholly uninterested in e.g. GitHub Copilot, Sidekick looks like a very cool application of AI and I'm looking forward to giving it a try!

Plugin fails to update or install due to NumPy 2.0 Error

In versions prior to Sidekick 1.1.131, the Sidekick plugin fails to load after an update or install due to the following error:

[Default] A module that was compiled using NumPy 1.x cannot be run in [Default] NumPy 2.0.0 as it may crash. To support both 1.x and 2.x [Default] versions of NumPy, modules must be compiled with NumPy 2.0. [Default] Some module may need to rebuild instead e.g. with 'pybind11>=2.12'. [Default] If you are a user of the module, the easiest solution will be to [Default] downgrade to 'numpy<2' or try to upgrade the affected module. [Default] We expect that some modules will need time to support NumPy 2.

"Add Comment for Selected Lines" does not work well

Example:

image

If I ask Sidekick to add a comment explaining the selected code, what happens is:

image

If instead I try this code:

image

I get:

image

Which seems to indicate that it is describing the code above.

I get similarly odd results anywhere I've tried this feature. Seems like it could use some love in general.

Sidekick not installing or working after the latest update.

Version and Platform (required):

  • Binary Ninja Personal: latest
  • OS: Microsotf Windows 11 Home
  • OS Version: 10.0.22631 Build 22631
  • CPU Architecture: x64

Bug Description:
This is the error I am getting in the logs during installation:

Failed to import python plugin: official/Vector35_Sidekick: huggingface-hub>=0.23.0,<1.0 is required for a normal functioning of this module, but found huggingface-hub==0.22.2.
Try: `pip install transformers -U` or `pip install -e '.[dev]'` if you're working with git main
Failed to load plugin: Vector35_Sidekick

I tried the recommended solutions to no avail.

Steps To Reproduce:
Please provide all steps required to reproduce the behavior:

  1. Install Sidekick

*Expected Behavior:
Proper installation of Sidekick into the Binary Ninja platform.

Screenshots/Video Recording:
image

Binary:
N/A

Additional Information:
I did recently install a lot of plugins, but I also tried a fresh full uninstall and reinstall and received the same problem. However, the plugins didn't get removed upon removal of Binary Ninja from the host after reboot and I believe that the GEF plugin I use leverages the huggingface library which is unable to be installed to support Sidekick.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.