Skip to content

A fast, simple, and elegant terminal tool to visualize your folder structure as a tree. Explore directories at a glance, right from your command line

License

Notifications You must be signed in to change notification settings

sameer240704/tview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tview LOGO

Go Version License MIT

A fast, simple, and elegant terminal tool to visualize your folder structure as a beautiful tree with file icons and colors.

Features

  • Colorful output with syntax highlighting for different file types
  • File icons for better visual recognition
  • File size display for quick size assessment
  • Customizable depth for focused directory exploration
  • Ignore patterns to exclude unwanted directories
  • Cross-platform support (Windows, macOS, Linux)
  • Fast and lightweight written in Go

Preview

tview output example

Installation

Prerequisites

  • Go 1.19 or higher

Build from source

git clone https://github.com/sameer240704/tview
cd tview
go build -o tview main.go

Usage

Basic Usage

# Show current directory tree
tview

# Show specific directory tree
tview /path/to/directory

# Show with file sizes
tview --size

# Hide icons for minimal output
tview --icons=false

Advanced Options

# Limit directory traversal depth
tview --depth=2

# Unlimited depth traversal
tview --depth=-1

# Ignore specific directories
tview --ignore="node_modules,.git,dist"

# Disable colored output
tview --color=false

# Show file sizes
tview --size

# Show version information
tview --version

# Sort files by name and size
tview --sort size:desc

tview --sort name 

Command Line Options

The following table lists all available command line options for the tool:

Option Short Description Default
--depth Maximum directory depth (-1 for unlimited) 0
--ignore Comma-separated list of directories to ignore ""
--color Enable colored output true
--icons Hide file and folder icons false
--size Display file sizes false
--version -v Show version information false
--help -? Show help message false
--sort Sort files by 'name' or 'size' ""

LICENSE

This project is licensed under the MIT License - see the LICENSE file for details.

About

A fast, simple, and elegant terminal tool to visualize your folder structure as a tree. Explore directories at a glance, right from your command line

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages