Skip to content

sysfat/dir-view

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

dir-view

A simple command-line tool to visualize directory structures.

Description

DirView is a cross-platform CLI tool for displaying the hierarchical structure of directories. It supports excluding specified folders and optionally displaying hidden files and directories.

Getting Started

Dependencies

  • Go language version 1.20 or higher

Installing

Windows

  1. Open a terminal and clone the repository:

    git clone https://github.com/sysfat/dir-view.git
  2. Navigate to the cloned directory:

    cd dir-view
  3. Build the executable:

    go build -o dirview.exe
  4. Run dirview.exe commands as described below.

Linux & macOS

  1. Open a terminal and clone the repository:

    git clone https://github.com/sysfat/dir-view.git
  2. Navigate to the cloned directory:

    cd dir-view
  3. Build the executable:

    go build -o dirview
  4. Run dirview commands as described below.

Executing Program

  1. Open a terminal.

  2. Run DirView commands as follows:

    • Display the directory structure for the current folder:

      dirview
    • Display the structure for a specific folder:

      dirview /path/to/folder
    • Exclude specific directories:

      dirview -exclude=node_modules,vendor
    • Show hidden files and directories:

      dirview -show-hidden

Help

For any issues, ensure the correct syntax is used for commands and flags (-exclude, -show-hidden).

For more information, run:

dirview -help

License

This project is licensed under the MIT License.

Acknowledgments

  • Inspired by the Unix tree command.

About

CLI tool inspired by the tree command

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages