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

https://github.com/alvarezmauro/styled-printf

Do you want to add some styles 🎨 to the output of your bash printf commands? Use this custom script and make the output of that printf look fanzy :bowtie:
https://github.com/alvarezmauro/styled-printf

bash bash-script

Last synced: 5 months ago
JSON representation

Do you want to add some styles 🎨 to the output of your bash printf commands? Use this custom script and make the output of that printf look fanzy :bowtie:

Awesome Lists containing this project

README

          

# styled-printf
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000&style=flat-square)](https://github.com/bvanhoekelen/terminal-style/blob/master/LICENSE)
[![npm](https://img.shields.io/npm/v/npm-auto-version.svg?maxAge=2592000)](https://www.npmjs.com/package/https://www.npmjs.com/package/styled-printf)

Do you want to add some styles 🎨 to the output of your bash **printf** commands? Use this custom script and make the output of that **printf** look fanzy :bowtie:

## How install

Using Yarn
```Shell
yarn add styled-printf
```

Using NPM:
```Shell
npm i styled-printf
```

## How to use

The `styled-printf` command is like `printf` (in fact it's a function wrapping `printf`) that allows you to easily set the text styling, color and background color for the output.

### Usage:
```Shell
styled-printf [-s ] [--style ]
[-c ] [--color ]
[-b ] [-background-color ]
format [argument]
```

### Options:
| Option | Description | Values |
| ------ | --- | --- |
| `-s` \| `--style` | Text formatting | `normal` \| `bold` \| `dim` \| `italics` \| `underline` \|
`blink` \| `reverse` \| `hidden` \| `password` |
| `-c` \| `--color` | Text color | `default` \| `white` \| `black` \| `red` \| `green` \|
`yellow` \| `blue` \| `magenta` \| `cyan` \| `gray` \|
`light-red` \| `light-green` \| `light-yellow` \|
`light-blue` \| `light-magenta` \| `light-cyan` \|
`light-gray` \|

or a number between`0` and `256` | |
| `-b` \| `--background-color` | Background color | `default` \| `white` \| `black` \| `red` \| `green` \|
`yellow` \| `blue` \| `magenta` \| `cyan` \| `gray` \|
`light-red` \| `light-green` \| `light-yellow` \|
`light-blue` \| `light-magenta` \| `light-cyan` \|
`light-gray` \|

or a number between`0` and `256` | |

### Example
```Shell
styled-printf -s bold -c blue -b yellow "%s\n" "This text is bold, red and has a blue background"
```

styled-printf output: text 'This text is bold, red and has a blue background' in blue color, bold and yellow background

### Other flags:
| `-h` \| `--help` | Display the help documentation |
| ------- | ------- |
| `-t` \| `--test` | Test all the different styles in your bash terminal |