Skip to content

FileBinder πŸ“ is a developer's tool for consolidating code files πŸ“„ into a single document πŸ“š. Features include selective file integration πŸ“‘, directory exclusion 🚫, and automated concatenation πŸ”„. Now with Archive Management πŸ“πŸ”™ for organizing old outputs. Ideal for code review πŸ•΅οΈ, documentation πŸ“–, and archiving πŸ—ƒοΈ. Open-source & MIT licensed

License

Notifications You must be signed in to change notification settings

johame72/FileBinder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ FileBinder

🌟 FileBinder is a cutting-edge tool designed to streamline the process of consolidating various code files πŸ“„ from your projects into a single, organized TEXT document πŸ“š. Whether you're a developer πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» looking to compile your project's source code for review πŸ•΅οΈ, documentation πŸ“–, or archival purposes πŸ—ƒοΈ, FileBinder simplifies the workflow by automating the concatenation of files while preserving their structure and hierarchy.

πŸš€ Features

  • Selective File Integration: Easily specify file types πŸ“‘ to include in your PDF, from .js, .jsx, .html, .css, to .txt, ensuring that only relevant files make it to the final document.
  • Directory Exclusion: Effortlessly exclude directories like node_modules 🚫 or any other non-essential folders to keep your document clean and focused on your code.
  • Relative Path Inclusion: Maintain context with each file's relative path and name πŸ›£οΈ included in the PDF, making navigation and reference a breeze.
  • Automated Concatenation and Conversion: FileBinder automates the tedious process of manually combining files πŸ”„ and converting them into a PDF format πŸ“„βž‘οΈπŸ“, saving you time and effort.
  • Customizable Output: Tailor the output file's location πŸ—ΊοΈ and name 🏷️ to fit your project's needs, offering flexibility in how and where you store your compiled documents.
  • Archive Management: Automatically move legacy FileBinder output files to an 'Archive' folder before generating a new document, keeping your workspace organized and preserving previous versions πŸ“πŸ”™.

🌱 Getting Started

To start with FileBinder, follow these steps:

  1. Clone this repository to your local machine πŸ’»:

    git clone https://github.com/your-username/FileBinder.git
  2. Navigate to the FileBinder directory:

    cd FileBinder
  3. Add the script to your PATH:

    • For PowerShell scripts (.ps1):

      • Create a .cmd file (e.g., FileBinder.cmd) with the following content:

        @echo off
        powershell -ExecutionPolicy Bypass -File "%~dp0FileBinder.ps1" %*
      • Add the directory containing FileBinder.cmd to your PATH environment variable:

        $env:PATH += ";C:\path\to\FileBinder"
    • For Command Prompt scripts (.cmd or .bat):

      • Simply add the directory containing the script to your PATH environment variable:

        $env:PATH += ";C:\path\to\FileBinder"
  4. Run FileBinder from any terminal by typing:

    FileBinder

πŸ’‘ Contributions

FileBinder is an open-source project πŸ’–, and contributions are warmly welcomed. Whether you're looking to fix bugs πŸ›, improve features ✨, or suggest new functionalities πŸ†•, check out our contributing guidelines for more information on how to get involved.

πŸ“œ License

FileBinder is released under the MIT License πŸ“„. See the LICENSE file for more details.

About

FileBinder πŸ“ is a developer's tool for consolidating code files πŸ“„ into a single document πŸ“š. Features include selective file integration πŸ“‘, directory exclusion 🚫, and automated concatenation πŸ”„. Now with Archive Management πŸ“πŸ”™ for organizing old outputs. Ideal for code review πŸ•΅οΈ, documentation πŸ“–, and archiving πŸ—ƒοΈ. Open-source & MIT licensed

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published