tablewriter

You can install TableWriter using go get.

• For the latest stable version (includes generics and streaming APIs): github.com/olekukonko/tablewriter@v1.1.4
• For legacy applications: github.com/olekukonko/tablewriter@v0.0.5

Warning: Do not use version v1.0.0 as it contains missing functionality.

# Latest Version
go get github.com/olekukonko/tablewriter@v1.1.4

# Legacy Version
go get github.com/olekukonko/tablewriter@v0.0.5

You can install the csv2table command-line tool using go install. This tool allows you to generate ASCII tables from CSV data on the fly.

go install github.com/olekukonko/tablewriter/cmd/csv2table@latest

Since tablewriter.NewWriter accepts an io.Writer, you can use strings.Builder to capture the table output as a string.

import (
	"strings"
	"fmt"
	"github.com/olekukonko/tablewriter"
)

func main() {
	tableString := &strings.Builder{}
	table := tablewriter.NewWriter(tableString)

	// ... fill table ...

	table.Render()
	fmt.Println(tableString.String())
}

For production use, install the stable version v0.0.5 using Go modules:

go get github.com/olekukonko/tablewriter@v0.0.5

To try the in-progress, unstable development version (targeting v0.2.0 with generics and streaming support), use:

go get github.com/olekukonko/tablewriter@master

The following type aliases are deprecated and will be removed in a future version. Use the tw package types directly instead.

• tablewriter.Behavior: Use tw.Behavior directly to configure settings like auto-hiding empty columns or trimming spaces.
• tablewriter.Settings: Use tw.Settings directly to configure renderer settings like separators and line styles.

Migration Examples:

// Old (deprecated)
var b tablewriter.Behavior = tablewriter.Behavior{AutoHide: tw.On}
// New (recommended)
var b tw.Behavior = tw.Behavior{AutoHide: tw.On}

// Old (deprecated)
var s tablewriter.Settings = tablewriter.Settings{Separator: "|"}
// New (recommended)
var s tw.Settings = tw.Settings{Separator: "|"}

The WithBorders function is deprecated and will be removed. To configure border settings for renderers that support tw.Renditioning, use WithRendition instead. Alternatively, you can update the renderer's tw.RenderConfig directly via its Config() method.

Migration Example:

// Old (deprecated)
table.Options(WithBorders(tw.Border{Top: true, Bottom: true}))

// New (recommended)
table.Options(WithRendition(tw.Rendition{Borders: tw.Border{Top: true, Bottom: true}}))

The csv2table command-line tool reads CSV data from a file or STDIN and renders it as a formatted ASCII, Markdown, HTML, or SVG table.

Usage Patterns:

• File input: Provide a filename via the -f flag or as a positional argument.
• Pipe input: Use the -p flag to read from STDIN (e.g., cat data.csv | csv2table -p).
• Default behavior: If no file is provided and -p is not set, it defaults to reading from STDIN.

Usage: csv2table [options] [file]

Reads CSV data from a file or STDIN and renders it as a formatted table.

If [file] is provided, it overrides the -f flag.
If no [file] and no -f is provided, and -p is not set, STDIN is used.

WithTableMax is deprecated. Use WithMaxWidth instead for a clearer name and consistent package naming. WithMaxWidth sets the maximum width of the entire table in characters.

Migration Example:

// Old (deprecated)
tablewriter.NewTable(os.Stdout, tablewriter.WithTableMax(80))

// New (recommended)
tablewriter.NewTable(os.Stdout, tablewriter.WithMaxWidth(80))

The WithRendererSettings function is deprecated. To update renderer settings (like separators and line styles) for renderers implementing tw.Renditioning, use WithRendition. You can also configure the renderer's tw.Settings directly via its tw.Renderer.Config method.

Migration Example:

// Old (deprecated)
table.Options(WithRendererSettings(tw.Settings{Separator: "|"}))

// New (recommended)
table.Options(WithRendition(tw.Rendition{Settings: tw.Settings{Separator: "|"}}))

To create a new table instance, use NewTable which allows for custom configuration via Option functions, or NewWriter for a table with default settings. Both require an io.Writer as the destination for the output.

import (
	"os"
	"github.com/olekukonko/tablewriter"
)

table := tablewriter.NewTable(os.Stdout)
// or
table := tablewriter.NewWriter(os.Stdout)

To create a simple table, use tablewriter.NewWriter(io.Writer) to initialize the table, set the header with .Header(), add data rows with .Bulk(), and finally call .Render() to output the table to the provided writer.

package main

import (
	"github.com/olekukonko/tablewriter"
	"os"
)

func main() {
	data := [][]string{
		{"Package", "Version", "Status"},
		{"tablewriter", "v0.0.5", "legacy"},
		{"tablewriter", "v1.1.4", "latest"},
	}

	table := tablewriter.NewWriter(os.Stdout)
	table.Header(data[0])
	table.Bulk(data[1:])
	table.Render()
}