VS Code Integration

Overview

Forge integrates with Visual Studio Code through automatic terminal detection and extension installation. When running Forge in VS Code’s integrated terminal, it can detect the environment and offer to install the official Forge extension for enhanced functionality.

Features

Automatic VS Code terminal detection
One-click extension installation
Seamless terminal integration
Access to Forge commands within VS Code
Integrated AI assistance in your workflow

Extension Installation

Automatic Installation

Forge automatically detects when running in VS Code and offers to install the extension:

Open VS Code Terminal

Open the integrated terminal in VS Code:

Press Ctrl + ` (Windows/Linux)
Press Cmd + ` (macOS)
Or: View → Terminal

Run Forge

Run any Forge command:

forge

If the extension isn’t installed, Forge will prompt you to install it.

Accept Installation

When prompted, accept the installation:

Forge VS Code extension not detected. Install it? (y/n)

Type y and press Enter.

Automatic Installation

Forge will automatically run:

code --install-extension ForgeCode.forge-vscode --force

The extension will be installed in the background.

Reload VS Code

After installation completes, reload VS Code:

Press Ctrl + Shift + P (Windows/Linux)
Press Cmd + Shift + P (macOS)
Type: “Developer: Reload Window”
Press Enter

Manual Installation

Via Command Line

Install directly using the code command:

code --install-extension ForgeCode.forge-vscode

Via VS Code Extensions

Open VS Code
Click the Extensions icon in the sidebar (or press Ctrl/Cmd + Shift + X)
Search for “Forge”
Click “Install” on the ForgeCode.forge-vscode extension

Via VS Code Marketplace

Visit the VS Code Marketplace and click “Install”.

Detection Mechanism

Forge detects VS Code by checking for environment variables that are automatically set in VS Code’s integrated terminal.

Environment Variables Checked

From crates/forge_main/src/vscode.rs:9:

pub fn is_vscode_terminal() -> bool {
    std::env::var("TERM_PROGRAM")
        .map(|val| val == "vscode")
        .unwrap_or(false)
    || std::env::var("VSCODE_PID").is_ok()
    || std::env::var("VSCODE_GIT_ASKPASS_NODE").is_ok()
    || std::env::var("VSCODE_GIT_IPC_HANDLE").is_ok()
}

Forge checks for:

TERM_PROGRAM=vscode - Primary VS Code terminal identifier
VSCODE_PID - VS Code process ID
VSCODE_GIT_ASKPASS_NODE - VS Code Git integration
VSCODE_GIT_IPC_HANDLE - VS Code IPC handle

Extension Detection

From crates/forge_main/src/vscode.rs:22:

pub fn is_extension_installed() -> bool {
    if let Ok(output) = Command::new("code").arg("--list-extensions").output()
        && output.status.success()
        && let Ok(extensions) = String::from_utf8(output.stdout)
    {
        return extensions
            .lines()
            .any(|line| line.trim() == "ForgeCode.forge-vscode");
    }
    false
}

This checks if ForgeCode.forge-vscode appears in the installed extensions list.

Extension Features

The Forge VS Code extension provides:

Integrated terminal commands
Syntax highlighting for Forge conversations
Code action suggestions
Quick fixes powered by AI
Inline AI assistance
Context-aware completions

Configuration

Disable Auto-Install Prompt

If you don’t want Forge to prompt for extension installation:

# Set environment variable
export FORGE_SKIP_VSCODE_PROMPT="1"

Or add to your shell configuration:

~/.zshrc or ~/.bashrc

# Disable Forge VS Code extension prompt
export FORGE_SKIP_VSCODE_PROMPT="1"

Extension Settings

Configure the extension in VS Code settings:

settings.json

{
  "forge.autoStart": true,
  "forge.binaryPath": "/usr/local/bin/forge",
  "forge.enableCodeActions": true,
  "forge.enableInlineAssistance": true
}

Using Forge in VS Code

Terminal Integration

Once the extension is installed, use Forge commands directly in the integrated terminal:

# Start a conversation
forge

# Or use ZSH plugin syntax (if configured)
: Review this file @[src/main.rs]

Command Palette

Access Forge commands via Command Palette:

Press Ctrl/Cmd + Shift + P
Type “Forge”
Select from available commands:
- Forge: Start Conversation
- Forge: Review Current File
- Forge: Generate Tests
- Forge: Explain Code
- Forge: Fix Issues

