Faustus AI - VSCode Extension

A powerful VSCode extension that integrates AI capabilities into your development workflow, providing intelligent code assistance and chat functionality.

Features

• 🤖 AI-powered code assistance
• 💬 Interactive chat interface
• ⚙️ Configurable API endpoints
• 🔒 Secure API key storage
• 📝 Chat history management
• 🚀 Rate-limited API requests
• 💾 Response caching

Requirements

• Visual Studio Code ^1.60.0
• Node.js ^14.0.0
• An API key from your AI service provider

Installation

1. Install from VS Code Marketplace:

   • Open VS Code
   • Go to Extensions (Ctrl+Shift+X)
   • Search for "Faustus AI"
   • Click Install

2. Manual Installation:

   git clone https://github.com/yourusername/faustus-ai.git
   cd faustus-ai
   npm install
   npm run build
   

Configuration

1. Open VS Code settings (Ctrl+,)
2. Search for "Faustus AI"
3. Configure the following settings:
   • API Endpoint: Your AI service endpoint (must be HTTPS)
   • API Key: Your authentication key (format: sk-xxxxxxxxxx)

Or use the extension's settings UI:

1. Click the Faustus AI icon in the activity bar
2. Click the settings icon (⚙️)
3. Enter your API endpoint and key
4. Click Save

Usage

Chat Interface

1. Click the Faustus AI icon in the activity bar
2. Type your message in the input box
3. Press Enter or click Send
4. View AI responses in the chat history

Managing Chat History

• Click "Clear History" to remove all chat messages
• Chat history is automatically limited to the last 50 messages
• Messages are cached for improved performance

Rate Limiting

• Requests are automatically queued and rate-limited
• Maximum 10 requests in queue
• 1-second interval between requests

Security

• API keys are stored securely using VS Code's secret storage
• All API communication is encrypted and uses HTTPS
• Sensitive data is encrypted before storage
• No data is sent to third parties

Troubleshooting

Common issues and solutions:

1. "AI service not configured"

   • Ensure you've entered both API endpoint and key
   • Check that the endpoint starts with "https://"
   • Verify your API key format

2. "Network timeout"

   • Check your internet connection
   • Verify the API endpoint is accessible
   • Try again after a few seconds

3. "Too many pending requests"

   • Wait for current requests to complete
   • Try clearing the chat history
   • Restart VS Code if issues persist

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests: npm test
5. Submit a pull request

License

MIT License - see LICENSE file for details