Heizen Review Bot
AI-powered code review assistant that brings GitHub PR reviews directly into your VS Code workspace
Heizen Review Bot is a professional VS Code extension that seamlessly integrates heizen-ai bot PR review comments into your development workflow. Experience AI-powered code reviews with inline diagnostics, intelligent code lenses, contextual hover tooltips, and a comprehensive sidebar panel for efficient review management.
Features
Core Capabilities
- Inline Diagnostics — Review comments surface automatically in VS Code's Problems panel with severity levels and actionable insights
- Intelligent Code Lenses — Reply and resolve actions appear directly at comment locations for seamless interaction
- Rich Hover Tooltips — View complete comment threads with markdown formatting on hover
- Comprehensive Sidebar — Browse all open pull requests and review threads organized by file with visual status indicators
- Smart Navigation — One-click navigation to exact file locations or GitHub PR/comment URLs
- Auto-sync on Branch Switch — Intelligent detection and loading of reviews when switching between PR branches
- Real-time Status Tracking — Automatic synchronization of resolved/unresolved thread states with GitHub
Developer Experience
- Zero Configuration — Works out of the box with VS Code's built-in GitHub authentication
- Performance Optimized — Efficient GraphQL queries with minimal API calls
- Privacy Focused — All GitHub communication uses secure authentication tokens
- Workspace Aware — Automatically detects GitHub repositories and available pull requests
Getting Started
Quick Start
- Open the Heizen Review sidebar — Click the Heizen icon in the Activity Bar (left sidebar)
- Select a pull request — Click any PR from the list to load its review threads
- Navigate to comments — Click on any comment to jump directly to the relevant code location
- Interact with reviews — Use inline code lenses to reply or resolve comments without leaving your editor
Available Commands
Access these commands via the Command Palette (Cmd+Shift+P / Ctrl+Shift+P):
- Heizen: Load PR Review — Manually select and load a specific pull request's review threads
- Heizen: Refresh Review — Synchronize the current PR's review state with GitHub (fetches new comments and updates resolution status)
- Heizen: Refresh PR List — Update the list of available pull requests in the sidebar
Requirements
- VS Code version 1.85.0 or higher
- GitHub Repository — Your workspace must be a GitHub repository
- GitHub Authentication — One of the following:
- VS Code's built-in GitHub authentication (recommended)
- GitHub Personal Access Token with appropriate permissions
Authentication Setup
Option 1: VS Code GitHub Authentication (Recommended)
The extension automatically uses VS Code's built-in GitHub authentication. No additional configuration required.
Option 2: Personal Access Token
If VS Code GitHub authentication is unavailable, you can configure a Personal Access Token:
Creating a GitHub Token
- Go to GitHub Settings → Personal Access Tokens → Tokens (classic)
- Click Generate new token (classic)
- Configure the token:
- Note:
Heizen Review Bot - VS Code Extension
- Expiration: Choose your preferred expiration period
- Select scopes:
- ✅
repo — Full control of private repositories
- Required for reading PR data, review threads, and posting comments
- ✅
read:org — Read organization membership
- Required for accessing organization repositories
- Click Generate token
- Copy the token immediately (you won't be able to see it again)
Quick Setup Link
Create a pre-configured token with the required scopes.
Configuring the Token in VS Code
- Open VS Code Settings (
Cmd+, / Ctrl+,)
- Search for
heizen.githubToken
- Paste your token into the field
Alternatively, add it to your settings.json:
{
"heizen.githubToken": "ghp_your_token_here"
}
Security Note: Store your token securely. Consider using VS Code's Secret Storage or environment variables for sensitive tokens.
How It Works
Technical Overview
- Repository Detection — Automatically detects GitHub repository information from your workspace's git configuration
- GraphQL Integration — Queries GitHub's GraphQL API to fetch PR review threads with optimal performance
- Smart Filtering — Identifies and processes comments authored by the
heizen-ai bot
- Workspace Mapping — Maps GitHub file paths to your local workspace files with intelligent path resolution
- Visual Feedback — Applies diagnostics, decorations, and code lenses to unresolved comments
- State Management — Maintains synchronization with GitHub's resolution state through efficient refresh mechanisms
Privacy & Security
- All communication with GitHub uses authenticated API requests
- No data is stored externally or transmitted to third-party services
- Tokens are stored securely using VS Code's configuration system
- The extension only accesses repositories you have permission to view
Troubleshooting
Common Issues
Extension not loading reviews
- Ensure you're authenticated with GitHub
- Verify the repository has open pull requests
- Check that the
heizen-ai bot has commented on the PR
Comments not appearing inline
- Ensure files are saved and match the PR's branch
- Try refreshing the review using the refresh button in the sidebar
- Verify file paths haven't changed since the review
Authentication errors
- Confirm your Personal Access Token has the required
repo and read:org scopes
- Check token expiration date
- Try re-authenticating with VS Code's GitHub extension
Support
For support, feature requests, or bug reports, please contact the development team through your organization's internal support channels.
License
MIT
