Skip to content

withvibe/usevibe

useVibe for VS Code

useVibe Logo

Organize your project knowledge and supercharge your AI assistants

VS Code Marketplace Installs Rating License: MIT GitHub issues

Features β€’ Installation β€’ Quick Start β€’ Documentation β€’ Contributing


🎯 What is useVibe?

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.

The Problem

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

The Solution

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 @usevibe participant

✨ Features

πŸ“ Organized Context Projects

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

πŸ€– AI Assistant Integration

GitHub Copilot Chat Participant

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

Command Palette (Cursor & VS Code)

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

πŸ”„ Git Integration

  • 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

πŸ“ Rich File Support

Import and manage various file types:

  • βœ… Markdown (.md)
  • βœ… Code files (.ts, .js, .py, .java, etc.)
  • βœ… PDF documents
  • βœ… Word documents (.docx)
  • βœ… Text files (.txt)

🎨 Professional UI

  • 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

πŸ“¦ Installation

From VS Code Marketplace

  1. Open VS Code
  2. Go to Extensions (Cmd+Shift+X / Ctrl+Shift+X)
  3. Search for "useVibe"
  4. Click Install

From VSIX File

# 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.vsix

From Source

git 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.vsix

πŸš€ Quick Start

1. Create Your First Context Project

Open the useVibe view in the sidebar (Activity Bar icon) and click "Create New Project".

2. Add Files

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

3. Clone External Repos

Click "Clone from GitHub" to add external documentation or libraries as reference:

https://github.com/facebook/react
https://github.com/typescript-cheatsheets/react

4. Use with AI Assistants

In VS Code with GitHub Copilot:

@usevibe @api-docs how do I authenticate users?

In Cursor or via Command Palette:

  • Press Cmd+Shift+P
  • Type "useVibe: Show Project Status"

πŸ“– Documentation

Context Projects Structure

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/
└── ...

Configuration

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
}

Available Commands

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

Chat Participant Commands (VS Code + Copilot)

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

🎬 Use Cases

1. Architecture Documentation

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.

2. API Reference Library

Clone official documentation:

@usevibe clone https://github.com/openai/openai-python

Now ask: @usevibe @openai-python how do I stream responses?

3. Onboarding New Team Members

Create an onboarding project:

.contexts/onboarding/
β”œβ”€β”€ getting-started.md
β”œβ”€β”€ development-setup.md
└── common-pitfalls.md

4. Multi-Project Workspace

Organize contexts for microservices:

.contexts/
β”œβ”€β”€ backend-api/
β”œβ”€β”€ frontend-react/
β”œβ”€β”€ mobile-app/
└── shared-types/

🀝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Contribution Guide

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/amazing-feature
  3. Make your changes and add tests
  4. Commit: git commit -m 'Add amazing feature'
  5. Push: git push origin feature/amazing-feature
  6. Open a Pull Request

Development Setup

# 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 Host

Running Tests

npm test

πŸ› Bug Reports & Feature Requests

Found a bug or have an idea? Open an issue!

Before Opening an Issue

  • βœ… Search existing issues to avoid duplicates
  • βœ… Include VS Code version and OS
  • βœ… Provide clear reproduction steps
  • βœ… Include relevant screenshots/logs

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.


🌟 Support the Project

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!)

πŸ”— Links


πŸ“Š Stats

GitHub stars GitHub forks GitHub watchers


Made with ❀️ by the useVibe Community

⬆ Back to Top

About

withvibe vscode extension

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages