LazyGit for VSCode

Native integration of LazyGit directly in a VSCode window (not an integrated terminal)

https://github.com/tom-pollak/lazygit-vscode/assets/26611948/5924db82-7937-4ed9-96ad-07963af4b56e

Features

• Toggle LazyGit in the full-screen editor within VSCode
• Use a keyboard shortcut to quickly open or close LazyGit
• Use e or o to open a file in a new tab from the lazygit window

VSCode integration

File opening works out of the box -- pressing e in lazygit opens files directly in VSCode. No manual lazygit config is needed.

Under the hood, the extension automatically configures lazygit's edit commands via an overlay config, using IPC to open files through the VSCode API instead of the code CLI.

To disable this and fall back to the code CLI approach, set lazygit-vscode.nativeFileOpening to false and configure your lazygit config manually:

os:
  editPreset: "vscode"
promptToReturnFromSubprocess: false

You can use lazygit-vscode.configPath to set a separate lazygit config for VSCode if you prefer different behaviour between VSCode and CLI.

Known Issues

Sidebar show/hide inconsistencies

VSCode doesn't offer an API for checking sidebar visibility (issue), so autoMaximizeWindow and lazygit-vscode.panels settings may cause inconsistencies:

• keep with autoMaximizeWindow will always reopen the sidebar, even if it was already hidden
• hideRestore will always restore the sidebar on close, even if it was already hidden
• secondarySidebar defaults to "hide", so it will always be hidden when toggling lazygit

For perfect consistency where no sidepanel is touched, use autoMaximizeWindow: false and set all panels to "keep".

Created VSCode issue to track: https://github.com/microsoft/vscode/issues/283331

Python virtualenv

Python virtualenv interference: If python.terminal.activateEnvironment is true in the settings, this extension will delay the launch of LazyGit by a fixed time, allowing vscode to start the python virtualenv. The delay is configurable via lazygit-vscode.venvActivationDelay (default: 100ms). If you still experience issues, you can:

1. Increase the delay setting if your environment takes longer to activate
2. Disable automatic Python activation in terminals:

"python.terminal.activateEnvironment": false

Integrated shell keybindings

Default cmd is ctrl+shift+l which may be captured by the shell. Ensure the following config

  "terminal.integrated.sendKeybindingsToShell": false, // ensure this is false
  "terminal.integrated.commandsToSkipShell": ["lazygit-vscode.toggle", "workbench.action.closeWindow"], // add this

Requirements

• LazyGit must be installed on your system and accessible in your PATH (or set with lazygit-vscode.lazygitPath). You can find installation instructions for LazyGit here.

Usage

Use the keyboard shortcut Ctrl+Shift+L (or Cmd+Shift+L on macOS) to toggle LazyGit

• lazygit-vscode.toggle: Toggle LazyGit
• lazygitFocus: When clause for your keybindings.

Extension Settings

Basic Configuration

• lazygit-vscode.nativeFileOpening: Automatically handle file opening from lazygit via IPC (default: true). When enabled, pressing e opens files directly in VSCode without needing code on PATH or editPreset: "vscode" in your lazygit config. Set to false to fall back to the code CLI approach.
• lazygit-vscode.lazygitPath: Manually set LazyGit path. Otherwise use default system PATH.
• lazygit-vscode.configPath: Set custom LazyGit config. Useful if you like different behaviour between VSCode and CLI.
• lazygit-vscode.autoMaximizeWindow: Maximize the lazygit window in the editor (keeps sidebar visible). Useful when working with split editors.
• lazygit-vscode.venvActivationDelay: Delay in milliseconds to wait for Python virtual environment activation before launching lazygit (default: 200). Increase this value if your Python environment takes longer to activate.

Panel Behavior

You can control how LazyGit interacts with VS Code UI panels using the panels setting. Each panel can be set to:

• "keep": Leave panel as is (default)
• "hide": Hide the panel when showing LazyGit
• "hideRestore": Hide the panel when showing LazyGit and restore it when closing

Example configuration:

"lazygit-vscode.panels": {
  "sidebar": "hideRestore",
  "panel": "hide",
  "secondarySidebar": "keep"
}

Available Panels

• lazygit-vscode.panels.sidebar: Primary sidebar (Explorer, Source Control, etc.)
• lazygit-vscode.panels.panel: Bottom panel (Terminal, Output, etc.)
• lazygit-vscode.panels.secondarySidebar: Secondary sidebar (usually on the right side)

Note: Legacy settings autoHideSideBar and autoHidePanel are still supported but deprecated.

For settings to be applied, LazyGit window must be restarted (q).

More info

LazyGit