TreeMD

TreeMD is a Go-based utility that prints a visual representation of a directory tree.

✨ Features

• Prints a directory tree with folder icons.
• Excludes specified directories from the tree.
• Simple and easy to use.

🚀 Installation

You can install the tool using Go:

go install github.com/1Solon/treemd@latest

📚 Usage

To run the script, use the following command:

treemd <target_directory>

You can also exclude directories from the tree by specifying them as arguments:

treemd -e dir_to_exclude1, dir_to_exclude2 <target_directory>

To display the directory tree up to a certain depth, use the -d flag:

treemd -d 2 <target_directory>

If you need a refresher on the available options, use the -h flag:

treemd -h

📖 Example

Running the following command:

treemd -e dir_to_exclude1, dir_to_exclude2 -d 2 /path/to/target_directory

Might produce an output like this:

📁
├──📁 folder1
│ ├──📁 subfolder1
│ └──📁 subfolder2
└──📁 folder2
   └──📁 subfolder3

🤝 Contributing

Contributions are welcome! If you would like to contribute to the project, please open an issue or a pull request.

To set up the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/1Solon/treemd.git

2. Navigate to the project directory:

   cd treemd

3. Install the tool

   Installing with Make:

   make install

   Installing with Go:

   go install github.com/1Solon/treemd

📝 License

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

📧 Contact

For any questions or suggestions, please open an issue.