Keyboard Shortcuts

Default keybindings (customizable):

Command	Windows/Linux	macOS
Start Conversation	`Ctrl` + `Shift` + `F`	`Cmd` + `Shift` + `F`
Review Current File	`Ctrl` + `Shift` + `R`	`Cmd` + `Shift` + `R`
Explain Selection	`Ctrl` + `Shift` + `E`	`Cmd` + `Shift` + `E`

Troubleshooting

Extension not detected

Verify the extension is installed:

code --list-extensions | grep ForgeCode.forge-vscode

If not listed, install manually:

code --install-extension ForgeCode.forge-vscode

Auto-install fails

Check if the code command is in PATH:

which code

If not found, add VS Code to PATH:macOS:

Open VS Code
Press Cmd + Shift + P
Type: “Shell Command: Install ‘code’ command in PATH”
Press Enter

Windows: The code command is usually added automatically during installation.Linux:

export PATH="$PATH:/usr/share/code/bin"

VS Code not detected

Forge may not detect VS Code if environment variables aren’t set. Verify:

# In VS Code integrated terminal
echo $TERM_PROGRAM
# Should output: vscode

echo $VSCODE_PID
# Should output a process ID

If these are empty, you may be using a non-standard terminal or VS Code fork.

Extension not working after install

Reload VS Code window:
- Ctrl/Cmd + Shift + P
- Type: “Developer: Reload Window”
Check extension is activated:
- View → Extensions
- Search for “Forge”
- Verify it shows “Enabled”
Check extension logs:
- View → Output
- Select “Forge” from dropdown

Implementation Details

Extension Installation Function

From crates/forge_main/src/vscode.rs:39:

pub fn install_extension() -> Result<bool, std::io::Error> {
    let output = Command::new("code")
        .arg("--install-extension")
        .arg("ForgeCode.forge-vscode")
        .arg("--force")
        .output()?;

    Ok(output.status.success())
}

This function:

Runs code --install-extension ForgeCode.forge-vscode --force
Returns Ok(true) if installation succeeds
Returns Ok(false) if installation fails
Returns Err if the command can’t be executed

Installation Check

From crates/forge_main/src/vscode.rs:54:

pub fn should_install_extension() -> bool {
    is_vscode_terminal() && !is_extension_installed()
}

This determines when to prompt for installation:

Only when running in VS Code terminal
Only when extension is not already installed

Next Steps

ZSH Plugin

Use Forge with enhanced ZSH integration

GitHub Actions

Integrate Forge in CI/CD

Configuration

Configure Forge settings

Quickstart

Get started with Forge

Shell Integration

Editor Integration

CI/CD

VS Code Integration

Overview

Features

Extension Installation

Automatic Installation

Manual Installation

Detection Mechanism

Environment Variables Checked

Extension Detection

Extension Features

Configuration

Disable Auto-Install Prompt

Extension Settings

Using Forge in VS Code

Terminal Integration

Command Palette

Keyboard Shortcuts

Troubleshooting

Implementation Details

Extension Installation Function

Installation Check

Next Steps

ZSH Plugin

GitHub Actions

Configuration

Quickstart

Build docs developers (and LLMs) love

Shell Integration

Editor Integration

CI/CD

​Overview

​Features

​Extension Installation

​Automatic Installation

​Manual Installation

​Detection Mechanism

​Environment Variables Checked

​Extension Detection

​Extension Features

​Configuration

​Disable Auto-Install Prompt

​Extension Settings

​Using Forge in VS Code

​Terminal Integration

​Command Palette

​Keyboard Shortcuts

​Troubleshooting

​Implementation Details

​Extension Installation Function

​Installation Check

​Next Steps

ZSH Plugin

GitHub Actions

Configuration

Quickstart

Build docs developers (and LLMs) love

Overview

Features

Extension Installation

Automatic Installation

Manual Installation

Detection Mechanism

Environment Variables Checked

Extension Detection

Extension Features

Configuration

Disable Auto-Install Prompt

Extension Settings

Using Forge in VS Code

Terminal Integration

Command Palette

Keyboard Shortcuts

Troubleshooting

Implementation Details

Extension Installation Function

Installation Check

Next Steps