favicon.ico file
JSON for Repo Generator LogoJSON for Repo Generator

Documentation

Overview

JSON for Repo Generator is a user-friendly tool designed to convert any directory structure into a JSON format compatible with various Large Language Models (LLMs) for project knowledge integration. While initially conceived for code repositories, this tool is versatile enough to handle any type of directory, making it useful for a wide range of use cases.

Features

  • User-friendly GUI: Easy-to-use interface for selecting input directory and output file.
  • Flexible Ignore Rules: Supports .gitignore files and custom ignore patterns.
  • Token Limit Management: Automatically splits output into multiple files if it exceeds the specified token limit.
  • Wide File Support: Handles various file types, including text files, code files, and binary files.
  • Customizable Output: Allows users to specify the maximum number of tokens per output file.

Usage

  1. Click on the JSON-for-Repo-Generator executable to launch the application.
  2. Use the GUI to:
    • Select the input directory you want to convert.
    • Choose the output JSON file location.
    • Set the maximum number of tokens per file (default is 100,000).
    • Optionally use .gitignore rules and add custom ignore patterns.
  3. Click "Generate JSON".

Important Notes

  • The tool works locally on your machine, ensuring the privacy and security of your data.
  • Large directories may result in multiple output files to stay within LLM's project knowledge size limits.
  • Binary files and unsupported file types will be noted in the output but their contents will not be included.

Use Cases

This tool is beneficial for various LLM users, including but not limited to:

  • Developers wanting to discuss their projects with LLMs
  • Writers organizing research materials or manuscript drafts
  • Students managing study materials and notes
  • Professionals organizing work documents and project files
  • Anyone looking to create a structured knowledge base from their file system

Limitations

  • The tool provides an estimate of token count, which may differ slightly from LLM's actual count.
  • Very large directories may take some time to process.
  • The maximum file size that can be processed depends on your system's available memory.

Troubleshooting

If you encounter any issues running the executable:

  1. Ensure your antivirus software is not blocking the application.
  2. Try running the application as an administrator.
  3. Check that your system meets the minimum requirements (Windows 10 or later).

Support

If you encounter any issues or have questions, please contact our support team at pgrudrakshi@gmail.com.

Licenses

JSON for Repo Generator uses the following open-source libraries:

  1. Python Standard Library License: Python Software Foundation License

  2. tkinter License: Python Software Foundation License

  3. json License: Python Software Foundation License

  4. mimetypes License: Python Software Foundation License

  5. pathspec License: Mozilla Public License 2.0 (MPL 2.0)

JSON for Repo Generator License

This software is provided as-is, without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
  2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.