Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinniuwu/neatfiles
NeatFiles is a command-line utility designed to help you organize your files effortlessly. Whether you’re managing files in a specific directory or your entire current directory, NeatFiles makes it easy to sort and categorize your files into neat, organized folders based on their types and formats.
https://github.com/shinniuwu/neatfiles
Last synced: 1 day ago
JSON representation
NeatFiles is a command-line utility designed to help you organize your files effortlessly. Whether you’re managing files in a specific directory or your entire current directory, NeatFiles makes it easy to sort and categorize your files into neat, organized folders based on their types and formats.
- Host: GitHub
- URL: https://github.com/shinniuwu/neatfiles
- Owner: ShinniUwU
- License: mit
- Created: 2024-08-29T16:22:34.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T16:30:33.000Z (3 months ago)
- Last Synced: 2024-08-29T18:20:48.614Z (3 months ago)
- Language: TypeScript
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NeatFiles
**NeatFiles** is a command-line tool designed to help you organize your files into neat and categorized directories. It can sort files based on their types and formats and offers an OCD Mode for even more meticulous organization.
## Features
- **Directory Sorting:** Organize files within a specific directory or the current working directory.
- **OCD Mode:** Toggle OCD Mode to create separate folders for different file types and dates.
- **Interactive Menu:** A simple command-line interface for easy navigation and operation.
## Usage
1. **Clone the Repository:**
```bash
git clone https://github.com/shinniuwu/NeatFiles.git
cd NeatFiles
```
2. **Install Dependencies:**
Ensure you have Node.js installed, then run:
```bash
npm install
```
3. **Run the Script:**
Execute the script with Node.js:
```bash
npm start
```
4. **Navigate the Menu:**
- **1. Enter a directory to sort:** Sort files in a user-specified directory.
- **2. Sort in current directory:** Sort files in the current working directory.
- **3. OCD Mode:** Toggle OCD Mode on or off.
- **4. Wtf is OCD MODE?:** Learn more about OCD Mode.
- **5. Exit:** Close the application.
## OCD Mode
When OCD Mode is enabled, NeatFiles creates additional folders based on the dates. This mode helps maintain a very organized file structure, ideal for those who like everything in its place.
## Code Structure
- **`index.js`**: The main entry point of the application.
- **`path`**: Handles file paths and directories.
- **`fs`**: Manages file system operations.
- **`readline`**: Facilitates user interaction through the command line.
- **`ansis`**: Adds color and style to the terminal output.
## Contributing
Contributions are welcome! If you have suggestions, bug fixes, or improvements, please:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -am 'Add new feature'`).
4. Push to the branch (`git push origin feature-branch`).
5. Create a new Pull Request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.