https://github.com/rlshukhov/wailsterm
Simple translucent terminal app
https://github.com/rlshukhov/wailsterm
terminal terminal-app terminal-emulator transluent wails wails-app wails2 xterm-js
Last synced: 8 days ago
JSON representation
Simple translucent terminal app
- Host: GitHub
- URL: https://github.com/rlshukhov/wailsterm
- Owner: rlshukhov
- License: mpl-2.0
- Created: 2024-11-26T03:58:41.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-11T12:28:50.000Z (4 months ago)
- Last Synced: 2025-04-14T23:08:58.130Z (8 days ago)
- Topics: terminal, terminal-app, terminal-emulator, transluent, wails, wails-app, wails2, xterm-js
- Language: Go
- Homepage:
- Size: 2.57 MB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WailsTerm
Simple translucent terminal app build with **Golang** + **WebKit** + **Vanilla JS** + **Websockets** and powered by **[Wails 2](https://wails.io)** + **[Xterm.js](https://xtermjs.org)**
## Features
- [x] Basic terminal app functionality
- [x] Translucent
- [x] Auto light/dark theme support
- [x] Configurable
- [x] WebLinks support (open with `cmd+click` on macOS, and `ctrl+click` on Windows/Linux)
### TODO:
- Test on Windows/Linux OS
- Setup CI/CD and releases
- Tabs support
- ~~Multiple window support~~ (at now, can run multiple app instances with one window per instance)
- Split window support
- Maybe, [Hyper.js](https://hyper.is) compatibility?
- Plugin system
## Configuration
Config is located at `~/.config/wailsterm/config.yaml` for Linux/macOS, and `%AppData%/wailsterm/config.yaml` for Windows.
Config is created and fill with default values at first launch.
This is default config example:
```yaml
version: 1
application:
single_instance: true # if set to `true`, only one instance of app can run at time
shell:
path: /usr/bin/env
args:
- /bin/zsh
- --login
envs:
- name: TERM
value: xterm-256color
- name: LC_CTYPE
value: UTF-8
window:
theme: auto # auto | light | dark
size:
width: 600
height: 400
terminal:
theme: OneHalf # OneHalf
font:
family: FiraCode # FiraCode
size: 15
weight: 400
weight_bold: 600
```
## Supported OS
- [x] MacOS (tested on macOS 15.1.1)
- [ ] Windows (not tested, but supported by stack)
- [ ] Linux (not tested, but supported by stack)
## Build
```shell
wails build -clean
```
*or*
```shell
wails dev
```
## License
This project licensed under Mozilla Public License Version 2.0, full version on license you can view at [LICENSE](LICENSE)