This script generates a visual representation of the directory structure of a specified root directory. It supports exporting the structure to a Markdown file and offers various options to customize the output.

Output

├── .env
├── .gitignore
├── README.md
├── config/
│   ├── env.go
├── data/
│   ├── found-url.json
│   ├── url.txt
├── db/
│   ├── db.go
├── directory_structure.md
├── go.mod
├── go.sum
├── main.go
├── rss/
│   ├── fetch.go
├── telegram/
│   ├── telegram.go
├── utils/
    ├── http.go
    ├── utils.go

Installation

1. Ensure you have Python installed (version 3.6 or later recommended).
2. Install the required Python packages:

pip install colorama

Note

Just need in -c switch for colorful, you don't need install package for run the script

Commands

Switch/Option	Description	Example Usage
<directory-path>	Path to the root directory whose structure you want to display.	python main.py /home/project
-md, --export-md	Export the directory structure to a Markdown file.	python main.py /home/project -md
-d, --depth <number>	Limit the depth of directory traversal.	python main.py /home/project -d 2
-c, --color	Enable colorful output in the terminal.	python main.py /home/project -c

Usage

1. Display the Directory Structure

   python main.py /home/project

2. Export to Markdown

   python main.py /home/project --export-md

3. Limit Depth to 2 Levels

   python main.py /home/project --depth 2

4. Enable Colorful Output

   python main.py /home/project -c

5. Combine Options

   python main.py /home/project --export-md --depth 3 -c

Note

• Colorful Output: The -c or --color switch enables colorful terminal output using colorama. Without this switch, the output will be plain text.
• Depth Limiting: Use the --depth option to control how many levels deep the directory tree should be displayed.
• Markdown Export: The --export-md option saves the directory structure to a Markdown file for documentation purposes.

For any additional options or troubleshooting, please refer to the Troubleshooting section of this documentation.

Troubleshooting

• Permission Errors: If you encounter permission errors, make sure you have the necessary permissions to access the directories and files.
• Invalid Directory Path: Ensure the specified directory path is correct and exists.

Contributing

Feel free to submit issues, suggestions, or pull requests. Contributions are welcome!

Tip

Summary of Additions

• Customizing Filters: Instructions for modifying the filters.py file to include or exclude specific directories from the output.
• Adding/Removing Folders: Clear steps on how to update the EXCLUDED_DIRECTORIES list.