Streamed output is the primary lifetime
Finished content becomes terminal scrollback while the interactive tail stays small.
OolongStreaming-first terminal UI for Go
Streams can be long. The live interface stays bounded.
Skip to content
Language: English | 简体中文
Learn by building
Follow the path in order when adopting Oolong. Each step produces a runnable, tested slice and adds one layer without replacing the previous one.
| Level | Build | Outcome |
|---|---|---|
| Beginner | Your first interface | Run a core-only full-screen component |
| Beginner | A themeable picker | Compose headless behavior, kit appearance, layout, and input |
| Intermediate | Markdown, code, and mathematics | Use optional renderers independently and together |
| Intermediate | Bounded streaming output | Move ordered background bytes into an inline interface |
| Advanced | A bounded agent interface | Join streaming text, domain events, review, and scrollback ownership |
Browse the example catalog when you prefer to learn from complete commands. Every example includes an in-process test.
Choose the smallest useful layer
Install only the modules your application imports:
sh
go get github.com/Tangerg/oolong/core@latest
go get github.com/Tangerg/oolong/components@latestStart with core for the runtime, terminal, grid, input, text, and layout. Add components for reusable headless behavior and the default theme. Optional Markdown, highlighting, LaTeX, SSH, and PTY testing remain separate modules.
Choose modules for your interface lists the dependency and release rules.
Validate and understand the system
- Test an interface at the in-process and pseudoterminal boundaries
- Troubleshoot an application by symptom and ownership boundary
- Read the architecture for normative lifetime and dependency rules
- Compare prior systems to understand adopted and rejected ideas
- Prepare a coordinated release when maintaining the repository
Package contracts render on pkg.go.dev. The GitHub repository contains source, examples, changelog, and contribution policy.