FileLoom 🧵

FileLoom is a versatile CLI tool designed for exploring, analyzing, and gaining insights into your files. Whether you're managing a codebase, project, or a collection of documents, FileLoom provides a seamless way to understand the composition of your files, helping you make informed decisions.

Table of Contents

• Installation
• Usage
• Features
• Contributing
• Code of Conduct
• Filing Issues
• License

Installation

To get started with FileLoom, follow these simple steps:

1. Installation:

   npm i -g fileloom

2. Run FileLoom:

   fileloom <path-to-your-directory>

That's it! You're ready to explore your files with FileLoom.

Usage

FileLoom is easy to use and offers a range of features to enhance your file exploration experience. Here are some examples of common commands:

• Basic Usage:

  fileloom -- <path-to-your-directory>

• Exclude Files:

  fileloom -- <path-to-your-directory> --exclude=file1,file2,file3

• Custom Page Size:

  fileloom -- <path-to-your-directory> --pageSize=15

For more details on available options, refer to the Usage Guide.

Features

• 📊 File Exploration: Navigate through your files with ease.
• 📂 Directory Analysis: Gain insights into your entire directory structure.
• 🚀 Fast and Efficient: FileLoom is designed for performance.

Contributing

Made by Suraj Verma

We welcome contributions from the community! If you have ideas, bug reports, or feature requests, feel free to open an issue or submit a pull request.

Before contributing, please read our Contribution Guidelines.

Code of Conduct

Please adhere to our Code of Conduct to ensure a positive and inclusive community for everyone.

Filing Issues

Encountered a bug or have a suggestion? File an issue and let us know! We appreciate your feedback.

License

FileLoom is licensed under the MIT License. Feel free to use, modify, and distribute it.