infopixel/laravel-project-snapshot

Exports a Laravel project snapshot (tree + code bundle) into a single markdown file.

Maintainers

Package info

github.com/BeastFromPretoriaEast/LaravelProjectSnapshot

pkg:composer/infopixel/laravel-project-snapshot

Statistics

Installs: 8

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v0.1.0 2025-12-14 00:09 UTC

This package is auto-updated.

Last update: 2026-03-14 01:09:45 UTC


README

πŸ“Έ A workaround for full project .zip file upload limitations by AI-powered language models (LLM).

It generates a single, lightweight snapshot of your project β€” a fraction of the size of the full codebase, that can be uploaded to your LLM of choice, allowing the AI to understand your architecture and code and collaborate with you effectively.

Export a Laravel project snapshot (file tree + source code) into a single Markdown file**, designed specifically for AI analysis, code review, auditing, and architecture discussions. It was specifically designed to solve the common problem of uploading large full-project .zip files directly into AI-powered language models. Instead of uploading entire projects, this tool produces a **single, structured Markdown file that preserves project context, hierarchy, and source code, making it ideal for ChatGPT, LLMs, and automated review pipelines.

This package generates a safe, readable, deterministic snapshot of your project without binaries, without vendor noise, and with automatic secret redaction.

πŸ“¦ Installation (dev only)

composer require --dev infopixel/laravel-project-snapshot

▢️ Command line

php artisan snapshot

✨ Features

  • 🧠 Optimized for ChatGPT / LLM ingestion
  • βœ… Single-file snapshot (project.snapshot.md)
  • 🌳 Clean, readable file tree with depth
  • πŸ”’ Secret scrubbing (JWTs, API keys, Bearer tokens, private keys)
  • 🚫 Will not upload files containing sensitive data like .sqlite,.sql,.db, etc. (unless explicitly permitted via yourself in the configuration)
  • 🚫 Automatically excludes sensitive files (.env,., OAuth keys, etc.)
  • πŸ“¦ Whitelist-based file inclusion (no binaries)
  • πŸ§ͺ Dev-only safe (won’t run in production)
  • ⏳ Console progress bar
  • 🧾 Rich snapshot metadata block
  • βš™οΈ Fully configurable

πŸ“¦ Screenshots

Command line

Command line snapshot example

project.snapshot.md (Metadata)

Snapshot metadata example

project.snapshot.md (File Display)

Snapshot file display example

File Size (project.snapshot.md)

Snapshot file size example

🚨 Important Safety Notice

This package is intended for development environments only.

  • Installed via require-dev
  • Refuses to run in production
  • Explicitly excludes sensitive files
  • Redacts secrets even if accidentally committed