# go-tui

> Declarative terminal UI framework for Go. `.gsx` templates compile to type-safe Go with flexbox layout and reactive state. Pure Go, minimal dependencies.

go-tui uses a templ-like syntax in `.gsx` files that are compiled to standard Go. Layout is real flexbox (row/column/justify/align/gap/padding/margin) and state is reactive via a generic `State[T]` type. The CLI (`tui`) generates, formats, checks, and provides an LSP for `.gsx` files.

## Full bundle

- [Complete documentation (single file)](https://go-tui.dev/llms-full.txt): All guides and reference content concatenated into one markdown file, optimized for LLM ingestion.

## Guides

- [Getting Started](https://go-tui.dev/guide/getting-started.md)
- [GSX Syntax](https://go-tui.dev/guide/gsx-syntax.md)
- [Styling and Colors](https://go-tui.dev/guide/styling.md)
- [Layout](https://go-tui.dev/guide/layout.md)
- [Built-in Elements](https://go-tui.dev/guide/elements.md)
- [State and Reactivity](https://go-tui.dev/guide/state.md)
- [Components](https://go-tui.dev/guide/components.md)
- [Event Handling](https://go-tui.dev/guide/events.md)
- [Refs and Click Handling](https://go-tui.dev/guide/refs-and-clicks.md)
- [Scrolling](https://go-tui.dev/guide/scrolling.md)
- [Focus Management](https://go-tui.dev/guide/focus.md)
- [Timers, Watchers, and Channels](https://go-tui.dev/guide/watchers.md)
- [Testing](https://go-tui.dev/guide/testing.md)
- [Multi-Component Applications](https://go-tui.dev/guide/multi-component.md)
- [Inline Mode and Alternate Screen](https://go-tui.dev/guide/inline-mode.md)
- [Streaming Data](https://go-tui.dev/guide/streaming.md)
- [Inline Streaming](https://go-tui.dev/guide/inline-streaming.md)
- [Building a Dashboard](https://go-tui.dev/guide/dashboard.md)
- [Single-Frame Printing](https://go-tui.dev/guide/print.md)
- [Animation Patterns](https://go-tui.dev/guide/animation.md)
- [Directory Tree](https://go-tui.dev/guide/directory-tree.md)
- [Custom Event Loops](https://go-tui.dev/guide/event-loop.md)

## Reference

- [App Reference](https://go-tui.dev/reference/app.md)
- [Buffer and Rendering Reference](https://go-tui.dev/reference/buffer.md)
- [Built-in Components Reference](https://go-tui.dev/reference/built-in-components.md)
- [CLI Reference](https://go-tui.dev/reference/cli.md)
- [Element Reference](https://go-tui.dev/reference/element.md)
- [Events Reference](https://go-tui.dev/reference/events.md)
- [Focus Reference](https://go-tui.dev/reference/focus.md)
- [GSX Syntax Reference](https://go-tui.dev/reference/gsx-syntax.md)
- [Component Interfaces Reference](https://go-tui.dev/reference/interfaces.md)
- [Layout Reference](https://go-tui.dev/reference/layout.md)
- [Print Reference](https://go-tui.dev/reference/print.md)
- [Refs and Click Handling Reference](https://go-tui.dev/reference/refs.md)
- [State Reference](https://go-tui.dev/reference/state.md)
- [Styling Reference](https://go-tui.dev/reference/styling.md)
- [Terminal Reference](https://go-tui.dev/reference/terminal.md)
- [Testing Utilities Reference](https://go-tui.dev/reference/testing.md)
- [Watchers Reference](https://go-tui.dev/reference/watchers.md)

## Source

- [go-tui on GitHub](https://github.com/grindlemire/go-tui): Framework source, CLI, and VS Code extension.