README
¶
Nagi shared libraries for Go
github.com/mayahiro/nagi-go provides independently reusable Text and VT
foundations for Nagi terminal applications. It deliberately has no package at
the module root
Requirements
- Go 1.25 or newer
Packages
| Package | Responsibility |
|---|---|
text |
Unicode 17 grapheme segmentation, terminal Cell width, wrapping, truncation, and byte/Cell positions |
vt |
Pure typed VT input decoding and output encoding, terminal capabilities, Color, Attributes, and Style |
These packages own no application runtime, Surface, Widget, terminal session, or CLI command lifecycle
Installation
go get github.com/mayahiro/nagi-go@v0.1.0
Import only the packages an application uses
Example
The Text and VT example uses both packages in one executable program
go run ./examples/text-and-vt
License
Source code is available under the MIT License. Generated Unicode data is distributed under the Unicode License v3
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
unicodegen
command
Command unicodegen generates committed Unicode tables and conformance fixtures
|
Command unicodegen generates committed Unicode tables and conformance fixtures |
|
examples
|
|
|
text-and-vt
command
Command text-and-vt demonstrates the shared Nagi Go foundations
|
Command text-and-vt demonstrates the shared Nagi Go foundations |
|
internal
|
|
|
conformance
Package conformance contains private helpers for shared fixture tests
|
Package conformance contains private helpers for shared fixture tests |
|
Package text provides Unicode grapheme and terminal cell text primitives for Nagi.
|
Package text provides Unicode grapheme and terminal cell text primitives for Nagi. |
|
Package vt provides pure VT input decoder and output encoder primitives for Nagi.
|
Package vt provides pure VT input decoder and output encoder primitives for Nagi. |
Click to show internal directories.
Click to hide internal directories.