https://github.com/alexcoder04/golored

Color your shell scripts' output
https://github.com/alexcoder04/golored

bash cli color colorization colors command-line command-line-tool go golang posix-sh shell shell-script terminal utility

Last synced: about 1 month ago
JSON representation

Color your shell scripts' output

• Host: GitHub
• URL: https://github.com/alexcoder04/golored
• Owner: alexcoder04
• License: gpl-3.0
• Created: 2022-05-22T10:33:09.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-27T14:20:55.000Z (about 2 years ago)
• Last Synced: 2024-06-20T10:16:08.145Z (7 months ago)
• Topics: bash, cli, color, colorization, colors, command-line, command-line-tool, go, golang, posix-sh, shell, shell-script, terminal, utility
• Language: Go
• Homepage:
• Size: 92.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# golored

[![Release](https://img.shields.io/github/v/release/alexcoder04/golored)](https://github.com/alexcoder04/golored/releases/latest)

[![AUR](https://img.shields.io/aur/version/golored)](https://aur.archlinux.org/packages/golored)

[![Top language](https://img.shields.io/github/languages/top/alexcoder04/golored)](https://github.com/alexcoder04/golored/search?l=go)

[![License](https://img.shields.io/github/license/alexcoder04/golored)](https://github.com/alexcoder04/golored/blob/main/LICENSE)

[![Issues](https://img.shields.io/github/issues/alexcoder04/golored)](https://github.com/alexcoder04/golored/issues)

[![Pull requests](https://img.shields.io/github/issues-pr/alexcoder04/golored)](https://github.com/alexcoder04/golored/pulls)

Simply color your shell scripts' output by piping it into this program.

If you are intereseted in a more lightweight but also less-features version written in Shell, see [alexcoder04/shclrz](https://github.com/alexcoder04/shclrz).



## Installation

### Arch Linux

Golored is available on the [AUR](https://aur.archlinux.org/packages/golored).

Either install it manually or use an AUR helper of your choice.

### Pre-built binaries

Download the corresponding binary for your system from the [releases page](https://github.com/alexcoder04/golored/releases/latest).

### Build from source

```sh

git clone https://github.com/alexcoder04/golored.git

cd golored

make build   # to compile

make install # to install the binary to your $GOPATH

```

## Usage

> `golored [-s SOURCE_FILE] formatting...`

> `golored [-help / -i / -ii]`

| argument         | function                           |

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

| `-help`          | print help                         |

| `-i`             | print color codes                  |

| `-ii`            | print extended color codes (8-bit) |

| `-s SOURCE_FILE` | read from file                     |

### Examples:

```sh

golored -s file.txt f:red underline

```

Outputs the content of `file.txt` underlined and with red foreground.

```

ls | golored b:blue

```

Colors the output of `ls` with blue background.

### List of colors:

`black`, `blue`, `red`, `magenta`, `green`, `cyan`, `yellow`, `white`

`0`-`255` (8-bit, use `-ii` flag to see how they look)

Prepend with `f:` to specify the foreground and with `b:` for background.

### List of formatting options:

`bold`, `dim`, `italic`, `underline`