Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/jedib0t/go-pretty

Table-writer and more in golang!
https://github.com/jedib0t/go-pretty

ascii golang list pretty progress-bar progressbar string-manipulation table table-writer tablewriter

Last synced: 4 days ago
JSON representation

Table-writer and more in golang!

Host: GitHub
URL: https://github.com/jedib0t/go-pretty
Owner: jedib0t
License: mit
Created: 2018-04-30T01:54:06.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2024-12-09T05:49:47.000Z (4 days ago)
Last Synced: 2024-12-09T06:30:17.618Z (4 days ago)
Topics: ascii, golang, list, pretty, progress-bar, progressbar, string-manipulation, table, table-writer, tablewriter
Language: Go
Homepage:
Size: 3.22 MB
Stars: 3,067
Watchers: 14
Forks: 121
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

awesomeLibrary - go-pretty - Table-writer and more in golang! (语言资源库 / go)
go-awesome - go-pretty - terminal rendering table, list, progress bar, etc. (Open source library / Command Line)
my-awesome - jedib0t/go-pretty - bar,progressbar,string-manipulation,table,table-writer,tablewriter pushed_at:2024-12 star:3.1k fork:0.1k Table-writer and more in golang! (Go)

README

        # go-pretty

[![Go Reference](https://pkg.go.dev/badge/github.com/jedib0t/go-pretty/v6.svg)](https://pkg.go.dev/github.com/jedib0t/go-pretty/v6)

[![Build Status](https://github.com/jedib0t/go-pretty/workflows/CI/badge.svg?branch=main)](https://github.com/jedib0t/go-pretty/actions?query=workflow%3ACI+event%3Apush+branch%3Amain)

[![Coverage Status](https://coveralls.io/repos/github/jedib0t/go-pretty/badge.svg?branch=main)](https://coveralls.io/github/jedib0t/go-pretty?branch=main)

[![Go Report Card](https://goreportcard.com/badge/github.com/jedib0t/go-pretty/v6)](https://goreportcard.com/report/github.com/jedib0t/go-pretty/v6)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jedib0t_go-pretty&metric=alert_status)](https://sonarcloud.io/dashboard?id=jedib0t_go-pretty)

Utilities to prettify console output of tables, lists, progress-bars, text, etc.

with a heavy emphasis on customization.

## Usage

The current major version of this package is __v6__, and it follows the standard

outlined [here](https://go.dev/doc/modules/version-numbers#major-version).

Run `go get github.com/jedib0t/go-pretty/v6` to add this as a dependency to your

project, and import the packages in your code using one or more of these:

* `github.com/jedib0t/go-pretty/v6/list`

* `github.com/jedib0t/go-pretty/v6/progress`

* `github.com/jedib0t/go-pretty/v6/table`

* `github.com/jedib0t/go-pretty/v6/text`

## Table

Pretty-print tables in a terminal with colors, nested tables and more.

```

+-----+------------+-----------+--------+-----------------------------+

|   # | FIRST NAME | LAST NAME | SALARY |                             |

+-----+------------+-----------+--------+-----------------------------+

|   1 | Arya       | Stark     |   3000 |                             |

|  20 | Jon        | Snow      |   2000 | You know nothing, Jon Snow! |

| 300 | Tyrion     | Lannister |   5000 |                             |

+-----+------------+-----------+--------+-----------------------------+

|     |            | TOTAL     |  10000 |                             |

+-----+------------+-----------+--------+-----------------------------+

```

Execute `go run github.com/jedib0t/go-pretty/v6/cmd/demo-table@latest colors` to get:



More details can be found here: [table/](table)

## Progress

Track the Progress of one or more Tasks like downloading multiple files in

parallel.



More details can be found here: [progress/](progress)

## List

Pretty-print lists with multiple levels/indents into ASCII/Unicode strings.

```

╭─ Game Of Thrones

│  ├─ Winter

│  ├─ Is

│  ╰─ Coming

│     ├─ This

│     ├─ Is

│     ╰─ Known

╰─ The Dark Tower

   ╰─ The Gunslinger

```

More details can be found here: [list/](list)

## Text

Utility functions to manipulate text with or without ANSI escape sequences. Most

of the functions available are used in one or more of the other packages here.

   - Align text [Horizontally](text/align.go) or [Vertically](text/valign.go)

   - [Colorize](text/color.go) text

   - Move [cursor](text/cursor.go)

   - [Format](text/format.go) text (convert case)

   - Manipulate [strings](text/string.go) (Pad, RepeatAndTrim, RuneCount, etc.)

   - [Transform](text/transformer.go) text (UnixTime to human-readable-time, pretty-JSON, etc.)

   - [Wrap](text/wrap.go) text

GoDoc has examples for all the available functions.

## Upgrading from v5 or less to v6 or above

If you are using a version of this library older than `v6.0.0` and want to move

to a newer version of this library, you'd have to modify the import paths from

something like:

```golang

    "github.com/jedib0t/go-pretty/list"

    "github.com/jedib0t/go-pretty/progress"

    "github.com/jedib0t/go-pretty/table"

    "github.com/jedib0t/go-pretty/text"

```

to:

```golang

    "github.com/jedib0t/go-pretty/v6/list"

    "github.com/jedib0t/go-pretty/v6/progress"

    "github.com/jedib0t/go-pretty/v6/table"

    "github.com/jedib0t/go-pretty/v6/text"

```

I'd recommend you fire up your favorite IDE and do a mass search and replace for

all occurrences of `jedib0t/go-pretty/` to `jedib0t/go-pretty/v6/`. If you are

on a system with access to `find`, `grep`, `xargs` and `sed`, you could just run

the following from within your code folder to do the same:

```

find . -type f -name "*.go" | grep -v vendor | xargs sed -i 's/jedib0t\/go-pretty\//jedib0t\/go-pretty\/v6\//g'

```

If you are on macOS, you'll have to use `sed -i ''` instead of `sed -i`.