π 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.
- 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 ππ.
To start with FileBinder, follow these steps:
-
Clone this repository to your local machine π»:
git clone https://github.com/your-username/FileBinder.git
-
Navigate to the FileBinder directory:
cd FileBinder
-
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"
-
-
-
Run FileBinder from any terminal by typing:
FileBinder
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.
FileBinder is released under the MIT License π. See the LICENSE file for more details.