https://github.com/cofficlab/codebuddy
https://github.com/cofficlab/codebuddy
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cofficlab/codebuddy
- Owner: CofficLab
- Created: 2025-03-20T02:45:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T08:22:32.000Z (over 1 year ago)
- Last Synced: 2025-03-20T08:31:30.708Z (over 1 year ago)
- Language: TypeScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Smart Code Buddy
An AI-powered VS Code extension that provides intelligent coding assistance using various AI providers.
## 🚀 How to use
### Install dependencies
```bash
yarn
```
For running project in development mode use
```bash
yarn watch
```
### Configuration
1. Open VS Code settings
2. Configure your preferred AI provider (OpenAI, Anthropic, or Deepseek)
3. Add the corresponding API key for your chosen provider
### Using the Extension
1. Open the command palette (Ctrl/Cmd + Shift + P)
2. Type and select "Open AI Chat Assistant"
3. Start interacting with your AI coding assistant!
### Adding more commands
To add more commands to your extension, edit the `package.json` located in the `/packages/extension` directory, and use the keys in your `extension.ts` file using `vscode.commands.registerCommand` method.
## 🔧 How it works
The project is built with monorepo structure containing two packages. The first one being the client, and the second being the visual studio code extension program.
when you start developing on the `/packages/client/` vue application directory, your changes will be watched using nodemon, then rebuilt and be opened inside vscode extension host ready to be used with vscode command pallet!
Here you can see your vue project already built and injected using vscode webview API. you can utilize the full functionality of vue such as its amazing reactivity and its available additions (like `vue-router`) out of the box!
Inside the vue application code, the `vscode` object is globally accessible and can be used to send messages to the vscode runtime and perform tasks such as read/writing files, etc.
## 🤖 Supported AI Providers
- OpenAI
- Anthropic
- Deepseek
## 📄 Technical Reference
[Developing a VS Code Extension using Vue 3 and WebView Panels API](https://medium.com/@mhdi_kr/developing-a-vs-code-extension-using-vue-3-and-webview-panels-api-536d87ce653a)
## 🔗 Links
- [GitHub](https://github.com/cofficlab/CodeBuddy)
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=coffic.smart-buddy)
## 🤝 Contribution
If you have any questions or recommendations please create a new issue for it, and if you've hacked together any feature or enhancement, a pull request is more than welcome here! 🙏
## 📝 License
This project is licensed under the MIT License.