hackerai-tech / PentestGPT

AI-Powered Automated Penetration Testing Tool
https://pentestgpt.ai/
GNU General Public License v3.0
853 stars 40 forks source link

Implement Pre-built Plugin Queries for Enhanced User Guidance and Engagement #80

Closed RostyslavManko closed 8 months ago

RostyslavManko commented 8 months ago

Background

In order to enhance user experience and facilitate better understanding of our plugin functionalities, we aim to implement pre-built queries for each plugin within our application. These queries will provide users with examples and guidance on how to effectively utilize the plugins, making their interactions more productive and engaging.

Objective

Our goal is to design and implement a user-friendly feature that displays pre-built queries for each plugin, helping users to easily understand and use the plugins. These queries should be visible only when the user has not typed anything in the chat input field and is not currently typing.

Actions and Considerations (ACC)

  1. Design and Implementation:

    • [x] Create a dynamic list of pre-built queries for each plugin, with four distinct examples per plugin.
    • [x] Design the feature to display the relevant pre-built queries only in new chats.
    • [x] Ensure the queries are easily editable through a simple configuration file. Image
  2. Plugin-Specific Queries:

    • [x] Develop a system that associates each pre-built query with its respective plugin, ensuring the appropriate queries are displayed when a user selects a specific plugin.
    • [x] Make sure the queries are tailored to showcase the unique capabilities and functions of each plugin.
  3. User Interface and Experience:

    • [x] Design the pre-built queries to be easily clickable, allowing users to insert the selected query into the chat input field with a single click.
    • [x] Ensure the feature is intuitive and visually appealing, enhancing the overall user experience.
  4. Testing and Quality Assurance:

    • [x] Conduct extensive testing on various devices, platforms, and browsers to ensure compatibility.
    • [x] Test standard and edge-case scenarios to guarantee feature reliability and robustness.

Expected Outcomes

fkesheh commented 8 months ago

PR https://github.com/Hacker-GPT/HackerGPT-2.0/pull/141