# README
termx
ANSI terminal support for Go(lang)
terminal
provides a go module to access ANSI features of a (pseudo) terminal. The module provides packages
that support
- colored output
- raw input handling
- application mode
- alternative screen buffers
- mouse support
All features are implemented to support xterm compatible terminals (no terminfo parsing is done). In addition compatible features are tested to work on windows as well (if supported).
Installation
terminal
can be installed as a Go module
go get github.com/halimath/terminal
Usage
The terminal
package provides a type Terminal
which provides methods to deal with the terminal.
The Terminal
type provides methods to
- enter and exit raw mode
- read and write strings, raw bytes as well as control sequences
- read
input.Event
s which decode byte sequences into key presses and mouse events
This module provides a package csi
which contains Control Sequence Introducer definitions that
enable advanced terminal output operations, such as
- moving the cursor
- clearing (parts of) the screen
- setting the terminal's window title
- querying terminal information (i.e. cursor position, background color)
This module provides a package sgr
, which contains definitions for Select Graphic Rendition
which allows applications to format colored text or otherwise styled text output.
See the examples
directory for small applications demonstrating how to use this module.
Useful resources
A lot of information about the escape sequences and their treatment by different terminal applications has
been gathered from the following resources which i highly recommend to anyone interested in the internals
of terminal
:
- https://invisible-island.net/xterm/ctlseqs/ctlseqs.html
- https://chrisyeh96.github.io/2020/03/28/terminal-colors.html
License
Copyright 2023 Alexander Metzner.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.