vscode-llm-file-companion is a Visual Studio Code extension that simplifies aggregating file contents into a single document for use with large language models (LLMs). It collects text-based files (like .py
, .md
, .js
, .html
, .java
, etc.) along with metadata from your workspace and appends them into an LLM_doc.txt
file. The extension automatically skips binary or non-readable files.
- Aggregate Files into a Single Document
Append readable text-based files intoLLM_doc.txt
. - Skip Binary or Non-Readable Files
Automatically detects and skips files with binary or non-printable content. - Support for Multiple File Types
Compatible with popular formats like.py
,.md
,.js
,.html
,.java
, and more. - Automatic Creation of
LLM_doc.txt
Automatically creates theLLM_doc.txt
file at the root of your workspace if it doesn’t already exist.
- Right-click on a file or directory within your workspace.
- Select "Append File to LLM Doc" from the context menu.
- The contents of readable files will be appended to a new or existing
LLM_doc.txt
file.
No configuration is required. The extension works automatically with your workspace files.
- Initial release with core features:
- Basic file appending functionality.
- Automatic skipping of binary and non-readable files.
- Auto-creation of
LLM_doc.txt
if it does not exist. - Enhanced error handling for unreadable files.
- Improved notifications for skipped files.
- Open Visual Studio Code.
- Go to the Extensions View by clicking the Extensions icon in the Activity Bar.
- Search for LLM File Companion and click Install.
Run the following command to install the extension:
code --install-extension vscode-llm-file-companion
- Right-click a file or directory in your workspace.
- Select "Append File to LLM Doc" from the context menu.
- The content of readable files will be appended to
LLM_doc.txt
.
- Use the "Open LLM Doc" command to access the
LLM_doc.txt
file where all aggregated content is stored.
Enjoy using vscode-llm-file-companion!
Feel free to share your feedback or report issues.