Tree
The tree printer can be used to display a hierarchy

Basic Usage

pterm.DefaultTree.WithRoot(putils.NewTreeFromLeveledList(pterm.LeveledList{
pterm.LeveledListItem{Level: 0, Text: "Hello, World!"}
pterm.LeveledListItem{Level: 1, Text: "Hello, World2!"}
})).Render()

Options

Name
Type
Description
Root
TreeNode
The structured tree
TreeStyle
*Style
Style of the tree
TextStyle
*Style
Style of the text
TopRightCornerString
string
Top right corner string
TopRightDownString
string
Top right down string
HorizontalString
string
Horizontal line string
VerticalString
string
Vertical line string
RightDownLeftString
string
Right down left string
Indent
int
How much the items should be indented
Writer
io.Writer
Custom output writer

Using Options

Methods

This printer implements the RenderablePrinter interface.
Method
Description
Render()
Prints to the terminal or uses the specified Writer
Srender()
Returns the rendered string

Full Specification

pkg.go.dev contains the full specification for this printer and more technical descriptions.
pterm package - github.com/pterm/pterm - Go Packages
Copy link
Edit on GitHub
On this page
Basic Usage
Options
Using Options
Methods
Full Specification