Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.64 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.64 KB
Raw

Folder Mapper

.txt outcome of a mapped folder .txt outcome of a mapped folder

Folder Mapper is a tool to generate snapshots of a folder structure. It's the perfect tool for providing AI agents with a project overview or sharing your project's architecture with team members.

🔽 Download the VSCode Extension from the Marketplace: Folder Mapper

Features

  • 🆓 Free Forever: No premium features, everything is included for free.
  • 📊 Text-Based Mapping: Generate a detailed map of your folder structure in a .txt format.
  • 💡 Token Cost Estimation: Estimates the token cost of the output when given to AI as a prompt.
  • 🔍 Depth Control: Focus on specific project levels by setting a mapping depth limit.
  • 🚫 Smart Exclusions: Automatically exclude files and directories using custom ignore files.
  • ⚡ Efficient Performance: Fast mapping, even for large projects.
  • 🖥️ User-Friendly Interface: Sleek, sidebar interface for easy navigation.
  • 🎨 Theme-Aware Design: UI adapts to match your VS Code theme.
  • 📘 Integrated Guide: In-depth documentation to help you explore each feature.

How to Use

  1. Open the Folder Mapper sidebar in VS Code.
  2. Click "Select Folder to Map" to choose the folder you want to map.
  3. (Optional) Click "Select Output Folder" to choose where to save the map file.
  4. (Optional) Set the "Depth Limit" if you want to restrict the mapping depth (0 for unlimited).
  5. (Optional) Select an ignore file from the dropdown menu to exclude specific files or directories.
  6. (Optional) Toggle the "AI-Optimized Structure" option for a more compact output suitable for AI language models.
  7. Click "Start Mapping" to generate the folder structure map.
  8. Refer to the "Guide" tab for detailed explanations of each feature.

Folder Mapper in action: Folder Mapper Demo

Requirements

This extension requires Visual Studio Code version 1.93.0 or higher.

Extension Settings

Folder Mapper works out of the box with no additional configuration required!

Known Issues

There are no known issues at this time. If you encounter any problems, please report them on our GitHub issues page.

New in Version 1.9

  • Token cost comparison feature: now shows the difference between current and previous mapping token costs
  • Visual indicators for token cost changes (green for decreases, red for increases)

License

This extension is released under the MIT License.