https://github.com/chaitanya-shahare/lazygit-for-vscode
This is a vscode extension that gives a function and a key bind to open lazygit in a terminal in the main editor pane of VSCode
https://github.com/chaitanya-shahare/lazygit-for-vscode
typescript vscode-extension
Last synced: 2 months ago
JSON representation
This is a vscode extension that gives a function and a key bind to open lazygit in a terminal in the main editor pane of VSCode
- Host: GitHub
- URL: https://github.com/chaitanya-shahare/lazygit-for-vscode
- Owner: Chaitanya-Shahare
- License: mit
- Created: 2023-07-22T07:46:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-16T13:54:00.000Z (5 months ago)
- Last Synced: 2025-04-09T07:37:00.033Z (3 months ago)
- Topics: typescript, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=ChaitanyaShahare.lazygit
- Size: 153 KB
- Stars: 26
- Watchers: 1
- Forks: 13
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Lazygit for VSCode README
This is an extension that allows you to open lazygit in your VSCode instace without a bunch of steps.
Lazygit is a TUI (Terminal User Interface) git client.
## Features
- `cmd+g g` or `ctrl+g g` for opening lazygit
- You can also server for lazygit in the command pallet (`cmd + shift + p` -> lazygit)
- users can add a custom keybind to the function `lazygit.openLazygit`.
## Requirements
- Lazygit must be installed on your system.
- for lazygit installation refer -> https://github.com/jesseduffield/lazygit
## Configuration
Set the following in your [LazyGit config](https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md) for VSCode support:
- Linux: `~/.config/lazygit/config.yml`
- MacOS: `~/Library/Application\ Support/lazygit/config.yml`
- Windows: `%LOCALAPPDATA%\lazygit\config.yml` (default location, but it will also be found in `%APPDATA%\lazygit\config.yml`
```yaml
os:
editPreset: "vscode"
```
This allows a pretty slick experience opening windows & files on specific changes with `e` and `o` in LazyGit.
## Known Issues
- No known issues, you can open issues here -> https://github.com/Chaitanya-Shahare/lazygit-for-vscode/issues
- Your contributions in the issues would be appreciated
## Release Notes
- If lazygit is already open, the focus is returned to the terminal, instead of opening a new instance of lazygit.
- Fixed issue: when lazygit is opened, if any other terminals are active, terminal panel is not opened.
### 1.0.0
Initial release of lazygit for VSCode
### 1.0.1
### 1.0.2
### 1.0.3
### 1.0.4
- After quiting lazygit, the terminal is exited and the focus is returned to the editor
### 1.0.5
- If lazygit is already open, the focus is returned to the terminal, instead of opening a new instance of lazygit.
- Fixed issue: when lazygit is opened, if any other terminals are active, terminal panel is not opened.
### 1.0.6
- Fixed issue: [BUG] Terminal does not move to editor consistently in WSL [#7](https://github.com/Chaitanya-Shahare/lazygit-for-vscode/issues/7) with [PR #9](https://github.com/Chaitanya-Shahare/lazygit-for-vscode/pull/9)
### 1.0.7
- Feature: Add custom command for powershell & other shells [#15](https://github.com/Chaitanya-Shahare/lazygit-for-vscode/issues/15), user can now add custom command for powershell and other shells in the settings.
## Contributing
- If you have any suggestions or issues, feel free to open an issue or a PR against the `main` branch.
**Enjoy!**