Version: 0.9.0 (tip sync — S1 present / text ship default)
Gru (GRU) is a Go-first UI toolkit (retained-mode, Raylib-backed) for building desktop applications.
License: GNU GPLv3 · BDFL (no public PRs) · version 0.9.0
Third-party notices: NOTICE
Copyright: Shawn Londono and LedoCorp
Publisher: LedoCorp · Maintainer: Shawn Londono
- Full
ui/platform — widgets, layout, text, inspector - Curated demo app (
-tags grudemo) — widget / composition demos, Tab to switch, F12 Inspector - Optional WebView2 demos (
-tags webview2) on Windows cmd/gru— scaffold, build, and package apps (gru new,gru build,gru package)- Sample apps —
cmd/hello(native) andcmd/webviewhello(FillClient WebView shell)
Gru Notepad is a product-shaped example of this toolkit
(editor, sessions, markdown preview, syntax, spell). It requires github.com/ledocorp/gru and is not
vendored into this repository.
- Repo: github.com/shawnlondono/gru-notepad
- Site: ledocorp.org/gru/notepad
- Clips: X thread
Other LedoCorp applications and internal development tools are maintained separately. This repository ships the toolkit, samples, and curated demos only.
Commercial dual-licensing may come later; it is not part of this release.
go get github.com/ledocorp/gru@v0.9.0import "github.com/ledocorp/gru/ui"Use @latest once you are comfortable tracking the newest tag.
From the repository root (folder with go.mod, assets/, pages/):
go run ./cmd/hello
go run -tags webview2 ./cmd/webviewhello
go run -tags grudemo .
go run -tags "grudemo,webview2" .Scaffold a new app:
go run ./cmd/gru new myapp
go run ./cmd/gru new myapp --webview| Guide | Path |
|---|---|
| Docs home | docs/README.md |
| Cheatsheet | docs/CHEATSHEET.md |
| Layout contracts | docs/LAYOUT.md |
| Getting started | docs/GETTING_STARTED.md |
| CLI | docs/CLI.md |
| Composition | docs/COMPOSITION.md |
| WebView | docs/WEBVIEW.md |
| Architecture | docs/architecture/README.md |
| Widgets | docs/widgets/README.md |
| API | docs/api/README.md |
| Demo index | docs/DEMO_INDEX.md |
| Build & smoke | docs/BUILD.md |
| Key | Action |
|---|---|
| Tab | Next demo scene |
| F12 | Inspector |
| F11 | Perf overlay (optional) |
Pull requests are not accepted on this repository — see CONTRIBUTING.md.
Primary target today: Windows.
Gru depends on these projects. Please respect their licenses. Full texts and notices: NOTICE.
| Project | Role | License (summary) | Link |
|---|---|---|---|
| Raylib (via raylib-go) | Windowing & rendering | Zlib | https://www.raylib.com/ |
| Remix Icon | Icon font / atlas | Remix Icon License v1.0 | https://github.com/Remix-Design/RemixIcon |
| Inter, Poppins, Fira Code, DM Mono | Bundled UI / mono fonts | SIL OFL 1.1 | See assets/fonts/*/OFL.txt |
| go-text/typesetting | Text shaping | BSD-3-Clause (+ MIT HarfBuzz subtree) | https://github.com/go-text/typesetting |
| goldmark | Markdown | MIT | https://github.com/yuin/goldmark |
| chroma | Syntax highlighting | MIT | https://github.com/alecthomas/chroma |
| go-latex | LaTeX helpers | BSD-3-Clause | https://codeberg.org/go-latex/latex |
| gospell | Spell-check | MIT | https://github.com/client9/gospell |
| gg / sbinet/gg | Imaging helpers | MIT | — |
| fsnotify | File watching | BSD-3-Clause | https://github.com/fsnotify/fsnotify |
| zenity | Native dialogs | MIT | https://github.com/ncruces/zenity |
| modernc.org/sqlite (+ libc/memory/mathutil) | SQLite | BSD-3-Clause | https://gitlab.com/cznic/sqlite |
| golang.org/x/image / x/net / x/sys / x/text | Go extended libs | BSD-3-Clause | https://pkg.go.dev |
| golang/freetype | Font raster (via x/image stack) | BSD-style | https://github.com/golang/freetype |
| go-webview2 (vendored) | Windows WebView host | MIT / ISC (loader) | Vendored under internal/go-webview2 |
| Microsoft Edge WebView2 | Embedded web runtime (Windows) | Microsoft redistribution terms | https://developer.microsoft.com/microsoft-edge/webview2 |
See CONTRIBUTING.md.
Report security issues per SECURITY.md.
Gru (GRU) — Copyright Shawn Londono and LedoCorp — GPLv3 · BDFL · 0.8.0