Organize your project knowledge and supercharge your AI assistants
Features β’ Installation β’ Quick Start β’ Documentation β’ Contributing
useVibe is a powerful VS Code extension that helps you organize project-specific knowledge and seamlessly integrate it with AI assistants like GitHub Copilot, Cursor AI, and other LLM-powered tools.
AI assistants are powerful, but they often:
- π€·ββοΈ Lack context about your specific project architecture
- π Forget important patterns and conventions between sessions
- π Can't access your documentation, design decisions, or API specs
- π― Give generic answers instead of project-specific solutions
useVibe creates organized context projects that:
- β
Keep project knowledge in dedicated folders (
.contexts/) - β Feed relevant context to your AI assistants automatically
- β Sync with external repositories (docs, SDKs, examples)
- β Track changes and keep documentation up-to-date
- β
Work seamlessly with GitHub Copilot Chat via
@usevibeparticipant
Create dedicated knowledge spaces for different aspects of your project:
- Architecture docs - Design decisions and patterns
- API documentation - Endpoint references and examples
- Code templates - Reusable boilerplate and snippets
- External libraries - Clone repos for reference
- Onboarding materials - New developer resources
Use the @usevibe chat participant in VS Code:
@usevibe status # Overview of all projects
@usevibe tasks # Show all TODO items
@usevibe plan # Get AI work plan for today
@usevibe news # Recent changes across projects
@usevibe sync all # Update all Git repos
@usevibe @api-docs [query] # Query specific project
Access features via Command Palette (Cmd+Shift+P):
- Show Project Status - Dashboard of all projects
- Show All TODO Tasks - Scan projects for pending work
- Show Recent Changes - Git commit history
- Sync All Projects - Pull latest updates
- Clone repositories as context projects
- Track changes automatically with visual indicators
- Auto-sync with configurable intervals
- Change analysis with commit summaries
- Update notifications when new commits are available
Import and manage various file types:
- β
Markdown (
.md) - β
Code files (
.ts,.js,.py,.java, etc.) - β PDF documents
- β
Word documents (
.docx) - β
Text files (
.txt)
- Sidebar view with tree structure
- Enable/disable projects with one click
- Visual indicators for Git changes
- Quick actions via context menus
- Status bar integration for auto-sync
- Open VS Code
- Go to Extensions (
Cmd+Shift+X/Ctrl+Shift+X) - Search for "useVibe"
- Click Install
# Download the latest release
# Then install:
code --install-extension useVibe-vscode-1.0.0.vsix
# For Cursor IDE:
cursor --install-extension useVibe-vscode-1.0.0.vsixgit clone https://github.com/useVibe/useVibe-vscode.git
cd useVibe-vscode
npm install
npm run compile
vsce package
code --install-extension useVibe-vscode-1.0.0.vsixOpen the useVibe view in the sidebar (Activity Bar icon) and click "Create New Project".
Right-click on your project:
- Add Current File - Add the file you're currently editing
- Import Files - Browse and select multiple files
- Create Note - Add markdown documentation
Click "Clone from GitHub" to add external documentation or libraries as reference:
https://github.com/facebook/react
https://github.com/typescript-cheatsheets/react
@usevibe @api-docs how do I authenticate users?
- Press
Cmd+Shift+P - Type "useVibe: Show Project Status"
your-workspace/
βββ .contexts/ # useVibe folder
β βββ api-docs/ # API documentation project
β β βββ endpoints.md
β β βββ examples.md
β βββ architecture/ # Architecture decisions
β β βββ design-patterns.md
β βββ react-docs/ # Cloned from GitHub
β β βββ [repo contents]
β βββ .ai-rules # AI instruction files
βββ src/
βββ ...
Configure useVibe in your VS Code settings:
{
// Folder name for context projects
"useVibe.contextsFolderName": ".contexts",
// Show welcome message
"useVibe.showWelcomeMessage": true,
// Auto-sync settings
"useVibe.autoSync.enabled": true,
"useVibe.autoSync.intervalMinutes": 60,
"useVibe.autoSync.notifyOnChanges": true
}| Command | Description |
|---|---|
useVibe: Create New Project |
Create a new context project |
useVibe: Clone from GitHub |
Clone a repository as a context project |
useVibe: Show Project Status |
View dashboard of all projects |
useVibe: Show All TODO Tasks |
Scan for TODO/FIXME comments |
useVibe: Show Recent Changes |
View Git commit history |
useVibe: Sync All Projects |
Update all Git repositories |
useVibe: Enable/Disable Project |
Toggle project visibility to AI |
| Command | Description |
|---|---|
@usevibe status |
Show comprehensive project status |
@usevibe tasks |
Display all TODO items |
@usevibe plan |
Get AI-suggested work plan |
@usevibe news |
Show recent changes |
@usevibe sync all |
Update all repos with summaries |
@usevibe @name [query] |
Query specific project |
Keep design decisions and patterns organized:
.contexts/architecture/
βββ design-decisions.md
βββ coding-standards.md
βββ api-design.md
When Copilot suggests code, it references your architecture docs for consistent patterns.
Clone official documentation:
@usevibe clone https://github.com/openai/openai-python
Now ask: @usevibe @openai-python how do I stream responses?
Create an onboarding project:
.contexts/onboarding/
βββ getting-started.md
βββ development-setup.md
βββ common-pitfalls.md
Organize contexts for microservices:
.contexts/
βββ backend-api/
βββ frontend-react/
βββ mobile-app/
βββ shared-types/
We welcome contributions! Please see our Contributing Guide for details.
- Fork the repository
- Create a feature branch:
git checkout -b feature/amazing-feature - Make your changes and add tests
- Commit:
git commit -m 'Add amazing feature' - Push:
git push origin feature/amazing-feature - Open a Pull Request
# Clone the repo
git clone https://github.com/useVibe/useVibe-vscode.git
cd useVibe-vscode
# Install dependencies
npm install
# Compile TypeScript
npm run compile
# Watch mode for development
npm run watch
# Run in debug mode
# Press F5 in VS Code to open Extension Development Hostnpm testFound a bug or have an idea? Open an issue!
- β Search existing issues to avoid duplicates
- β Include VS Code version and OS
- β Provide clear reproduction steps
- β Include relevant screenshots/logs
This project is licensed under the MIT License - see the LICENSE file for details.
If useVibe helps your development workflow:
- β Star this repository on GitHub
- π’ Share with your team and community
- π Report bugs and suggest features
- π» Contribute code or documentation
- β Sponsor the project (coming soon!)
Made with β€οΈ by the useVibe Community