zenbu-labs / terminal-code

# terminal-code
VS Code inside your terminal
https://github.com/user-attachments/assets/4ba0d434-896a-4ab3-9c91-5d351dacee08
### Install (macOS & Linux):
 [code] 
### Usage
 [code] 
### How does it work?
terminal-code combines terminal-browser (a browser in the terminal) and code-server (VS Code in the browser) to bring VS Code to the terminal. You should look into these projects for more details!
### Shortcuts
Your terminal and terminal-code will likely conflict on important shortcuts, meaning sometimes terminal-code will never even receive your key press. To resolve
shortcut conflicts you can run `tode --shortcut-setup`, and you will be placed into an interactive wizard that lets you change terminal or terminal-code shortcuts
so they no longer conflict
### SSH
The recommended way to use terminal-code over ssh is running `tode --ssh ` on your local machine.
The alternative is running `tode` directly on the machine you are shh'd into. This will work, but
requires:
- every single frame drawn by vscode to be sent over the network
- all user input to be sent over the network before vscode can react
- misses out some extra optimizations
`tode --ssh` improves on this by running only the backend of vscode on the remote machine. The frontend is still running locally on your device, so vscode is able to respond to interactions ~instantly. Any network requests will get proxied over the ssh connection.
### Windows
terminal-code depends on a modern terminal feature (the kitty graphics protocol) that not many terminals on Windows support. There are projects attempting to bring this capability to terminals on Windows that you can try at your own risk:
- https://github.com/ibuildthecloud/winterm-ghostty
Even with a compatible terminal, terminal-code does not have an official windows build. But, it's possible to install the linux version of terminal-code inside WSL, which is the final piece needed to run terminal-code on Windows. Please file an issue if you are eager for a more official solution