OctoPulse

Your PRs, reviews, and issues — all in one place.

Features • Installation • Usage • Commands • Contributing

🚀 Why OctoPulse?

Tired of constantly switching between VS Code and GitHub? OctoPulse brings your entire GitHub workflow directly into your editor.

No more context switching. No more tab juggling. Just code.

✨ Features

📊 Unified Dashboard

All your GitHub work items in a single, organized view:

• PRs assigned to you for review (🟢 green)
• PRs you created (🔵 blue)
• Issues assigned to you (🟣 purple)

📁 Smart Grouping

Items are automatically grouped by repository, making it easy to focus on one project at a time.

🔍 Rich Detail View

Click any item to open a beautiful, GitHub-style detail view right inside VS Code:

• Full markdown rendering for descriptions and comments
• Timeline view with all comments
• Labels with proper colors
• PR diff stats (+additions, -deletions)
• Branch information for PRs
• GitHub Project custom fields (Status, Priority, Sprint, etc.)

🎨 Theme Aware

Looks great in both light and dark themes — automatically adapts to your VS Code theme.

🙈 Repository Filtering

Too many repos? Right-click any repository to exclude it from the dashboard. Easily restore hidden repos from the overflow menu.

⚡ Fast & Lightweight

• Fetches all items in parallel
• Pagination support for large result sets (up to 1000 items)
• Minimal memory footprint

📦 Installation

From VS Code Marketplace

1. Open VS Code
2. Press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (Mac)
3. Search for "OctoPulse"
4. Click Install

From Source

git clone https://github.com/yourusername/octopulse-extension.git
cd octopulse-extension
npm install
npm run compile

Then press F5 to launch the extension in a new VS Code window.

🎯 Usage

Getting Started

1. Open OctoPulse — Click the GitHub icon in the Activity Bar (left sidebar)
2. Sign in — Click "Sign in with GitHub" and authorize the extension
3. Explore — Your PRs and issues will appear, grouped by repository

Viewing Details

• Single-click any item to open it in a VS Code webview
• Right-click for more options:
  • Open in GitHub (external browser)
  • Copy URL
  • Open in VS Code (webview)

Managing Repositories

• Exclude a repo: Right-click on a repository name → "Exclude Repository"
• Restore repos: Click the ⋯ menu → "Manage Excluded Repositories"

🎮 Commands

🔐 Permissions

OctoPulse requests the following GitHub permissions:

Your access token is securely managed by VS Code's built-in authentication system.

🛠️ Development

Prerequisites

• Node.js 18+
• VS Code 1.107+

Setup

# Clone the repository
git clone https://github.com/yourusername/octopulse-extension.git
cd octopulse-extension

# Install dependencies
npm install

# Compile
npm run compile

# Watch mode (auto-compile on changes)
npm run watch

Running & Debugging

1. Open the project in VS Code
2. Press F5 to launch the Extension Development Host
3. The extension will be active in the new window

Project Structure

octopulse-extension/
├── src/
│   ├── extension.ts          # Extension entry point
│   ├── github.ts             # GitHub API service
│   ├── treeDataProvider.ts   # Dashboard tree view
│   ├── detailsWebview.ts     # PR/Issue detail webview
│   └── excludedReposStore.ts # Persistence for hidden repos
├── package.json              # Extension manifest
└── tsconfig.json             # TypeScript configuration

🤝 Contributing

Contributions are welcome! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Ideas for Contributions

• [ ] Notification badges for new items
• [ ] Keyboard shortcuts
• [ ] Custom filters (by label, milestone, etc.)
• [ ] GitHub Actions integration
• [ ] Code review comments in webview

📄 License

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

💖 Acknowledgments

• Built with VS Code Extension API
• Markdown rendering by marked
• Inspired by the GitHub workflow we all know and love

Made with ❤️ for developers who live in VS Code

Report Bug • Request Feature