JSPM

figlet-cli

0.3.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 4583
  • Score
    100M100P100Q122325F

Command line interface for the FIGlet.js library.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (figlet-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    figlet-cli

    A command line interface for the figlet.js library.

      _______  __     _______   ___       _______  ___________  
     /"     "||" \   /" _   "| |"  |     /"     "|("     _   ") 
    (: ______)||  | (: ( \___) ||  |    (: ______) )__/  \\__/  
     \/    |  |:  |  \/ \      |:  |     \/    |      \\_ /     
     // ___)  |.  |  //  \ ___  \  |___  // ___)_     |.  |     
    (:  (     /\  |\(:   _(  _|( \_|:  \(:      "|    \:  |     
     \__/    (__\_|_)\_______)  \_______)\_______)     \__|     
                                                                

    Getting Started

    Install this globally and you'll have access to the figlet.js library on the command line:

    npm install -g figlet-cli

    Usage Examples

    Default Options

    Below is a simple example that uses the default options.

    figlet "hello world"

    Custom Options

    Below is an example that uses a custom font.

    figlet -f "Dancing Font" "Hi"

    Following example uses an external font file

    figlet --ff .\phm-largetype.flf "Hi"

    Following example uses an external font file over https (http:// and file:// are also supported)

    figlet --ff https://raw.githubusercontent.com/patorjk/figlet-cli/refs/heads/master/miniwi.flf "Hi"

    Goals

    Eventually I think it would be nice for this app to have to same command line interface as the C-based app.

    Credits

    This was originally submitted to figlet.js by timhudson. It's been broken out as a spearate project so users can control which figlet they want to use on the command line (i.e., so installing the figlet.js library globally wont conflict with the C-based command line figlet app).

    Release History