Nullean.TerminalImages.TerminalGui
0.2.2
dotnet add package Nullean.TerminalImages.TerminalGui --version 0.2.2
NuGet\Install-Package Nullean.TerminalImages.TerminalGui -Version 0.2.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nullean.TerminalImages.TerminalGui" Version="0.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Nullean.TerminalImages.TerminalGui" Version="0.2.2" />
<PackageReference Include="Nullean.TerminalImages.TerminalGui" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Nullean.TerminalImages.TerminalGui --version 0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Nullean.TerminalImages.TerminalGui, 0.2.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Nullean.TerminalImages.TerminalGui@0.2.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Nullean.TerminalImages.TerminalGui&version=0.2.2
#tool nuget:?package=Nullean.TerminalImages.TerminalGui&version=0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Nullean.TerminalImages.TerminalGui
Show images in Terminal.Gui v2: a TerminalImageView that feeds Terminal.Gui's Sixel and Kitty pipeline, a half-block fallback, and detection that Terminal.Gui's own handshake cannot do (probing, SSH, tmux).
Install
dotnet add package Nullean.TerminalImages.TerminalGui
Quick start
using Nullean.TerminalImages.Detection;
using Nullean.TerminalImages.Png;
using Nullean.TerminalImages.TerminalGui;
using Terminal.Gui.App;
using Terminal.Gui.ViewBase;
using Terminal.Gui.Views;
using var app = Application.Create();
app.Init();
var capabilities = await TerminalImageDetector.DetectAsync(); // before the input loop runs
app.Driver!.ApplyDetection(capabilities); // replaces Terminal.Gui's own handshake result
var view = new TerminalImageView
{
Width = Dim.Fill(),
Height = Dim.Fill(),
Image = PngDecoder.Decode(File.ReadAllBytes("logo.png")),
};
var window = new Window();
window.Add(view);
app.Run(window);
- With Sixel or Kitty, Terminal.Gui encodes, clips and repaints the image; without them the view draws half blocks.
Setting
Image,ResampleorAllowUpscaleredraws the view. - Detect before
app.Run: once Terminal.Gui reads input, a probe's replies get eaten. - Terminal.Gui has no iTerm2 pipeline, so an iTerm2-only terminal gets half blocks.
- Built against Terminal.Gui 2.x; not for Terminal.Gui v1.
Learn more
- Documentation: https://terminal-images.nullean.net
- Integrations: https://terminal-images.nullean.net/integrations/
- Source and issues: https://github.com/nullean/terminal-images
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Nullean.TerminalImages (>= 0.2.2)
- Terminal.Gui (>= 2.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.