ConsoleTree

A tool to write a tree structure to the console standard output stream, with colors support and a lot of customization options.

Getting started

To add ConsoleTree to your project, you can use the following NuGet Package Manager command:

Install-Package ConsoleTree

More options are available on the ConsoleTree page of the NuGet Gallery website.

Usage

Implement the ITreeNode interface to obtain the node of a tree structure. Optionally override the ToString method to provide a custom text for the node. To write a tree structure to the console standard output stream, call the Tree.Write method specifying its root node as parameter.

class TreeNode : ITreeNode
{
	public string Text { get; set; }
	public List<TreeNode> Nodes { get; set; } = new List<TreeNode>();

	public IEnumerable<ITreeNode> GetNodes()
	{
		return Nodes;
	}

	public override string ToString()
	{
		return Text;
	}
}

var tree = new TreeNode
{
	Text = "a",
	Nodes = new List<TreeNode>
	{
		new TreeNode { Text = "b"},
		new TreeNode { Text = "c"}
	}
};

Tree.Write(tree, new DisplaySettings { IndentSize = 2 });

// Output:
//
// a
// ├──b
// └──c

If it is not possible or not desired to implement the ITreeNode interface, then use the Tree.Write<T> method overloads.

sealed class TreeNode
{
	public string Text { get; set; }
	public List<TreeNode> Nodes { get; set; } = new List<TreeNode>();
}

var tree = new TreeNode
{
	Text = "a",
	Nodes = new List<TreeNode>
	{
		new TreeNode { Text = "b"},
		new TreeNode { Text = "c"}
	}
};

Tree.Write(tree, (node, level) => Console.Write(node.Text), (node, level) => node.Nodes, new DisplaySettings { IndentSize = 2 });

// Output:
//
// a
// ├──b
// └──c

Resources

See the API reference and the ConsoleTree.Demo application to learn how to customize indentation, maximum depth, type of connectors and colors.