https://github.com/JustABearOz/PoshColor

Adds customizable color and themes to Powershell
https://github.com/JustABearOz/PoshColor

color-theme colorful colorization powershell powershell-core pscolor theme

Last synced: about 2 months ago
JSON representation

Adds customizable color and themes to Powershell

• Host: GitHub
• URL: https://github.com/JustABearOz/PoshColor
• Owner: JustABearOz
• License: mit
• Created: 2019-10-05T06:23:24.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-27T05:28:17.000Z (over 3 years ago)
• Last Synced: 2024-04-13T14:27:26.293Z (5 months ago)
• Topics: color-theme, colorful, colorization, powershell, powershell-core, pscolor, theme
• Language: PowerShell
• Homepage:
• Size: 2.19 MB
• Stars: 53
• Watchers: 3
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-powershell - PoshColor - A PowerShell module that provides a set of cmdlets for working with colors. 🚧 (⭐ Themes)

README

        
# PoshColor

PoshColor is a blatant ripoff of [PSColor](https://github.com/Davlind/PSColor) :relaxed:, allowing you to customise items in powershell based on your own color preferences. PoshColor works in Powershell Core and works across both Windows and Linux.

PSColozier can use either standard console colors or 8 bit RGB allowing 16 million colour goodness.

## Features

* Colors can be set to RGB or Named colors from .Net (System.Drawing.Color)

* Tested under Windows (powershell and powershell core) and Linux (Ubuntu/bash Ubuntu/powershell core)

* Support for Background colors

* Coloring of:

  * EventLogRecord (get-winevent)

  * Files, Directories (ls / get-childitem)

  * MatchInfo (select-string)

  * MemberInfo (get-member)

  * PSModuleInfo (get-module)

  * PSDriveInfo (get-psdrive)

  * Services (get-service)

* Files & Directories can have rules for coloring including based the following:

  * File Names using regular expressions

  * File Attributes such as directory, hidden, system, encypted or compressed

* Theme support

* Can be unloaded/reloaded without causing issues in your current session

### Screenshot of Get-Childitem

![Screenshot of get-childitem](images/lsresult.png)

### Screenshot of Select String with -Context 1

![Screenshot of select-string with context](images/selectstringwithcontextresult.png)

### Screenshot of Get-Service

![Screenshot of Get-Service](images/getserviceresult.png)

### Get-Command

![Screenshot of Get-Command](images/getcommandresult.png)

## Themes

There are currently 3 themes that come with PoshColor. Feel free to contribute more themes to make PoshColor the best it can be.

### Included themes

|Theme Name| Description|

|--|--|

|Default|The default theme using standard terminal colors|

|DefaultHighColor| Similar styling to Default, but uses 8 bit RGB colors|

|Cool| Uses RGB colors to provide a theme based on whites, blues and greens|

## Comands

|Command|Description|

|---|---|

|Get-PoshColorTheme|Gets the current theme being used by PoshColor|

|Set-PoshColorTheme|Sets the current theme for PoshColor to use|

|Get-PoshColorThemes|Gets a list of all installed PoshColor themes|

## Installation

### PowershellGallery

```powershell

Install-Module PoshColor

Import-Module PoshColor

```

### Install from source

```powershell

git clone https://github.com/JustABearOz/PoshColor.git

sl .\PoshColor

.\Install.ps1

```

### Install from Zip

Download the latest [release](https://github.com/JustABearOz/PoshColor/releases) and extract it into your powershell modules directory. 

### Add to Profile

The above installation methods will load the PoshColor module for your current session. If you want the PoshColor module loaded for all sessions, add the following line to your profile

```pwsh

Import-Module PoshColor

```

### Updating PoshColor

To update PoshColor to the newest version, run the following command in powershell

```pwsh

Update-Module PoshColor

```

### Unload PoshColor

To unload PoshColor from your session, run the following command in powershell

```pwsh

Remove-Module PoshColor

```

### Themes

To view a list of installed themes

```powershell

Get-PoshColorThemes

```

To set the current theme (Setting theme too Cool)

```powershell

Set-PoshColorTheme Cool

```

To view the current theme

``` Powershell

Get-PoshColorTheme

```

## Questions

### Why not contribute to PSColor?

PS Color seems to be a dead repository. There have not been any updates to the repo in a few years, and there are a few outstanding issues that have not been resolved. Yes, I could fix these issues, however there are PRs others have raised to fix some of the issues which have not been accepted in years. ALSO, I thought it would be fun to do :)