Skip to main content

A CLI tool that manages files and directories.

Project description

Foldora - File & Directory Manager CLI Tool

PyPI version Contributor Covenant License Downloads

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:

  • 📝 Displaying file contents
  • 🧹 Purging files and directories
  • 📁 Listing files and directories
  • 📂 Creating directories and files
  • ✏️ Replacing spaces in file and directory names with underscores

🛠️ 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.
pip install foldora

📦 Usage

Run Foldora using the fd command followed by the desired operation.

📁 List Files and Directories

Lists all files and directories in the current or specified paths.

Command:

fd la [optional_paths]

Notes:

  • Hidden files and directories may also be included depending on the system settings.
  • If a specified path is a file, an error will be raised.
  • Multiple paths can be specified to list contents from different directories at once.

Examples:

  • List files/dirs of the current directory
fd la
  • List files/dirs of specific directories
fd la /path/to/dir1 /path/to/dir2  

📂 Create Directories

Creates one or more directories.

Command:

fd cd [paths]

Notes:

  • Creates all necessary parent directories if they do not exist.
  • Does not modify existing directories.
  • Supports creating multiple directories in a single command.

Example:

fd cd /path/to/dir1 /path/to/dir2 ...

📄 Create Files

Creates one or more files in the current directory or a specified path.

Command:

fd cf '[-p path]' [file_paths]

Notes:

  • Existing files with the same names will not be overwritten.
  • If the specified directory (or path) does not exist, it will be created.
  • Supports creating multiple files in a single command.

Examples:

  • Create files in the current directory
fd cf file1.txt file2.txt  
  • Create files in a specified directory
fd cf -p /path/to/dir file1.txt file2.txt  

🧹 Purge Files and Directories

Deletes specified files and directories with user confirmation.

Command:

fd pa [file_paths] [dir_paths]

Notes:

  • Use with caution, as this action cannot be undone.
  • Directories will be deleted recursively, including all their contents.
  • Ensure you have the necessary permissions to delete the specified paths.

Example:

fd pa /path/to/dir1 /path/to/file1 ...

📝 Display File Contents

Shows the content of one or more files.

Command:

fd sc [file_paths]

Notes:

  • Files must be readable, or an error will be raised.
  • Supports multiple files, displaying each file's content in sequence.

Example:

fd sc /path/to/file1 /path/to/file2 ...

✏️ Fill Blanks in File/Directory Names

Replace spaces in file and folder names with underscores.

This command renames files and folders by replacing any spaces in their names with underscores. It operates on the specified directory (or the current directory if none is provided). All files and directories in that location will have their names updated to remove spaces.

Command:

fd rs [path]

Notes:

  • By default, only top-level files and folders are renamed.
  • When prompted, entering 'y' activates Deep Folder Traversal mode, which processes all nested directories.
  • Deep Folder Traversal mode allows recursive renaming for all files and folders within the specified path.

Example:

  • Current directory
fd rs
  • Specific directory
fd rs /path/to/dir

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve Foldora.

📄 License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foldora-0.0.4.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

foldora-0.0.4-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file foldora-0.0.4.tar.gz.

File metadata

  • Download URL: foldora-0.0.4.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for foldora-0.0.4.tar.gz
Algorithm Hash digest
SHA256 27709bd55efb8a12b8c22e3bb77731967d57d2f3723897aa07810d29ef51a66a
MD5 fa77a330249740a1ff02c95b4a1b1044
BLAKE2b-256 bb53a5989bf6ca63dffdb0a0e23c1b212358e703e701e6ae9570244206dd3f76

See more details on using hashes here.

Provenance

The following attestation bundles were made for foldora-0.0.4.tar.gz:

Publisher: foldora.yml on ayoub-aberbach/foldora

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file foldora-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: foldora-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for foldora-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a943129e58dbf943c5003bb14ab16c2fdf959618bc6f6ac4c72c5df651a7d007
MD5 d600c00e85e23fb4dc8ad475224f854f
BLAKE2b-256 30cdad90ddda7962669ee116cd171a739f10ae877bbf3f26eb7564116f9ac8a1

See more details on using hashes here.

Provenance

The following attestation bundles were made for foldora-0.0.4-py3-none-any.whl:

Publisher: foldora.yml on ayoub-aberbach/foldora

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page