CodeBrix.Terminal.MitLicenseForever 1.0.65

CodeBrix.Terminal

A .NET terminal emulation engine with Unicode text support.

CodeBrix.Terminal is a .NET (10 or higher) library that provides a virtual terminal (VT100/VT220/VT400/xterm-compatible) emulation engine, including a full ANSI/DEC escape sequence parser, terminal buffer management, and Unicode text utilities. It can be used to build terminal emulator UIs, process terminal output programmatically, or integrate terminal functionality into .NET applications. It has no dependencies, other than the .NET runtime.

CodeBrix.Terminal is provided as a .NET 10 library and associated CodeBrix.Terminal.MitLicenseForever NuGet package.

CodeBrix.Terminal supports applications and assemblies that target Microsoft .NET version 10.0 and later. Microsoft .NET version 10.0 is a Long-Term Supported (LTS) version of .NET, and was released on Nov 11, 2025; and will be actively supported by Microsoft until Nov 14, 2028. Please update your C#/.NET code and projects to the latest LTS version of Microsoft .NET.

The terminal engine (CodeBrix.Terminal.Engine namespace) is a fork of the XtermSharp library - see below for licensing details.

The Unicode text support (CodeBrix.Terminal.Text namespace) is a fork of the NStack library version 1.1.1 - see below for licensing details.

CodeBrix.Terminal supports:

• VT100/VT220/VT400/xterm-compatible escape sequence parsing and handling
• Terminal buffer management with scrollback history
• Cursor positioning and movement (CUP, CUU, CUD, CUF, CUB, etc.)
• Scroll regions (DECSTBM) and left/right margins (DECSLRM)
• Scroll up (SU) and scroll down (SD) operations
• Character insert and delete (ICH, DCH, DECIC, DECDC)
• Line insert and delete (IL, DL)
• Erase operations (ED, EL, ECH, DECERA, DECSERA)
• Rectangular area operations (DECCRA, DECFRA, DECRQCRA)
• SGR character attributes (bold, italic, underline, blink, inverse, dim, invisible)
• 8-color, 16-color (bright/aixterm), and 256-color foreground and background
• Device status reports (DSR) and device attributes (DA1, DA2)
• DCS status string reports (DECRQSS)
• Terminal modes (DECSET/DECRESET) including origin mode, wraparound, and bracketed paste
• Mouse tracking modes and protocol encodings
• Normal and alternate screen buffers
• Tab stop management
• Character set designation and selection (G0-G3)
• Selection and search services
• Terminal resize with content reflow
• Pseudo-terminal (PTY) fork and exec support (Unix)

CodeBrix.Terminal.Text additionally supports:

• Unicode character classification (upper, lower, title, digit, graphic, etc.)
• Unicode case conversion (upper, lower, title) with special-case and locale support
• Simple case folding
• Unicode range table lookups
• Rune (code point) handling and column width calculation
• UTF-8 string type (ustring) with encoding and decoding

Sample Code

Create a Terminal and Process Input

using CodeBrix.Terminal.Engine;

// Create a terminal with default options (80x25)
var terminal = new Terminal(null, new TerminalOptions { Cols = 80, Rows = 25 });

// Feed escape sequences and text into the terminal
terminal.Feed("Hello, Terminal!\r\n");
terminal.Feed("\x1b[1;31m");  // Set bold red foreground
terminal.Feed("Red bold text\r\n");
terminal.Feed("\x1b[0m");     // Reset attributes

// Read the terminal buffer
var line = terminal.Buffer.Lines[terminal.Buffer.YBase + 0];
for (int col = 0; col < terminal.Cols; col++)
{
    var ch = line[col];
    if (ch.Code != 0)
        Console.Write((char)ch.Code);
}

Set Up Scroll Regions

using CodeBrix.Terminal.Engine;

var terminal = new Terminal(null, new TerminalOptions { Cols = 80, Rows = 25 });

// Set a scroll region (rows 5-20)
terminal.Feed("\x1b[5;20r");

// Write content, and scrolling will be confined to the region
for (int i = 0; i < 30; i++)
{
    terminal.Feed($"Line {i}\r\n");
}

Implement a Terminal Delegate

using CodeBrix.Terminal.Engine;

// Create a custom delegate to handle terminal events
public class MyTerminalDelegate : SimpleTerminalDelegate
{
    public override void Send(byte[] data, int start, int length)
    {
        // Handle data sent back from the terminal (e.g., device status responses)
        Console.WriteLine($"Terminal sent {length} bytes");
    }

    public override void SizeChanged(Terminal source)
    {
        Console.WriteLine($"Terminal resized to {source.Cols}x{source.Rows}");
    }
}

var terminal = new Terminal(new MyTerminalDelegate(), new TerminalOptions { Cols = 120, Rows = 40 });

Note that additional sample code is available in the samples directory, including a WinUI-based remote terminal client and ASP.NET Core server.

License

The project is licensed under the MIT License. See: https://en.wikipedia.org/wiki/MIT_License

The terminal engine code in the CodeBrix.Terminal.Engine namespace is forked from the XtermSharp library, which is licensed under the MIT License. This project (CodeBrix.Terminal) complies with all provisions of the open source license of XtermSharp (code) - and will make all modified, adapted and derived code within the CodeBrix.Terminal library freely available as open source, under the same license as the XtermSharp code license (as of 3/8/2026).

The Unicode text support code in the CodeBrix.Terminal.Text namespace is forked from the NStack library version 1.1.1, which is licensed under the BSD 3-Clause License. This project (CodeBrix.Terminal) complies with all provisions of the open source license of NStack (code) - and will make all modified, adapted and derived code within the CodeBrix.Terminal library freely available as open source, under the license specified above.