PimAI - AI Powered Code Assistant

PimAI is a Visual Studio Code extension that provides AI-powered code assistance. It uses the Groq AI model to analyze, optimize, test, and document your code.

Features

1. Code Chat (Alt+A)

• Interactive chat with AI about the selected code snippet
• Code correction and improvement suggestions
• Instant code updates

2. Code Explanation (Alt+S)

• Detailed explanation of the selected code
• Beautifully formatted documentation in Markdown
• Syntax highlighting support

3. Code Formatting (Alt+F)

• Code formatting according to best practices
• Consistent style and layout
• Improved readability

4. Code Optimization (Alt+O)

• Performance improvements
• Time and memory complexity optimizations
• Resource usage optimizations

5. Test Generation (Alt+T)

• Automatic unit test generation
• Comprehensive test scenarios
• Tests for edge cases and error scenarios

6. Documentation Generation (Alt+D)

• Automatic documentation in JSDoc/docstring format
• Function descriptions and parameters
• Usage examples

7. Security Analysis (Alt+C)

• Code security scan
• Detection of common vulnerabilities
• Improvement suggestions

Installation

1. Open Visual Studio Code
2. Go to the Extensions tab (Ctrl+Shift+X)
3. Search for "PimAI"
4. Click the "Install" button

Configuration

1. You will need to enter your Groq API key on the first use of the extension
2. To change the API key:
   • Restart VSCode or
   • Delete the pimai.secretKey value in the settings

Usage

1. Select the code you want to analyze
2. Use one of the following shortcut keys:
   • Alt+A: Code Chat
   • Alt+S: Code Explanation
   • Alt+F: Code Formatting
   • Alt+O: Code Optimization
   • Alt+T: Test Generation
   • Alt+D: Documentation Generation
   • Alt+C: Security Analysis

Requirements

• Groq API key
• Node.js and pnpm

Development

git clone https://github.com/Pimatis/pimai.git

pnpm install

pnpm run watch

License

This project is licensed under the MIT license.

Contributing

1. Fork this repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'feat: add amazing feature')
4. Push your branch (git push origin feature/amazing-feature)
5. Create a Pull Request

---

Created by Pimatis Labs