Rootie is an innovative CLI application made with Node.JS designed to visualize the structure of a chosen directory. With a user-friendly UI that utilizes vibrant colors and emojis, Rootie enhances visibility and easily distinguishes common design files.
Additionally, the app offers practical features such as clipboard saving and exporting to a text file, simplifying the process of documenting file structures.
- Display of the directory of your choice
- Copy to tree clipboard
- Export to tree
.txt
file
-
Clone the repository:
git clone https://github.com/Ornitorink0/rootie.git cd rootie
-
Install dependencies:
npm install
To start the application in development mode, run:
npm run start
To unify all the code into one file, run:
npm run build
If it helps, create a .bat
extension file and register it in the PATH. Add the following code inside it (to be modified according to your needs):
@echo off
:: edit with the relative path to the file
node path\to\your\directory\index.mjs %*
rootie/
├── dist/ # Unified file directory
├── node_modules/ # Project dependencies
├── src/ # Source files
│ ├── assets/ # Icon assets
│ ├── icons.mjs # Icon management script
│ ├── index.mjs # Main entry point
│ └── specialfiles.mjs # Special file handling script
├── package.json # Project metadata and scripts
└── README.md # Project documentation
- chalk: Terminal string styling.
- clipboardy: Access the system clipboard.
- fs-extra: File system operations.
- inquirer: Command line user interfaces.
- strip-ansi: Strip ANSI escape codes.
Contributions are welcome! Create a pull request with a clear description of the changes, but in a new branch. Once the request is made and the code is reviewed, the code will be implemented in the main
branch.
This project is licensed under the GNU GPLv3 License. See LICENSE file.