Use this checklist to get Code GUI running on your system.
- Code repository cloned
- Node.js 20+ installed (
node --version) - npm available (
npm --version)
No system libraries needed!
- Run:
./launch-gui-web.sh - Open: http://localhost:5173
- See: GUI interface with toolbar
- Click: "New Session" button
- Verify: Interface responds
✅ If this works, your frontend is good!
- No extra dependencies needed
- Run:
./launch-gui.sh - See: Native desktop window
- Install libraries:
sudo apt install -y \ libwebkit2gtk-4.1-dev \ libgtk-3-dev \ build-essential \ libssl-dev - Run:
./launch-gui.sh - See: Native desktop window
- No extra dependencies needed (uses WebView2)
- PowerShell:
.\launch-gui.ps1 - Or Command Prompt:
launch-gui.bat - See: Native desktop window
- Run:
./test-gui-setup.sh - See: All checks pass ✅
From repository root:
-
npm run gui:install- Install dependencies -
npm run gui:test- Verify setup -
npm run gui:dev- Web mode -
npm run gui:tauri- Desktop mode
- Install Node.js from https://nodejs.org/
- Run the Linux install commands above
- Or use web mode:
./launch-gui-web.sh
- Build Code first:
./build-fast.sh - This can take 20+ minutes on first run
- Stop other Vite servers
- Or change port in
code-gui/vite.config.js
Once working:
- Read:
QUICKSTART_GUI.md- Quick usage guide - Read:
code-gui/README.md- Full documentation - Try: Toolbar buttons for common commands
- Explore: All CLI features work in GUI too!
If stuck, check:
code-gui/BUILD.md- System requirementscode-gui/INSTALL.md- Installation detailsdocs/GUI_CONVERSION.md- Architecture- GitHub Issues - Report problems
If you see the GUI window with toolbar and terminal:
- ✅ Installation complete
- ✅ Ready to use
- ✅ Both CLI and GUI modes available
Enjoy using Code with a graphical interface!