Skip to content

api reference

2CHEVSKII edited this page Jul 10, 2026 · 1 revision

API Reference

Module Commands

Enable-Gly

Enables gly configuration and loads format data if needed.

Enable-Gly

Disable-Gly

Disables glyphs and colors through configuration.

Disable-Gly

PowerShell format data remains loaded in the current session.

Get-GlyConfiguration

Returns a detached GlyConfiguration copy of the current session configuration.

Get-GlyConfiguration

Set-GlyConfiguration

Updates selected configuration values.

Set-GlyConfiguration -ShowColors $false -GlyphSet Unicode

Theme Commands

Get-GlyTheme
Get-GlyTheme DefaultDark
Set-GlyTheme DefaultLight
Copy-GlyTheme DefaultDark MyTheme
Register-GlyTheme $theme

Built-in themes cannot be overwritten.

Get-GlyTheme and Copy-GlyTheme return GlyTheme values with typed styles, rules, and selectors. Register-GlyTheme accepts that type or a compatible hashtable/pscustomobject.

Glyph Set Commands

Get-GlyGlyphSet
Get-GlyGlyphSet Unicode
Set-GlyGlyphSet Unicode
Copy-GlyGlyphSet ANSI MyGlyphs
Register-GlyGlyphSet $glyphs

Built-in glyph sets cannot be overwritten.

Get-GlyGlyphSet and Copy-GlyGlyphSet return GlyGlyphSet values with typed rules and selectors. Register-GlyGlyphSet accepts that type or a compatible hashtable/pscustomobject.

Preview Commands

Show-GlyThemeColor
Show-GlyThemeColor DefaultDark
Show-GlyGlyph
Show-GlyGlyph Unicode
Show-GlyThemePreview
Show-GlyThemePreview -Theme DefaultDark -GlyphSet Unicode

The commands use the active theme and glyph set when names are omitted. They return one preview object for the fallback and each matcher, and do not alter session configuration.

Renderer Commands

Show-Gly -Path .
Show-GlyTree -Path . -Depth 2
Show-GlyGrid -Path .

Aliases:

gly
glytr
glygr

Implementation Detail

Get-GlyFileSystemDisplayName is exported so PowerShell format data can call it reliably. It is not the primary user-facing API.

Clone this wiki locally