Nullean.TerminalImages.Spectre
0.2.2
dotnet add package Nullean.TerminalImages.Spectre --version 0.2.2
NuGet\Install-Package Nullean.TerminalImages.Spectre -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.Spectre" 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.Spectre" Version="0.2.2" />
<PackageReference Include="Nullean.TerminalImages.Spectre" />
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.Spectre --version 0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Nullean.TerminalImages.Spectre, 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.Spectre@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.Spectre&version=0.2.2
#tool nuget:?package=Nullean.TerminalImages.Spectre&version=0.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Nullean.TerminalImages.Spectre
Show images in Spectre.Console with the Kitty, iTerm2 or Sixel protocol, falling back to half blocks drawn with Spectre's own colours. TerminalImage is a Spectre renderable: write it like any other widget.
Install
dotnet add package Nullean.TerminalImages.Spectre
Quick start
using Nullean.TerminalImages.Detection;
using Nullean.TerminalImages.Spectre;
using Spectre.Console;
// Optional: probe once at start-up. Without this, images use environment-only detection.
TerminalImage.DefaultCapabilities = await TerminalImageDetector.DetectAsync();
var image = TerminalImage.FromPng(File.ReadAllBytes("chart.png"));
image.MaxWidth = 40; // cells; never wider than Spectre offers
image.AltText = "[chart]"; // written when the console has no ANSI or no image support
AnsiConsole.Write(image);
- It sizes itself to the width Spectre offers;
MaxWidth,MaxHeightandResample(ResampleMode.Nearestfor pixel art) tune it per image. - Inside a
PanelorTable, Spectre pads lines with spaces that overwrite Sixel and iTerm2 images; only Kitty survives. Put images directly on the console, or accept half blocks there. DefaultCapabilitiesis static and cached; setCapabilitieson one image to override it for that image.- Probe before a
Livedisplay or prompt starts reading input.
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)
- Spectre.Console (>= 0.57.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.