Skip to content

Nick2bad4u/PS-Color-Scripts-Enhanced

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

233 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

ColorScripts-Enhanced PowerShell Module

Credits: This project owes its existence to the foundational work of two developers. The beautiful ANSI art scripts were originally created and/or sourced by Derek Taylor (DistroTube) in his project shell-color-scripts. The collection was then ported to PowerShell by Scott McKendry as ps-color-scripts. ColorScripts-Enhanced builds upon their efforts by introducing a high-performance caching system, PowerShell Cross-Platform support on Linux and Mac, an expanded command set, and a formal module structure.

PowerShell Gallery Version. PowerShell Gallery Downloads. NuGet Version. NuGet Downloads. GitHub Release.

Tests. codecov. Publish. OpenSSF Scorecard. Dependency Review. Ask DeepWiki.

Platform. PowerShell. Code Size. Repo Stars.

License: UnLicense. PRs Welcome.

A high-performance PowerShell module for displaying beautiful ANSI colorscripts in your terminal with intelligent caching for 6-19x faster load times.

ColorScripts mascot

Examples.

โœจ Features

  • ๐ŸŽจ 3156+ Colorscripts โ€” Fractals, patterns, characters, nature scenes, and more
  • โšก 6-19x Faster โ€” Intelligent caching drops load times to 5-20ms
  • ๐ŸŒ Cross-Platform โ€” Works on Windows, macOS, and Linux
  • โš™๏ธ Configurable โ€” Persist cache location, startup behavior, and defaults
  • ๐Ÿ–Œ๏ธ 500+ Custom Made Colorscripts โ€” Exclusive original designs
  • ๐Ÿพ 2500~ Pokรฉmon ColorScripts โ€” Opt-in Pokรฉmon-themed colorscripts
    • Note: Pokรฉmon art is filtered by default to keep load times fast. Opt in with -IncludePokemon on relevant commands.
  • ๐ŸŒ 10 Languages โ€” English, German, Spanish, French, Italian, Japanese, Dutch, Portuguese, Russian, Chinese
  • ๐Ÿงฉ Easy to Use โ€” Simple commands with tab completion
  • ๐Ÿ—„๏ธ Centralized Cache โ€” OS-wide in AppData/ColorScripts-Enhanced/cache
  • ๐Ÿ”„ Auto-Update โ€” Cache invalidates automatically when scripts change
  • ๐Ÿ“š Complete Help โ€” Full comment-based help for all commands

๐Ÿš€ Quick Start

# Install from PowerShell Gallery
Install-Module -Name ColorScripts-Enhanced -Scope CurrentUser

# Import and display a random colorscript
Import-Module ColorScripts-Enhanced
Show-ColorScript

# Add to your profile (optional - shows colorscript on every terminal open)
Add-ColorScriptProfile

Requires PowerShell 5.1+. PowerShell 7+ recommended for best performance.

๐Ÿ“– Basic Usage

# Show a random colorscript
Show-ColorScript
scs                          # shorthand alias

# Show a specific colorscript
Show-ColorScript -Name "mandelbrot-zoom"
scs pikachu

# List all available colorscripts
Show-ColorScript -List
Get-ColorScriptList

# Filter by category
Get-ColorScriptList -Category Patterns
Get-ColorScriptList -Tag Recommended

# Include Pokรฉmon scripts (opt-in)
Show-ColorScript -IncludePokemon

โšก Boost Performance with Caching

# Build cache for all scripts (recommended after install)
New-ColorScriptCache

# Rebuild cache if scripts seem stale
New-ColorScriptCache -Force

# Include Pokรฉmon scripts when building the cache
New-ColorScriptCache -IncludePokemon

# Clear cache if needed
Clear-ColorScriptCache -All

๐ŸŽจ Examples

Add a colorscript to your terminal startup:

# Option 1: Use the built-in helper
Add-ColorScriptProfile

