Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arsham/figurine

Print your name in style
https://github.com/arsham/figurine

command-line eye-candy figlet go golang lolcat terminal-app

Last synced: 3 days ago
JSON representation

Print your name in style

Awesome Lists containing this project

README

        

# Figurine

[![PkgGoDev](https://pkg.go.dev/badge/github.com/arsham/figurine)](https://pkg.go.dev/github.com/arsham/figurine)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/arsham/figurine)
[![Go Report Card](https://goreportcard.com/badge/github.com/arsham/figurine)](https://goreportcard.com/report/github.com/arsham/figurine)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Print your name in style

![Screenshot](/docs/figurine.png?raw=true "Rainbow")

### Table of Contents

1. [Installation](#installation)
2. [Usage](#usage)
3. [See Also](#see-also)
4. [License](#license)

## Installation

You can download the latest binary from
[here](https://github.com/arsham/figurine/releases), or you can compile from
source:

```bash
go install github.com/arsham/figurine@latest
```

## Usage

Every time the application is called, it chooses a random font for rendering the
message. Pass the message you want to decorate as arguments.

```bash
figurine Some Text
```

You can print available fonts:

```bash
figurine -l
figurine -l -s
figurine -ls Sample Text
```

To set a font:

```bash
figurine -f "Poison.flf" Some Text
```

To get a list of available arguments:

```bash
figurine -h
```

This application is very light weight, so feel free to add it to your
.zshrc/.bashrc file, so each time you open a new shell it shows you a nice
message.

## See Also

See also [Rainbow][rainbow], which is the library that colours the output.

## License

Use of this source code is governed by the Apache 2.0 license. License that can
be found in the [LICENSE](./LICENSE) file.

[rainbow]: https://github.com/arsham/rainbow