ColorScripts-Enhanced 2025.11.8.1545

ColorScripts-Enhanced PowerShell Module

Credits: Built upon shell-color-scripts by Derek Taylor and ps-color-scripts by Scott McKendry. Enhanced with high-performance caching, configuration management, and full cross-platform support.

Display beautiful ANSI colorscripts in your terminal with intelligent caching for 6-19x faster load times. Perfect for terminal customization and visual appeal!

Features

• ✨ 498+ Colorscripts - Extensive ANSI art collection across 15+ categories
• ⚡ 6-19x Faster - Intelligent caching (5-20ms vs 50-300ms load times)
• 🌐 Cross-Platform - Fully tested on Windows, macOS, and Linux
• 🎯 Simple API - Easy cmdlets with full tab completion
• ⚙️ Configurable - Persist cache location, startup behavior, and defaults
• 📍 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 10 commands

Quick Start

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

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

# Add to your PowerShell profile for automatic startup
Add-ColorScriptProfile

Requires: PowerShell 5.1+ or PowerShell 7.0+

Basic Usage

# Display a random colorscript
Show-ColorScript  # or alias: scs

# Display specific colorscript by name
Show-ColorScript -Name hearts
scs mandelbrot-zoom

# List all available colorscripts
Get-ColorScriptList

# Filter by category
Get-ColorScriptList -Category Geometric

# Show detailed metadata
Get-ColorScriptList -Detailed

# Build cache for faster loading (6-19x improvement)
New-ColorScriptCache

# Build cache for specific scripts only
New-ColorScriptCache -Name bars,hearts,arch

# Clear cache when needed
Clear-ColorScriptCache -All

All Commands

Configuration

Persist preferences across sessions:

# View current configuration
Get-ColorScriptConfiguration

# Set custom cache path and disable auto-show
Set-ColorScriptConfiguration -CachePath 'D:\Cache\ColorScripts' -ProfileAutoShow:$false

# Set default colorscript for startup
Set-ColorScriptConfiguration -DefaultScript 'galaxy-spiral'

# Reset to defaults
Reset-ColorScriptConfiguration

Configuration stored in AppData/ColorScripts-Enhanced/config.json.

Getting Help

PowerShell uses the Get-Help cmdlet (not --help flags):

# Get detailed help with examples
Get-Help Show-ColorScript -Full

# View just the examples
Get-Help Show-ColorScript -Examples

# Get help for a specific parameter
Get-Help Show-ColorScript -Parameter Name

# View the about topic for module overview
Get-Help about_ColorScripts-Enhanced

Performance

Experience dramatic speed improvements:

• First run (no cache): 50-300ms - Executes script and builds cache
• Cached run: 5-20ms - Loads pre-rendered output instantly
• Improvement: 6-19x faster!
• Cache location: $env:APPDATA\ColorScripts-Enhanced\cache (Windows)
  • macOS: ~/Library/Application Support/ColorScripts-Enhanced/cache
  • Linux: ~/.cache/ColorScripts-Enhanced

Profile Integration

Add colorscripts to your PowerShell profile:

# Add with automatic random colorscript on startup
Add-ColorScriptProfile

# Import only (no automatic display)
Add-ColorScriptProfile -SkipStartupScript

# Target a specific profile scope
Add-ColorScriptProfile -Scope CurrentUserCurrentHost

# Use custom profile path
Add-ColorScriptProfile -Path $PROFILE.CurrentUserAllHosts

Advanced Features

Export Metadata

# Export all metadata with file and cache info
Export-ColorScriptMetadata -IncludeFileInfo -IncludeCacheInfo

# Save to file for external automation
Export-ColorScriptMetadata -Path ./metadata.json

Create Custom Colorscripts

# Scaffold a new colorscript with metadata
$scaffold = New-ColorScript -Name 'my-art' -Category 'Custom' -GenerateMetadataSnippet

# Open in your editor
code $scaffold.Path

Force Fresh Execution

# Bypass cache for testing
Show-ColorScript -Name hearts -NoCache

Requirements

• PowerShell: 5.1+ (Desktop) or 7.0+ (Core)
• Platforms: Windows, macOS, Linux
• Terminal: Any terminal with ANSI escape code support
• Optional: Nerd Font for icon-heavy scripts (nerd-font-test, dev-workspace)

Links & Resources

Full Documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced

• Quick Reference Guide
• ANSI Conversion Guide
• Development Guide
• Issue Tracker

Contributing

Contributions welcome! Submit colorscripts, report bugs, or suggest features.

CONTRIBUTING.md

License

MIT - See LICENSE

Tip: Run Get-ColorScriptList | Select-Object -First 10 to preview your first 10 scripts!