Skip to content

or-yam/clightsaber

Repository files navigation

lightsabers CLIghtsaber

Fun (useless) cli tool that prints light-saber in your terminal

Demo animation

npm npm

This project aims to follow Node.js CLI Apps Best Practices


Usage

You can run the command directly using npx:

npx clightsaber [color] [options]

For example:

npx clightsaber red --length 50 --speed 5

You can also install it globally:

npm i -g clightsaber

Then run:

clightsaber [color] [options]

Arguments and Options

Name Description Default
color (argument) Sets the color of the lightsaber blade. blue
--length, -l Sets the length of the lightsaber blade. 100
--speed, -s Sets the animation speed in milliseconds. 20
--help, -h Displays the help screen.

Available Colors

  • Red
  • Green
  • Blue
  • Yellow
  • Cyan
  • Magenta
  • White
  • Random

The color input is case-insensitive. If you provide a color that doesn't exist, an error message with available colors will be shown.

About

A command line lightsaber

Topics

Resources

License

Stars

2 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors