Skip to content
/ prtls Public

Terminal UI For Printing File Directory Hierarchy

License

Notifications You must be signed in to change notification settings

BvChung/prtls

Repository files navigation

File Directory Tree Generator

This terminal user interface application allows users to dynamically view files in directories and generate a visual representation of the directory tree structure for the current directory to an output text file. It's a handy utility for quickly visualizing the layout of your project's files and directories. Go to releases for the latest executable.

Table of Contents

Tech

Usage

Usage:
  ./prtls - [flags]

Flags:
  -h, --h, -help, --help        help command

  -o string
        -o, -o=, --o string     output file path (will create a new file as long as the path is valid)

  -p string
        -p, -p=, --p string     optional initial directory path, defaults to current directory (default ".")

Demo

Build executable: go build -o ./prtls.exe ./cmd

./prtls.exe -p . -o file.txt
prtlsfirstrelease.mp4

File Structure

.                            
├── README.md                
├── bin                      
│   └── prtls.exe            
├── cmd                      
│   └── main.go              
├── demo                     
│   ├── demo.gif             
│   ├── dirs.png             
│   ├── tree.png             
│   └── treegen.gif          
├── fstraversal              
│   ├── model.go             
│   ├── output.go            
│   ├── output_test.go       
│   ├── traversal.go         
│   └── traversal_test.go    
├── go.mod                   
├── go.sum                                   
├── prtls.exe                
└── testdata                 
    └── mockDirectory        
        └── b                
            └── c            
                ├── cc.py    
                └── d        
                    ├── a.txt
                    └── b.txt

To use this tool, navigate to the directory you want to visualize in your terminal and run the command:

Development

go run ./cmd . -[flags]

Build to executable
go build -o {name} ./cmd

Issues

Create a new issue if there are any problems with this application or any suggestions you would like to make