Introduction to SolidGPT
SolidGPT is an innovative AI searching assistant specifically designed to aid developers in conducting semantic searches within their codebases and workspaces. It serves as a powerful tool enabling programmers to interact naturally with their projects and retrieve the information they need efficiently.
What is SolidGPT?
SolidGPT acts as a virtual assistant integrated into development environments, especially within VSCode, to enhance productivity by simplifying searches and providing precise answers related to code. With its integration, developers can enjoy a seamless transition from thoughts to implementation without unnecessary disruptions.
Getting Started with SolidGPT VSCode Extension
The SolidGPT extension is available on the VSCode Marketplace. To begin, developers can install the extension with a few clicks. This ease of installation lets programmers jump straight into using SolidGPT, leveraging its full potential to streamline their coding workflows.
Building SolidGPT from Source
For those interested in delving deeper or requiring modifications, there is an option to build SolidGPT from its source code:
- Clone the latest version from GitHub.
- Install the necessary dependencies using the
requirements.txtfile. - Launch the server and web application using command line instructions provided in the documentation.
Onboarding Your Codebase and Notion
SolidGPT allows users to onboard their codebase and optionally integrate with Notion:
Setting Up the Codebase
- Obtain an OpenAI API key and specify the directory of the codebase to be onboarded. Note that it is optimal to keep the file count under 100, with a maximum support of 500 files.
Setting Up Notion (Optional)
- Configuration involves setting up the Notion API with the necessary authentication and permissions. This feature allows SolidGPT to perform semantic searches and provide summaries of project documentation and boards within Notion.
Use Cases for SolidGPT
SolidGPT offers several practical applications:
- Efficient Codebase Exploration: Quickly pinpoint locations for changes or identify the right methods to invoke.
- Rapid Query Resolution: Pose questions to the codebase and receive prompt answers, cutting down troubleshooting time.
- Notion Integration: Execute semantic searches in Notion, creating a cohesive understanding of documentation and project timelines.
- Comprehensive Query Handling: Eliminate context-switching by providing answers drawn from both codebases and Notion.
Known Issues
- Users with Intel chips on Mac might encounter permission issues. The recommended fix involves granting full access via the terminal.
Feedback and Support
The SolidGPT team values user feedback greatly. Users can provide suggestions or report issues via email or GitHub issues, ensuring continuous improvement and prompt customer support.
Data Safety and Compliance
SolidGPT takes data privacy seriously, ensuring no collection of personal data. Usage indicates agreement to OpenAI’s terms of service, reflecting SolidGPT’s commitment to user transparency and ethical AI usage.
In conclusion, SolidGPT stands as a robust tool for developers looking to enhance their coding efficiency and engage more intuitively with their projects. The seamless integration and comprehensive feature set make it an invaluable assistant in any developer's toolkit.