Documentation/VS Code Extension

VS Code Extension

Capture ideas directly from your code editor

Overview

The IdeaLift VS Code extension helps developers capture ideas, track TODOs, and manage their GitHub backlog without leaving their editor. Turn code comments, selected text, and issues into actionable items with a single keyboard shortcut.

⌨️
Quick capture
📝
TODO scanning
🔍
CodeLens integration
📋
GitHub backlog

Getting Started

1Install the Extension

Search for "IdeaLift" in the VS Code Extensions marketplace, or click the button below.

Install from VS Code Marketplace

2Get Your API Key

You'll need an API key to connect the extension to your IdeaLift workspace.

  1. Log in to your IdeaLift Dashboard
  2. Go to Integrations page
  3. Click Generate API Key
  4. Copy the key to your clipboard
Go to Integrations

3Configure the Extension

In VS Code, open the Command Palette and run the configuration command:

Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux)

IdeaLift: Configure API Key

Paste your API key when prompted. The extension is now connected to your workspace!

Features

Quick Capture

Select any text in your editor and capture it as an idea with a single keyboard shortcut. The extension automatically includes the file path and line number as context.

Cmd+Shift+I
Mac
or
Ctrl+Shift+I
Windows/Linux

You can also right-click on selected text and choose "IdeaLift: Capture Idea" from the context menu.

🔍TODO Scanner

Scan your entire codebase for TODO comments and push them to IdeaLift. The scanner finds comments matching these patterns:

TODOFIXMEHACKIDEABUGXXX

Customize the patterns in your VS Code settings under idealift.todoPatterns.

💡CodeLens Integration

See inline "Push to IdeaLift" buttons above your TODO comments. Click the lens to instantly capture the comment as an idea without leaving your code.

Push to IdeaLift
// TODO: Implement user authentication

📊Sidebar Panel

Access IdeaLift directly from the VS Code activity bar. The sidebar includes three panels:

Ideas

View captured ideas from all sources

TODOs in Workspace

Scanned TODO comments from your codebase

GitHub Backlog

Prioritized issues from your connected repository

📋GitHub Backlog

View and prioritize your GitHub issues directly in VS Code. Issues are automatically analyzed and organized by:

Priority (1-5)

Based on labels, age, and content analysis

Effort (XS-XL)

Estimated implementation effort

Quick Wins

High-value, low-effort issues

Stale Issues

Issues that may need attention or closure

Commands

CommandShortcutDescription
IdeaLift: Capture IdeaCmd+Shift+I / Ctrl+Shift+ICapture selected text as an idea with file context
IdeaLift: Scan TODOs in Workspace-Find all TODO comments in your workspace
IdeaLift: Scan TODOs in Current File-Find TODO comments in the current file only
IdeaLift: Configure API Key-Set your IdeaLift API key
IdeaLift: Refresh Ideas-Reload ideas from your workspace
IdeaLift: Refresh Backlog-Reload GitHub issues from your repository
IdeaLift: Toggle Backlog View-Switch between grouped and priority views

Settings

SettingDefaultDescription
idealift.apiKey-Your IdeaLift API key (from Dashboard > Integrations)
idealift.todoPatterns["TODO", "FIXME", "HACK", ...]Comment patterns to scan for
idealift.excludePatterns["**/node_modules/**", ...]Glob patterns to exclude from scanning
idealift.autoScanfalseAutomatically scan for TODOs on file save

Open VS Code settings (Cmd+, or Ctrl+,) and search for "IdeaLift" to configure these options.

Best Practices

📝Use Consistent TODO Patterns

Standardize your team's comment patterns (TODO, FIXME, etc.) so the scanner catches all important notes. Add custom patterns to your settings if needed.

🔄Regular Backlog Reviews

Use the GitHub Backlog panel for your weekly planning. The priority and effort estimates help identify quick wins and plan sprints effectively.

📁Configure Exclude Patterns

Exclude large folders like node_modules,dist, and.git from scanning to improve performance.

Troubleshooting

"API key not configured" error

Run IdeaLift: Configure API Key from the Command Palette and paste your API key from the dashboard.

TODO scan is slow

Add large folders to your exclude patterns in settings. By default, node_modules,dist, and .git are excluded.

GitHub backlog not loading

Make sure you've connected a GitHub repository in your IdeaLift dashboard. The extension pulls issues from your connected repo.

Keyboard shortcut not working

Check for conflicts with other extensions. Go to Keyboard Shortcuts (Cmd+K Cmd+S) and search forCmd+Shift+I to see if another extension is using it.

Need Help?

Having issues or questions about the VS Code extension?