repo2txt-for-llm README

Overview

The repo2txt-for-llm is a Visual Studio Code extension that creates an organized representation of your repository's structure. It generates a comprehensive summary and file tree, making it easier for developers and language models to understand the layout and content of a project quickly.

Features

• File Type Selection: Choose which file types to include in the analysis.
• Extraction Options: Extract the entire repository structure or focus on a specific function.
• AI-powered Improvement: Optional use of OpenAI or Anthropic APIs to refine the output for better LLM understanding.
• API Key Management: Securely store API keys for future use.
• Flexible Output: Opens the result in a new VSCode editor and copies to clipboard for easy viewing and sharing.

Installation

1. Download the .vsix file from the releases page.
2. In VS Code, go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Click on the "..." at the top of the Extensions view and choose "Install from VSIX...".
4. Navigate to and select the downloaded .vsix file.
5. Reload VS Code when prompted.

How to Use

1. Open your project in Visual Studio Code.

2. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P).

3. Type "Generate Repository .txt for LLM" and select the command.

4. Follow the prompts to customize your output:

   a. Select the file type to include (e.g., All, ts, py, etc.)

   b. Choose between extracting everything or only a specific function

   c. If you chose a specific function, enter the function name

   d. Select the extraction method: No LLM, Anthropic, or OpenAI

   e. If using an LLM, provide your API key (with option to save for future use)

5. The extension will generate a summary, open it in a new editor, and copy it to your clipboard.

Requirements

• Visual Studio Code v1.80.0 or higher
• If using AI improvement:
  • OpenAI API key or Anthropic API key

Extension Settings

This extension does not contribute any VS Code settings at this time.

Known Issues

• The extension may take longer to process very large repositories.
• Some complex code structures may not be accurately captured when extracting specific functions.

Release Notes

0.0.7

• Implemented new workflow for file type selection and extraction options
• Added support for focusing on specific functions
• Integrated optional AI-powered improvement with OpenAI and Anthropic
• Improved API key management with secure storage option

0.0.6

• Fixed issue with file type selection not working as expected
• Improved user interface for selecting multiple file types
• Enhanced error handling and user feedback during the selection process

0.0.5

• Added option to choose between full repository extraction and specific function extraction
• Implemented AI-powered improvement for specific function extraction
• Added functionality to store and reuse API keys
• Improved user interface flow and options

0.0.4

• Fixed issue with command not appearing in the Command Palette
• Updated README with clearer installation and usage instructions
• Improved error handling for API calls

0.0.3

Initial release of repo2txt-for-llm

For more information

• Visual Studio Code's Markdown Support
• Markdown Syntax Reference

Enjoy!