Skip to main content

Extract and merge files from a folder with precision โ€” a lightweight GUI tool for developers and LLM workflows.

Project description

๐Ÿ” Vaultex

Extract what you need. Nothing more.

Vaultex is a lightweight GUI tool that lets you scan a folder and merge all matching files into a single text output โ€” ready to paste into an LLM, a doc, or anywhere you need a full-project snapshot.

The idea is simple: when you're working with a codebase or a collection of files, you often need to quickly gather specific types of files across nested folders. Vaultex gives you precise control over what gets included, what gets skipped, and how the result is organized โ€” all through a clean interface.


โœจ Features

  • ๐Ÿ“‚ Folder picker โ€” browse or paste a path directly
  • ๐Ÿ“„ File type selector โ€” pick from common extensions or add your own
  • ๐ŸŽฏ Whitelist / blacklist filtering โ€” specify exactly which folders and files to include or exclude
  • ๐Ÿ“ฆ File size limit โ€” skip files that are too large
  • ๐Ÿ” Recursive or flat mode โ€” go deep or stay shallow
  • ๐Ÿ”ƒ Sort options โ€” by path, filename, or last modified time
  • ๐Ÿ” Preview before extracting โ€” scan first, extract when ready
  • ๐Ÿ’พ Save to file โ€” optionally write the merged output back to disk
  • ๐Ÿค– Token estimator โ€” rough count to check if output fits your LLM context window

๐Ÿš€ Installation

pip install vaultex

Then launch:

vaultex

Or run directly from source:

git clone https://github.com/gongzhijie535-ctrl/vaultex
cd vaultex
pip install -e .
python -m vaultex

๐Ÿ–ฅ๏ธ Usage

  1. Select a folder using the ๐Ÿ“‚ picker or paste a path
  2. Check the file types you want (.py, .md, .json, etc.)
  3. Expand Filter Options to narrow down by folder or filename
  4. Click ๐Ÿ” Preview to confirm the file list
  5. Click ๐Ÿš€ Extract to merge and view the output

๐Ÿ“ Project Structure

vaultex/
โ”œโ”€โ”€ __init__.py
โ”œโ”€โ”€ __main__.py       # entry point: python -m vaultex
โ”œโ”€โ”€ core.py           # file collection + merging logic
โ””โ”€โ”€ app.py            # Gradio UI

๐Ÿ“ฆ Requirements

  • Python โ‰ฅ 3.10
  • gradio

๐Ÿ‘ค Author

Ian Gong (้พšๆ™บๆฐ) ๐Ÿ“ง gongzhijie535@gmail.com ๐Ÿ™ @gongzhijie535-ctrl


๐Ÿ“„ License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vaultex-0.1.0.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vaultex-0.1.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file vaultex-0.1.0.tar.gz.

File metadata

  • Download URL: vaultex-0.1.0.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for vaultex-0.1.0.tar.gz
Algorithm Hash digest
SHA256 239dc671c19bef83ec21de61ed88d83b5c24b8b9baf9165b0e0778f6290e2d55
MD5 a18ce6a718a39b2401c7c3d23ce86f09
BLAKE2b-256 08a73c9b635e2193eee8ba91d53805f46a61c4444c7fda7d910e93b9c9cf718d

See more details on using hashes here.

File details

Details for the file vaultex-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: vaultex-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for vaultex-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0473b32ae804d8b3be525f29e9d86b966d33af988f8108fab6970eecd165d6d5
MD5 a8a6bd4af99b275f3403f8d4896f8899
BLAKE2b-256 968377d8a3aa07728e8600de9b1bdade6b3107d17ff9dce2ee294567d8f8b138

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page