asciiban

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2024 License: GPL-3.0 Imports: 1 Imported by: 1

README

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

asciiban is a go package or CLI tool that generates ASCII art banners for a given prompt. It is a fun and creative way to make your command-line prompts stand out.

SDK

Installation

To Install, run the following tool. go get -u github.com/socialviolation/asciiban@main

Usage

It can then be used in your code using the following example:

package main

import (
	"github.com/socialviolation/asciiban/ascii"
)

func main() {
    ascii.Print(ascii.Args{
        Message: "What is real?",
        Palette: ascii.PaletteMintGreen,
        Font:    ascii.FontGeorgia11,
    })
}

CLI

Installation

You can install the asciiban cli by running the following command:

go install github.com/socialviolation/asciiban@main

This will install the tool in your $GOBIN directory.

Usage

To use asciiban cli, simply run the following command:

asciiban "Your text here"

This will generate an ASCII art banner for the text you entered. More information can be found by running asciiban --help

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  fonts       Subcommands show info for available fonts
  help        Help about any command
  palettes    Subcommands show info for available palettes
  random      Generate ascii banner using random font & colours

Flags:
  -f, --font string      Colour palette to use (default "ansishadow")
  -h, --help             help for asciiban
  -m, --mode string      Palette Colour Mode (simple | alternating | vertical | horizontal)
  -p, --palette string   Colour palette to use (default "default")

  • For example, to generate an ASCII art banner using the big font and green color, run the following command:
asciiban -f georgia11 -p matrix "What is real?"

Examples

dosrebel-patriot.png georgia11-matrix.png univers-google.png crazy-retro.png

Contributing

If you find any bugs or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository: https://github.com/socialviolation/asciiban

License

This tool is released under the GPL-3.0 License. See the LICENSE file for details.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cli module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL