Skip to content
PowerShell module to show file and folder icons in the terminal
Branch: master
Clone or download
Latest commit e3a01b1 Apr 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github initial commit Apr 6, 2019
.vscode initial commit Apr 6, 2019
Terminal-Icons Remove usused code Apr 21, 2019
Tests Add test files Apr 14, 2019
docs/en-US update docs Apr 21, 2019
media
.gitattributes initial commit Apr 6, 2019
.gitignore
CHANGELOG.md initial commit Apr 6, 2019
CODE_OF_CONDUCT.md
LICENSE initial commit Apr 6, 2019
README.md update readme Apr 21, 2019
azure-pipelines.yml use pwsh tasks Apr 21, 2019
build.ps1
psakeFile.ps1 Use correct PowerShellBuild preference variable Apr 21, 2019
requirements.psd1 Add PSScriptAnalyzer to build requirements Apr 21, 2019

README.md

Terminal-Icons

PowerShell module to show file and folder icons in the terminal.

Azure Pipelines PSGallery License
Azure Pipelines Build Status PowerShell Gallery License

Overview

This is very much a work in progress. This means the structure and functionality will most likely change prior to release. Right now, it just BARELY works. USE AT YOUR OWN RISK.

Terminal-Icons is a PowerShell module that adds file and folder icons when displaying items in the terminal. This relies on the custom fonts provided by Nerd Fonts.

You must be using one of the fonts provided by Nerd Fonts for this module to work as these fonts include tons of custom glyphs/icons that are referenced by their unicode number.

How Does this Work?

It uses a custom format.ps1xml file that inspects the items being displayed and looks up their appropriate icon based on name or extension. Icons for well-known files/folders are attempted to be used first before displaying an icon based on the file extension. Any files/folders that are not matched are shown using a generic file or folder icon.

Usage

Get-Item ./README.md

Get-ChildItem

Get-ChildItem | Format-List

Get-ChildItem | Format-Wide

Screenshots

Get-ChildItem -Path . -Force

Screenshot 1

Contributions

Any ideas on how to improve this module are welcome. If you have ideas for an appropriate glyph to display for a well-known folder or file, or a particular file extension, please raise an issue. If you'd like to submit an entirely new color or icon theme, take a look at the existing ones here and here, create your new file(s) named what ever you like, and submit a pull request.

You can’t perform that action at this time.