Development

[andreashappe]

This pull request introduces several enhancements and updates to the project, including configuration improvements, code refactoring, feature additions, and dependency updates. The changes aim to improve usability, maintainability, and functionality of the project. Below is a summary of the most important changes:

The big one is the addition of the new rag usecase which enhances the existing linux priv-esc usecase.

Configuration Enhancements:

• Added detailed comments and new parameters in .env.example for configuring SSH authentication and RAG-based settings.
• Introduced .env.example.aws for AWS-specific configurations, including SSH key-based authentication and OpenAI API settings.

Feature Additions:

• Added a web-based Viewer and Replayer for better visualization and replay of agent runs, including instructions for usage and configuration in the README.md. [1][2]
• Introduced beta features for logging and visualization, such as the Viewer tool, with guidance on enabling remote logging.

Code Refactoring:

• Refactored the Capability class in src/hackingBuddyGPT/capabilities/capability.py to improve type annotations, enhance function calling support, and simplify code structure. [1][2][3][4]
• Updated the MinimalLinuxPrivesc class to improve token handling and logging in perform_round method.

Dependency and Build Updates:

• Updated dependencies in pyproject.toml to include libraries like fastapi, uvicorn, and langchain, and added optional dependencies for development and RAG use cases. [1][2]
• Updated versioning and authorship information in pyproject.toml, and added instructions for publishing to PyPI in publish_notes.md. [1][2]

Documentation Improvements:

• Enhanced README.md with detailed instructions for setup, use cases, and new features, including AWS-specific configurations and beta tools. [1][2][3]

[Copilot]

Pull Request Overview

This pull request introduces several enhancements and updates to improve usability, maintainability, and functionality. Key changes include adding a web-based Viewer/Replayer, refactoring the capability classes (with updated type annotations and function calling support), and updating dependency configurations and documentation.

Reviewed Changes

Copilot reviewed 109 out of 111 changed files in this pull request and generated 1 comment.

File	Description
src/hackingBuddyGPT/resources/webui/static/client.js	Adds new client-side JS for interactive websocket-based logging and run tracking (includes a typo in property assignment).
src/hackingBuddyGPT/cli/wintermute.py	Refactors CLI argument parsing with new configurable command mapping.
src/hackingBuddyGPT/capabilities/*	Refactors several capability modules and adjusts exception handling and logging practices.
pyproject.toml, publish_notes.md, README.md	Updates dependency versions, project metadata, and detailed usage instructions.

Files not reviewed (2)

• .env.example: Language not supported
• .env.example.aws: Language not supported

Comments suppressed due to low confidence (1)

src/hackingBuddyGPT/capabilities/psexec_test_credential.py:11

• The warnings.warn call is used in the call method, but there is no import for the warnings module. Please add 'import warnings' at the top of the file to prevent runtime errors.

class PSExecTestCredential(Capability):