https://github.com/ayoub-aberbach/foldora
A CLI tool that manages files and directories.
https://github.com/ayoub-aberbach/foldora
click-python pypi-package python python-cli python-click
Last synced: 3 months ago
JSON representation
A CLI tool that manages files and directories.
- Host: GitHub
- URL: https://github.com/ayoub-aberbach/foldora
- Owner: ayoub-aberbach
- License: mit
- Created: 2025-02-13T18:27:12.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-02-13T18:43:39.000Z (4 months ago)
- Last Synced: 2025-02-13T19:36:11.313Z (4 months ago)
- Topics: click-python, pypi-package, python, python-cli, python-click
- Language: Python
- Homepage: https://pypi.org/project/foldora/
- Size: 0 Bytes
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Foldora - File & Directory Manager CLI Tool
Foldora is a Python command-line interface (CLI) tool designed to help you efficiently manage files and directories.
## Features
Foldora provides essential file and directory operations, including:
- Listing files and directories.
- Creating directories and files.
- Purging files and directories.
- Displaying file contents.
## Installation
To install Foldora, clone the repository and navigate to the project directory:
- PS: Make sure python is installed in case you're new to Python.
```sh
pip install foldora
```
## Usage
Run Foldora using the `fd` command followed by the desired operation.
### Listing Files and Directories
Lists all files and directories in the current or specified paths.
**Command:**
```sh
fd l [optional_paths]
```
**Examples:**
```sh
fd l # List contents of the current directory
fd l /path/to/directory1 /path/to/directory2 # List contents of specific directories
```
### Creating Directories
Creates one or more directories.
**Command:**
```sh
fd d directory1 directory2 ...
```
**Example:**
```sh
fd d new_folder another_folder
```
### Creating Files
Creates one or more files in the current directory or a specified path.
**Command:**
```sh
fd f '[-p path]' file1 file2 ...
```
**Examples:**
```sh
fd f file1.txt file2.txt # Create files in the current directory
fd f -p /path/to/directory file1.txt file2.txt # Create files in a specified directory
```
### Purging Files and Directories
Deletes specified files and directories with user confirmation.
**Command:**
```sh
fd p file1 directory1 ...
```
**Example:**
```sh
fd p old_file.txt unused_folder
```
### Displaying File Contents
Shows the content of one or more files.
**Command:**
```sh
fd c file1 file2 ...
```
**Example:**
```sh
fd c notes.txt log.txt
```
## Contributing
Feel free to submit pull requests or open issues to enhance Foldora!
## License
This project is licensed under the MIT License.