ccsay

A fun CLI tool that displays text in colorful ASCII art, inspired by the classic cowsay command. Perfect for adding some flair to your terminal output!

 ██████╗ ██████╗ ███████╗ █████╗ ██╗   ██╗
██╔════╝██╔════╝██╔════╝██╔══██╗╚██╗ ██╔╝
██║     ██║     ███████╗███████║ ╚████╔╝ 
██║     ██║     ╚════██║██╔══██║  ╚██╔╝  
╚██████╗╚██████╗███████║██║  ██║   ██║   
 ╚═════╝ ╚═════╝╚══════╝╚═╝  ╚═╝   ╚═╝   

Features

• 🎨 Colorful Output: Text is displayed in vibrant orange color
• 📝 Block-style ASCII Art: Uses Unicode block characters for crisp, modern look
• 🔤 Full Character Support: Supports A-Z, 0-9, and common punctuation
• 📄 Multi-line Support: Handle newlines with \n sequences
• ⚡ Fast: Built with Bun for lightning-fast performance
• 📦 Standalone Binary: No dependencies required after installation

Installation

Option 1: Download Pre-built Binary (Recommended)

1. Go to the Releases page
2. Download the ccsay binary for your system
3. Make it executable and move to your PATH:

# Make executable
chmod +x ccsay

# Move to PATH (optional)
sudo mv ccsay /usr/local/bin/ccsay

Option 2: Build from Source

Requirements: Bun runtime

# Clone the repository
git clone https://github.com/your-username/ccsay.git
cd ccsay

# Install dependencies
bun install

# Build standalone binary
bun run build

# The binary will be available at ./bin/ccsay

Option 3: Install with Bun

# Install globally with Bun
bun install -g ccsay

# Or run directly
bunx ccsay "Hello World"

Usage

Basic Usage

# Display default text
ccsay

# Display custom text
ccsay "Hello World"

# Multiple words
ccsay "This is awesome"

Multi-line Text

# Using \n for newlines
ccsay "Line 1\nLine 2"

# Separate arguments with \n
ccsay "First Line" \ n "Second Line"

Examples

Simple greeting:

ccsay "HELLO"

Output:

██╗  ██╗███████╗██╗     ██╗      ██████╗ 
██║  ██║██╔════╝██║     ██║     ██╔═══██╗
███████║█████╗  ██║     ██║     ██║   ██║
██╔══██║██╔══╝  ██║     ██║     ██║   ██║
██║  ██║███████╗███████╗███████╗╚██████╔╝
╚═╝  ╚═╝╚══════╝╚══════╝╚══════╝ ╚═════╝ 

Multi-line message:

ccsay "HELLO\nWORLD"

Numbers and symbols:

ccsay "2024!"

Character Support

• Letters: A-Z (automatically converted to uppercase)
• Numbers: 0-9
• Punctuation: Space, !, ?, ., , (comma), - (hyphen)
• Special: Newline support with \n

Use Cases

• 🎉 Terminal Banners: Create eye-catching headers for your scripts
• 📝 Status Messages: Make important messages stand out
• 🎮 Fun Commands: Add personality to your CLI tools
• 📚 Documentation: Create ASCII art for README files
• 🎯 Presentations: Terminal-based presentations with style

Integration Examples

In Shell Scripts

#!/bin/bash
ccsay "DEPLOY STARTED"
# Your deployment commands here
ccsay "DEPLOY COMPLETE"

In CI/CD Pipelines

# GitHub Actions example
- name: Build Success
  run: ccsay "BUILD SUCCESS"

As a Login Banner

Add to your .bashrc or .zshrc:

ccsay "WELCOME BACK"

Development

Want to contribute? Great!

# Clone and setup
git clone https://github.com/your-username/ccsay.git
cd ccsay
bun install

# Run in development mode
bun run dev "Your Text"

# Run tests
bun test

# Lint code
bun run lint

# Build
bun run build

Tech Stack

• Runtime: Bun - Fast JavaScript runtime
• Language: TypeScript
• Formatter/Linter: Biome - Fast, unified toolchain
• Testing: Vitest - Fast unit testing
• CI/CD: GitHub Actions

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

Apache-2.0 License - see the LICENSE file for details.

Acknowledgments

• Inspired by the classic cowsay command
• Built with love for the terminal community
• Special thanks to all contributors

Made with ❤️ for terminal enthusiasts everywhere!