https://github.com/douxxu/treegenerator
A tool to generate tree structures of directories.
https://github.com/douxxu/treegenerator
Last synced: 7 months ago
JSON representation
A tool to generate tree structures of directories.
- Host: GitHub
- URL: https://github.com/douxxu/treegenerator
- Owner: douxxu
- License: mit
- Created: 2024-06-18T17:08:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-19T20:37:18.000Z (over 1 year ago)
- Last Synced: 2024-10-12T16:51:18.457Z (12 months ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ├TreeGenerator
TreeGenerator is a command-line tool for generating and visualizing directory tree structures in a terminal.
## 📂 Requirements
To run TreeGenerator, ensure you have the following installed:
**Base:**
- [Node.js](https://nodejs.org/) (v14 or higher recommended)
- [npm](https://www.npmjs.com/get-npm)
**Packages:**
- [blessed](https://www.npmjs.com/package/blessed)
- [colors](https://www.npmjs.com/package/colors)
- [clipboardy](https://www.npmjs.com/package/clipboardy)
*Note: All these packages are available on [npm](https://www.npmjs.com/). You can install them using `npm install package-name`.*
## 🚀 Installation
Follow these steps to install TreeGenerator:
1. Ensure you have Node.js and npm installed on your machine.
2. Open your terminal.
3. Copy and paste the following command:
```
npm install -g @douxx/treegenerator
```
4. TreeGenerator is now installed globally on your system. You can run it using the command:
```
tree
```
## ⚙️ Usage
To generate a tree for a specific directory, use the following command:
```
tree
```
or
```
tg
```
Replace `` with the absolute or relative path of the directory you want to visualize.
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
## 🌐 Links
- **Repository:** [https://github.com/douxxu/TreeGenerator](https://github.com/douxxu/TreeGenerator)
- **Issues:** [https://github.com/douxxu/TreeGenerator/issues](https://github.com/douxxu/TreeGenerator/issues)