https://github.com/peterfritz/gradient-figlet

A CLI tool that creates gradient ASCII art from text with FIGlet and style.
https://github.com/peterfritz/gradient-figlet

cli figlet gradient-text greeter nodejs zsh

Last synced: 24 days ago
JSON representation

A CLI tool that creates gradient ASCII art from text with FIGlet and style.

• Host: GitHub
• URL: https://github.com/peterfritz/gradient-figlet
• Owner: peterfritz
• License: mit
• Created: 2022-01-28T06:22:12.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T04:37:14.000Z (over 1 year ago)
• Last Synced: 2024-05-02T01:04:55.284Z (6 months ago)
• Topics: cli, figlet, gradient-text, greeter, nodejs, zsh
• Language: JavaScript
• Homepage:
• Size: 732 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
gradient-figlet

  
A CLI that creates gradient ASCII art from text with FIGlet and style.





  

    

  

  

    

  

  

    

  





  





## Basic usage

You can use npx to install and run the package

npx gradient-figlet "your text here" -l



  



## Options

| option         | description                                       | default value | required | [examples](#examples)    |

| -------------- | ------------------------------------------------- | ------------- | -------- | ------------------------ |

| -l             | adds a trailing newline to fix vertical alignment | false         | false    | [-l](#l)                 |

| -m             | makes the gradient horizontal                     | false         | false    | [-lm](#lm)               |

| -t `theme`     | changes the theme ([themes list](#themes))        | 'rainbow'     | false    | [-lt](#lt)               |

| --from `color` | gradient's start color                            | null          | false    | [--from, --to](#from-to) |

| --to `color`   | gradient's end color                              | null          | false    | [--from, --to](#from-to) |

### Themes

One of [gradient-string's built-in gradients](https://github.com/bokub/gradient-string#available-built-in-gradients) listed below.

npx gradient-figlet --list-themes



  



### Examples

npx gradient-figlet "your text here" -l



  



npx gradient-figlet "your text here" -lm



  



npx gradient-figlet "your text here" -lt retro



  



npx gradient-figlet --from "#42047e" --to "#07f49e" -l