# Option 2: Manually edit your profile
notepad $PROFILE
# Add these lines:
Import-Module ColorScripts-Enhanced
Show-ColorScript

# Option 3: Always include Pokรฉmon art
Add-ColorScriptProfile -IncludePokemon -SkipPokemonPrompt

# Pokรฉmon are opt-in by default
- The module filters Pokรฉmon colorscripts by default to keep startup lean.
- Opt in with `-IncludePokemon` on `Show-ColorScript`, `New-ColorScriptCache`, or `Add-ColorScriptProfile`.
- Direct Pokรฉmon names always work (e.g., `Show-ColorScript -Name Pikachu`) even without `-IncludePokemon`.

# Tip: If Pokรฉmon are filtered by default, specifying a Pokรฉmon script by name still works (e.g., `Show-ColorScript -Name Pikachu`).

Create a custom alias:

Set-Alias -Name cs -Value Show-ColorScript

๐Ÿ”ง Commands Reference

Command Alias Description
Show-ColorScript scs Display a colorscript (random or by name)
Get-ColorScriptList โ€” List available colorscripts
New-ColorScriptCache โ€” Build cache for faster performance
Clear-ColorScriptCache โ€” Remove cached files
Add-ColorScriptProfile โ€” Add module to your PowerShell profile

Get help for any command:

Get-Help Show-ColorScript -Examples

๐Ÿ”ค Nerd Font Support

Some colorscripts use special glyphs that require a Nerd Font. If you see boxes instead of icons:

  1. Download a Nerd Font (e.g., CascadiaCode, FiraCode, JetBrainsMono)
  2. Install the font and set it as your terminal font
  3. Test with: Show-ColorScript -Name nerd-font-test

๐Ÿ› Troubleshooting

Colorscript not displaying correctly?

Show-ColorScript -Name "scriptname" -NoCache

Cache seems stale?

New-ColorScriptCache -Force

Module not found?

Get-Module ColorScripts-Enhanced -ListAvailable

๐Ÿ“‹ Requirements

  • PowerShell: 5.1+ (7+ recommended)
  • OS: Windows 10/11, macOS 10.13+, or Linux
  • Terminal: Any ANSI-capable terminal (Windows Terminal, VS Code, iTerm2, etc.)

๐Ÿ“š More Information

๐Ÿ“– User Documentation
๐Ÿ› ๏ธ Developer Documentation
๐Ÿค Contributing & Community
๐Ÿ”„ CI/CD & Quality

Tests. Codecov. OpenSSF Scorecard.


๐Ÿ™ Credits

Built upon the work of:

ANSI art sourced from 16colo.rs, ArtScene, r/ANSIart, Pokemon-Colorscripts, and more artists.

๐Ÿ“„ License

Unlicense โ€” Public domain. Do whatever you want with it.


Enjoy the colors! ๐ŸŒˆโœจ

Contributors โœจ

All Contributors.

Thanks goes to these wonderful people (emoji key):

Nick2bad4u
Nick2bad4u

๐Ÿ› ๐Ÿ’ป ๐Ÿ“– ๐Ÿค” ๐Ÿš‡ ๐Ÿšง ๐Ÿ‘€ โš ๏ธ ๐Ÿ”ง
Scott McKendry
Scott McKendry

๐Ÿ› ๐Ÿ’ป ๐ŸŽจ ๐Ÿ“– ๐Ÿ’ก ๐Ÿš‡ ๐Ÿšง ๐Ÿ“ฆ ๐Ÿ”Œ ๐Ÿ‘€ โœ…
Snyk bot
Snyk bot

๐Ÿ›ก๏ธ ๐Ÿš‡ ๐Ÿšง ๐Ÿ‘€
StepSecurity Bot
StepSecurity Bot

๐Ÿ›ก๏ธ ๐Ÿš‡ ๐Ÿšง
dependabot[bot]
dependabot[bot]

๐Ÿš‡ ๐Ÿ›ก๏ธ

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsor this project

Packages

 
 
 

Contributors

Languages