Get-ChildItemColor
provides colorization of outputs of Get-ChildItem
Cmdlet of PowerShell. It is based on Tim Johnson’s script, another script
by the PowerShell Guy, and PSColor.
It provides two main functionalities:
Get-ChildItemColor
, which adds coloring to the output ofGet-ChildItem
, this function supports pipelines (it is pipeline-aware, so it does not touch the output when it is being used in a pipeline).Get-ChildItemColorFormatWide
, which is colored version ofGet-ChildItemColor | Format-Wide
. This usesWrite-Host
to output coloring. This is becauseGet-ChildItemColor | Format-Wide
does not allow multiple colors in one line. As a result, pipeline does not work withGet-ChildItemColorFormatWide
.
Note that as of v3.0.0, it no longer overloads Out-Default
, and thus Get-ChildItem
’s
output will not be touched. Users should use Get-ChildItemColor
instead.
Install from PowerShellGallery
PowerShellGet is required, which is included in Windows 10 and WMF5. If you are using PowerShell V3 or V4, you will need to install PowerShellGet.
Then, you can run Install-Module Get-ChildItemColor
.
After cloning the repo, you can put files in /src
folder into
Get-ChildItemColor
folder under your PSModulePath
(e.g., $ENV:UserProfile\Documents\PowerShell\Modules
for PowerShell 6 and
later). The master
branch always contains the latest release version.
Install from Chocolatey
The module is available as a Chocolatey package. Install it using choco install get-childitemcolor
.
When you import the module:
Import-Module Get-ChildItemColor
it provides two functions, Get-ChildItemColorFormatWide
and
Get-ChildItemColor
.
You can add aliases to these functions for convenience. For example, I have the following in my profile[fn:pathProfile] (please do not put this into ISE profile[fn:pathProfileISE] as it does not work in ISE):
If (-Not (Test-Path Variable:PSise)) { # Only run this in the console and not in the ISE
Import-Module Get-ChildItemColor
Set-Alias l Get-ChildItemColor -option AllScope
Set-Alias ls Get-ChildItemColorFormatWide -option AllScope [-HideHeader] [-TrailingSlashDirectory]
}
So l
yields colored output of Get-ChildItem
and ls
yields colored output
of Get-ChildItem | Format-Wide
equivalent.
Get-ChildItemColorFormatWide
has the following optional switches:
- -HideHeader
- supress printing of headers (path on top).
- -TrailingSlashDirectory
- add a trailing slash to directory names.
[fn:pathProfile] $Home\[My ]Documents\PowerShell\Profile.ps1
or $Home\[My ]Documents\WindowsPowerShell\Profile.ps1
[fn:pathProfileISE] $Home\[My ]Documents\WindowsPowerShell\Microsoft.PowerShellISE_profile.ps1
One can dynamically change the color scheme for different items, thanks to asidlo’s contribution. See the example below.
# Change color for directories to Blue
$GetChildItemColorTable.File['Directory'] = "Blue"
# Change color for executables to Green
ForEach ($Exe in $GetChildItemColorExtensions['ExecutableList']) {
$GetChildItemColorTable.File[$Exe] = "Green"
}
One can create a new category and assign colors easily like the example below.
$GetChildItemColorExtensions['OfficeList'] = @(
".docx",
".pdf",
".pptx",
".xlsx"
)
ForEach ($Extension in $GetChildItemColorExtensions['OfficeList']) {
$GetChildItemColorTable.File.Add($Extension, "Green")
}
You can adjust the vertical spacing using $Global:GetChildItemColorVerticalSpace
. Default is 1 (PowerShell’s
default is 2).
$Global:GetChildItemColorVerticalSpace = 1
- Replace
uint
withuint32
to maintain compatibility with PowerShell 5 (#47)
- Refactoring.
- Make
Get-ChildItemColor
a proxy function ofGet-ChildItem
, soGet-ChildItemColor
supports all the parameters of the original function.
Get-ChildItemColor
only highlights names instead of highlighting the whole row. (#30)
Get-ChildItemColor
is pipeline-aware and only adds color when it is not being used as a part of a pipeline. It no longer overloadsOut-Default
. (#31)- Add
TrailingSlashDirectory
switch toGet-ChildItemColorFormatWide
(#37)
- Add
HideHeader
switch toGet-ChildItemColorFormatWide
(#29)
- Better handling of header printout (#41)
- Add instructions about adding a new category.
- Fix uint32 error in cell width calculation. (Thanks to DanielCarmingham)
- Add Chocolatey install instructions. (Thanks to pauby)
- Fix #27, Display issue with Chinese. (Thanks to shiena)
- BUGFIX: Print directory names correctly when
-Recurse
option is used
- Re-organize folder structure
- Incorporate PSColor’s implementation of coloring the output of
Get-ChildItem
. - Add
$Global:GetChildItemColorVerticalSpace
option.
- PR #21: Added ReparsePoint (symlink) detection, matched color scheme with Linux (thanks to cmilanf)
- Make empty lines consistent between Get-ChildItemColor and Get-ChildItemColorFormatWide (Fixes #17)
- Add LICENSE
- Improve README (#15)
- Beautify code
- PR #13: Fallback to Gray when no
OriginalForegroundColor
(thanks to mikesigs) - PR #12: Fix a typo (thanks to jqly)
- Robust to non-file entries (Issue #10)
- Revert back to previous implementation of
Get-ChildItemColorFormatWide
- The script changes
$Host.UI.RawUI.ForegroundColor
only and keep the item object intact Get-ChildItemColorFormatWide
is basicallyGet-ChildItemColor | Format-Wide
- Better performance by reducing if’s
- Proper printing of
DirectoryEntry
forFormatWide
case
- Published on PowerShellGallery
- Refactoring; separate out two functions
- Make it a PowerShell module
- Returns vanila
Get-Childitem
results forDictionaryEntry
cases.
- Make function names consistent to the PowerShell naming convention (#8)
- Use parameters more consistently,
-Path
works with paths with spaces (#3), and-Force
works (#9)