# WinDbg Copilot
WinDbg Copilot is a ChatGPT-powered AI assistant integrated with WinDbg. It analyzes the output of the commands and provides guidance to solve the stated problem.
## Prerequisites
1. **Operating System:** Windows 10 and above.
2. **OpenAI API:** If you want to use OpenAI API, add environment variable:
```
OPENAI_API_KEY = <Openai API Key>
```
3. **Azure OpenAI:** If you want to use Azure OpenAI, add the following environment variables:
```
AZURE_OPENAI_ENDPOINT = <Azure OpenAI Endpoint>
AZURE_OPENAI_KEY = <Azure OpenAI Key>
AZURE_OPENAI_DEPLOYMENT = <Azure OpenAI Deployment Name>
```
4. **Debugging Tools for Windows WinDbg (classic):** Installed on your machine.
```
Download URL: https://learn.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools
Add environment variable WinDbg_PATH = C:\Program Files\Debugging Tools for Windows (x64).
Add environment variable _NT_SYMBOL_PATH = srv*c:\symbols*https://msdl.microsoft.com/download/symbols
```
5. **Python:** Version >=3.9, <3.12 installed on your machine.
6. **Internet Connection:** For downloading and installing the package.
## Installation
1. Ensure you have Python installed.
2. Open the Command Prompt or PowerShell.
3. Install the package using pip:
```
pip install WinDbg_Copilot
```
## Running the Console and GUI versions
Users can run the console or GUI version as follows:
### Running the Console App:
Simply type in the Command Prompt or PowerShell:
```
windbg-copilot-console
```
### Running the GUI App:
Type in the Command Prompt or PowerShell:
```
windbg-copilot-gui
```
## Running using Python:
If users want to run the apps directly using Python:
### Running the Console App:
```
python -m WinDbg_Copilot.WinDbg_Copilot_Console
```
### Running the GUI App:
```
python -m WinDbg_Copilot.WinDbg_Copilot_GUI
```
# WinDbg Copilot Console App
Hello, I am WinDbg Copilot, I'm here to assist you.
The given commands are used to interact with WinDbg Copilot, a tool that utilizes the OpenAI model for assistance with debugging. The commands include:
!auto: auto mode, user provides a problem description, ChatGPT can reply with simple explanations or suggesting a single command to execute to further analyze the problem. Ask user to execute the suggested command or not.
!chat: chat mode, user inputs are forwarded to ChatGPT, ChatGPT can reply with simple answers or suggesting a single command to execute to further analyze the problem.
!command: command mode, user inputs are forwarded to debugger like manual debugging in WinDbg, debugger outputs are forwarded to ChatGPT, ChatGPT can reply with simple explanations or suggesting a single command to execute to further analyze the problem. User will decide to execute the suggested command or not.
!quit or !q or q or qq: Terminates the debugger session.
!help or !h: Provides help information.
Note: WinDbg Copilot requires an active Internet connection to function properly, as it relies on Openai API.
# WinDbg Copilot GUI App
Welcome to the WinDbg Copilot GUI App - your go-to solution for an enhanced debugging experience powered by AI!
## New Feature: Tab Widget
We have introduced a tab widget to the GUI application:
1. **Auto Tab:** Users provide a problem description, AI assistant guides the debugging process until no more suggestions or solution has been found.
2. **Chat Tab:** A unique interactive experience for more advanced users with existing WinDbg and debugging skills. Users can talk freely with the AI assistant, ask any debugging questions, and the AI assistant will reply with simple answers and provide an executable command. Users can execute the suggested command in the command window, and the AI assistant will process the WinDbg output and reply with further instructions.
## Overview
The WinDbg Copilot GUI App seamlessly blends the power of WinDbg with the intelligence of OpenAI, providing you with intelligent suggestions throughout your debugging session. With configurable settings, support for various file types, an integrated AI assistant, and the newly added tab widget, this app takes debugging to a whole new level.
## Features
1. **Configurable Settings Menu:** Tailor the app to your needs through a user-friendly settings menu.
2. **File Support:** Open local memory dump files or time travel trace files directly within the app.
3. **Remote Debugger Connection:** Need to debug remotely? Connect effortlessly to a remote debugger from within the app.
4. **Integrated WinDbg Command Window:** Positioned on the left side of the app; View debugger outputs conveniently in a dedicated text widget; Enter your debug commands in an entry widget located just below the display.
5. **AI-Powered Assistant with Tab Widget:** Now enjoy the flexibility of Auto and Chat tabs for different debugging experiences.
## How It Works
1. Begin by entering a problem description in the AI assistant window.
2. Send this description to OpenAI via the app.
3. Receive a suggested debug command from OpenAI, presented as a clickable link.
4. Click on the suggestion to execute it in the WinDbg command window.
5. View the debugger output and await further suggestions from the AI assistant.
6. Continue this interactive process until you receive no more suggestions or until your problem is resolved.
# Uninstallation
Open a command prompt or terminal window. Use pip to uninstall the WinDbg Copilot package:
```
pip uninstall WinDbg_Copilot
```
The packages will be uninstalled automatically.
## Conclusion
Gone are the days of sifting through endless logs and documentation. With the WinDbg Copilot GUI App, you have a powerful AI sidekick to guide you through the debugging process, making it more intuitive, interactive, and efficient. Happy debugging!
# Disclaimer: WinDbg Copilot
WinDbg Copilot is an application designed for debugging learning purposes only. It is important to note that this application should not be used to load or handle any customer data. WinDbg Copilot is intended solely for the purpose of providing a platform for debugging practice and learning experiences.
When using WinDbg Copilot, please be aware that any debugging input and output generated during your debugging sessions will be sent to OpenAI or Azure OpenAI according to your selection. This data may be used for analysis and improvement of the application's performance and capabilities. However, it is crucial to understand that no customer data should be loaded or shared through WinDbg Copilot.
WinDbg Copilot project takes the privacy and security of user information seriously and endeavors to handle all data with utmost care and in accordance with applicable laws and regulations. Nevertheless, it is strongly recommended to refrain from providing any sensitive or confidential information while using WinDbg Copilot.
By using WinDbg Copilot, you acknowledge and agree that any debugging input and output you generate may be transmitted to OpenAI or Azure OpenAI for research and development purposes. You also understand that WinDbg Copilot should not be used with customer data and that WinDbg Copilot project is not responsible for any consequences that may arise from the misuse or mishandling of such data.
Please ensure that you exercise caution and adhere to best practices when utilizing WinDbg Copilot to ensure the privacy and security of your own data. WinDbg Copilot project will not be held liable for any damages, losses, or unauthorized access resulting from the misuse of this application.
By proceeding to use WinDbg Copilot, you signify your understanding and acceptance of these terms and conditions.
Raw data
{
"_id": null,
"home_page": "https://github.com/suannai231/WinDbg_Copilot",
"name": "WinDbg-Copilot",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": "",
"keywords": "WinDbg,Copilot,chatgpt,openai",
"author": "Jack Yin",
"author_email": "suannai231@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/79/b60ce6bbb77c41cabc203b3088809aa46ea7f5ea8fb939b42fb2e239e4d8/WinDbg_Copilot-1.0.62.tar.gz",
"platform": null,
"description": "# WinDbg Copilot\r\n\r\nWinDbg Copilot is a ChatGPT-powered AI assistant integrated with WinDbg. It analyzes the output of the commands and provides guidance to solve the stated problem.\r\n\r\n## Prerequisites\r\n\r\n1. **Operating System:** Windows 10 and above.\r\n2. **OpenAI API:** If you want to use OpenAI API, add environment variable:\r\n ```\r\n OPENAI_API_KEY = <Openai API Key>\r\n ```\r\n3. **Azure OpenAI:** If you want to use Azure OpenAI, add the following environment variables:\r\n ```\r\n AZURE_OPENAI_ENDPOINT = <Azure OpenAI Endpoint>\r\n AZURE_OPENAI_KEY = <Azure OpenAI Key>\r\n AZURE_OPENAI_DEPLOYMENT = <Azure OpenAI Deployment Name>\r\n ```\r\n4. **Debugging Tools for Windows WinDbg (classic):** Installed on your machine.\r\n ```\r\n Download URL: https://learn.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools\r\n Add environment variable WinDbg_PATH = C:\\Program Files\\Debugging Tools for Windows (x64).\r\n Add environment variable _NT_SYMBOL_PATH = srv*c:\\symbols*https://msdl.microsoft.com/download/symbols\r\n ```\r\n5. **Python:** Version >=3.9, <3.12 installed on your machine.\r\n6. **Internet Connection:** For downloading and installing the package.\r\n\r\n## Installation\r\n\r\n1. Ensure you have Python installed.\r\n2. Open the Command Prompt or PowerShell.\r\n3. Install the package using pip:\r\n ```\r\n pip install WinDbg_Copilot\r\n ```\r\n\r\n## Running the Console and GUI versions\r\n\r\nUsers can run the console or GUI version as follows:\r\n\r\n### Running the Console App:\r\n\r\nSimply type in the Command Prompt or PowerShell:\r\n```\r\nwindbg-copilot-console\r\n```\r\n\r\n### Running the GUI App:\r\n\r\nType in the Command Prompt or PowerShell:\r\n```\r\nwindbg-copilot-gui\r\n```\r\n\r\n## Running using Python:\r\n\r\nIf users want to run the apps directly using Python:\r\n\r\n### Running the Console App:\r\n\r\n```\r\npython -m WinDbg_Copilot.WinDbg_Copilot_Console\r\n```\r\n\r\n### Running the GUI App:\r\n\r\n```\r\npython -m WinDbg_Copilot.WinDbg_Copilot_GUI\r\n```\r\n# WinDbg Copilot Console App\r\n\r\nHello, I am WinDbg Copilot, I'm here to assist you.\r\n\r\nThe given commands are used to interact with WinDbg Copilot, a tool that utilizes the OpenAI model for assistance with debugging. The commands include:\r\n\r\n !auto: auto mode, user provides a problem description, ChatGPT can reply with simple explanations or suggesting a single command to execute to further analyze the problem. Ask user to execute the suggested command or not.\r\n !chat: chat mode, user inputs are forwarded to ChatGPT, ChatGPT can reply with simple answers or suggesting a single command to execute to further analyze the problem.\r\n !command: command mode, user inputs are forwarded to debugger like manual debugging in WinDbg, debugger outputs are forwarded to ChatGPT, ChatGPT can reply with simple explanations or suggesting a single command to execute to further analyze the problem. User will decide to execute the suggested command or not.\r\n !quit or !q or q or qq: Terminates the debugger session.\r\n !help or !h: Provides help information.\r\n\r\nNote: WinDbg Copilot requires an active Internet connection to function properly, as it relies on Openai API.\r\n\r\n# WinDbg Copilot GUI App\r\n\r\nWelcome to the WinDbg Copilot GUI App - your go-to solution for an enhanced debugging experience powered by AI!\r\n\r\n## New Feature: Tab Widget\r\n\r\nWe have introduced a tab widget to the GUI application:\r\n\r\n1. **Auto Tab:** Users provide a problem description, AI assistant guides the debugging process until no more suggestions or solution has been found.\r\n2. **Chat Tab:** A unique interactive experience for more advanced users with existing WinDbg and debugging skills. Users can talk freely with the AI assistant, ask any debugging questions, and the AI assistant will reply with simple answers and provide an executable command. Users can execute the suggested command in the command window, and the AI assistant will process the WinDbg output and reply with further instructions.\r\n\r\n## Overview\r\n\r\nThe WinDbg Copilot GUI App seamlessly blends the power of WinDbg with the intelligence of OpenAI, providing you with intelligent suggestions throughout your debugging session. With configurable settings, support for various file types, an integrated AI assistant, and the newly added tab widget, this app takes debugging to a whole new level.\r\n\r\n## Features\r\n\r\n1. **Configurable Settings Menu:** Tailor the app to your needs through a user-friendly settings menu.\r\n2. **File Support:** Open local memory dump files or time travel trace files directly within the app.\r\n3. **Remote Debugger Connection:** Need to debug remotely? Connect effortlessly to a remote debugger from within the app.\r\n4. **Integrated WinDbg Command Window:** Positioned on the left side of the app; View debugger outputs conveniently in a dedicated text widget; Enter your debug commands in an entry widget located just below the display.\r\n5. **AI-Powered Assistant with Tab Widget:** Now enjoy the flexibility of Auto and Chat tabs for different debugging experiences.\r\n\r\n## How It Works\r\n\r\n1. Begin by entering a problem description in the AI assistant window.\r\n2. Send this description to OpenAI via the app.\r\n3. Receive a suggested debug command from OpenAI, presented as a clickable link.\r\n4. Click on the suggestion to execute it in the WinDbg command window.\r\n5. View the debugger output and await further suggestions from the AI assistant.\r\n6. Continue this interactive process until you receive no more suggestions or until your problem is resolved.\r\n\r\n# Uninstallation\r\n\r\nOpen a command prompt or terminal window. Use pip to uninstall the WinDbg Copilot package:\r\n\r\n```\r\npip uninstall WinDbg_Copilot\r\n```\r\n\r\nThe packages will be uninstalled automatically.\r\n\r\n## Conclusion\r\n\r\nGone are the days of sifting through endless logs and documentation. With the WinDbg Copilot GUI App, you have a powerful AI sidekick to guide you through the debugging process, making it more intuitive, interactive, and efficient. Happy debugging!\r\n\r\n# Disclaimer: WinDbg Copilot\r\n\r\nWinDbg Copilot is an application designed for debugging learning purposes only. It is important to note that this application should not be used to load or handle any customer data. WinDbg Copilot is intended solely for the purpose of providing a platform for debugging practice and learning experiences.\r\n\r\nWhen using WinDbg Copilot, please be aware that any debugging input and output generated during your debugging sessions will be sent to OpenAI or Azure OpenAI according to your selection. This data may be used for analysis and improvement of the application's performance and capabilities. However, it is crucial to understand that no customer data should be loaded or shared through WinDbg Copilot.\r\n\r\nWinDbg Copilot project takes the privacy and security of user information seriously and endeavors to handle all data with utmost care and in accordance with applicable laws and regulations. Nevertheless, it is strongly recommended to refrain from providing any sensitive or confidential information while using WinDbg Copilot.\r\n\r\nBy using WinDbg Copilot, you acknowledge and agree that any debugging input and output you generate may be transmitted to OpenAI or Azure OpenAI for research and development purposes. You also understand that WinDbg Copilot should not be used with customer data and that WinDbg Copilot project is not responsible for any consequences that may arise from the misuse or mishandling of such data.\r\n\r\nPlease ensure that you exercise caution and adhere to best practices when utilizing WinDbg Copilot to ensure the privacy and security of your own data. WinDbg Copilot project will not be held liable for any damages, losses, or unauthorized access resulting from the misuse of this application.\r\n\r\nBy proceeding to use WinDbg Copilot, you signify your understanding and acceptance of these terms and conditions.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "\"WinDbg Copilot is a ChatGPT powered AI assistant integrated with WinDbg. It analyzes the output of the commands, and provides guidance to solve the stated problem.\"",
"version": "1.0.62",
"project_urls": {
"Homepage": "https://github.com/suannai231/WinDbg_Copilot"
},
"split_keywords": [
"windbg",
"copilot",
"chatgpt",
"openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1abd525ab0ba29d70c097980be69f464135e62060e577af1e70b8cb9fa12a504",
"md5": "9b03fd31076111c2afd4540af0423417",
"sha256": "17ffed7e4da7675255bbba8feb1c11584ea47549b3067ceb3b46e46990df143d"
},
"downloads": -1,
"filename": "WinDbg_Copilot-1.0.62-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b03fd31076111c2afd4540af0423417",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 101386,
"upload_time": "2023-08-10T04:57:48",
"upload_time_iso_8601": "2023-08-10T04:57:48.504030Z",
"url": "https://files.pythonhosted.org/packages/1a/bd/525ab0ba29d70c097980be69f464135e62060e577af1e70b8cb9fa12a504/WinDbg_Copilot-1.0.62-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a79b60ce6bbb77c41cabc203b3088809aa46ea7f5ea8fb939b42fb2e239e4d8",
"md5": "faa67a11966625aba25e39e86d839a63",
"sha256": "d92d6c0256a5f26a2d34e3e89cdc86eb7f088b74e54673406527d8c5f9b4d2ba"
},
"downloads": -1,
"filename": "WinDbg_Copilot-1.0.62.tar.gz",
"has_sig": false,
"md5_digest": "faa67a11966625aba25e39e86d839a63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 93281,
"upload_time": "2023-08-10T04:57:58",
"upload_time_iso_8601": "2023-08-10T04:57:58.511686Z",
"url": "https://files.pythonhosted.org/packages/7a/79/b60ce6bbb77c41cabc203b3088809aa46ea7f5ea8fb939b42fb2e239e4d8/WinDbg_Copilot-1.0.62.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-10 04:57:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "suannai231",
"github_project": "WinDbg_Copilot",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "windbg-copilot"
}
JSON
