Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ornitorink0/rootie
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.
https://github.com/ornitorink0/rootie
cli clipboard directory export-to-text java module nodejs tree-structure
Last synced: 13 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/ornitorink0/rootie
- Owner: Ornitorink0
- License: gpl-3.0
- Created: 2024-07-17T17:26:31.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-07-22T12:12:01.000Z (6 months ago)
- Last Synced: 2024-11-06T06:24:42.422Z (2 months ago)
- Topics: cli, clipboard, directory, export-to-text, java, module, nodejs, tree-structure
- Language: JavaScript
- Homepage:
- Size: 4.33 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Rootie
**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.
## Features
- **Display** of the directory of your choice
- **Copy** to tree clipboard
- **Export** to tree `.txt` file
## Installation
1. **Clone the repository**:
```sh
git clone https://github.com/Ornitorink0/rootie.git
cd rootie
```
2. **Install dependencies**:
```sh
npm install
```
## Usage
### Start the Application
To start the application in development mode, run:
```sh
npm run start
```
### Compile the Application
To unify all the code into one file, run:
```sh
npm run build
```
### Usage tips
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):
```sh
@echo off
:: edit with the relative path to the file
node path\to\your\directory\index.mjs %*
```
## Project Structure
```
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
```
## Dependencies
- [chalk](https://www.npmjs.com/package/chalk): Terminal string styling.
- [clipboardy](https://www.npmjs.com/package/clipboardy): Access the system clipboard.
- [fs-extra](https://www.npmjs.com/package/fs-extra): File system operations.
- [inquirer](https://www.npmjs.com/package/inquirer): Command line user interfaces.
- [strip-ansi](https://www.npmjs.com/package/strip-ansi): Strip ANSI escape codes.
## Contributing
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.
## License
This project is licensed under the GNU GPLv3 License. See LICENSE file.