Skip to content

ai-armageddon/ASCII-shell-greets

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ascii-shell-greets

Be greeted with colorful ASCII art whenever you open a shell.

ascii-shell-greets is a modern reboot of the original package, rebuilt with configuration, themes, shell setup tooling, and extra fun output.

Features

  • Multiple ASCII characters (cat, robot, coffee, octopus, dragon, terminal, or random)
  • Color themes (sunrise, ocean, forest, retro, fire, mono)
  • Time-based greeting (Good morning, Good afternoon, Good evening)
  • Random jokes, daily missions, and optional fortune lines
  • Config file support (~/.ascii-shell-greets.json)
  • Interactive setup that asks whether to run on terminal startup
  • Optional short alias (asg by default, customizable)
  • Startup hook automation (setup and doctor)

Install

npm install -g ascii-shell-greets

During interactive global installs, setup asks if you want:

  • Auto-greeting on new terminal sessions
  • A short alias for the command

Skip setup prompts with:

ASG_SKIP_SETUP=1 npm install -g ascii-shell-greets

Quick Usage

ascii-shell-greets ascii-shell-greets --theme ocean --art robot --name "Captain" ascii-shell-greets --no-joke --fortune --message "Today is release day." ascii-shell-greets --list

Sample Output

Sunrise Cat

Sunrise cat sample

Ocean Dragon

Ocean dragon sample

Retro Robot

Retro robot sample

Commands

Greet

ascii-shell-greets [options]

Options:

  • -n, --name <name>
  • -t, --theme <theme>
  • -a, --art <art>
  • -m, --message <text>
  • --joke / --no-joke
  • --mission / --no-mission
  • --fortune / --no-fortune
  • --time / --no-time
  • --color / --no-color
  • --config <path>
  • --list

Setup shell startup hook

ascii-shell-greets setup ascii-shell-greets setup --shell bash ascii-shell-greets setup --shell zsh --dry-run ascii-shell-greets setup --alias asg ascii-shell-greets setup --no-startup --alias wow

Setup options:

  • --alias <name>
  • --no-alias
  • --startup / --no-startup
  • --interactive / --no-interactive

Doctor

ascii-shell-greets doctor

Checks zsh, bash, and fish shell rc files for startup and alias status.

Config file

Default path: ~/.ascii-shell-greets.json

Example:

{ "enabled": true, "name": "Ari", "theme": "sunrise", "art": "random", "showTime": true, "showJoke": true, "showMission": true, "showFortune": false, "color": true, "message": "Make it fun." }

CLI flags override config values.

Development

npm test node bin/ascii-shell-greets.js --no-color

Contributing

Bug reports and pull requests are welcome at:

License

MIT

About

Colorful ASCII greetings, jokes, and missions every time you open a shell. Fully configurable, themeable, and fun.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors