Download the PHP package mapali/codex-dump without Composer
On this page you can find all versions of the php package mapali/codex-dump. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mapali/codex-dump
More information about mapali/codex-dump
Files in mapali/codex-dump
Package codex-dump
Short Description Export all PHP files in a Laravel codebase into a single file for AI ingestion or analysis.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package codex-dump
Codex Dump for Laravel
Codex Dump is a Laravel package designed to consolidate and export your project's PHP source files into a single structured text file. This streamlined output serves as optimized context input for AI-driven code assistance tools like ChatGPT, Codex, or similar systems.
Features
- Selective Export: Define directories and file types to include or exclude.
- Token Management: Prevents exceeding AI token limits by providing token estimations and configurable maximum limits.
- Persistent History: Remembers previously used directories and file paths for rapid reuse.
- Interactive CLI: Offers intuitive prompts for quick and accurate configuration.
- Automatic File Structure: Clearly documents the exported file structure for easy AI interpretation.
Installation
Install using Composer:
Publish the configuration (optional):
Configuration
By default, the package exports all .php files, excluding commonly ignored directories (vendor, node_modules, .git, storage). Customize these options via config/codex-dump.php:
ignore_dirs: Directories to skip.extensions: File extensions to include.default_output: Default path for the exported text file.max_tokens: Maximum allowed tokens to ensure compatibility with AI models.
Usage
To export your project's codebase, run:
You'll be interactively prompted for:
- Base directory: Directory path to scan (default: current directory).
- Output file path: Path for the resulting
.txtfile.
The package will then:
- Calculate the estimated token usage.
- Validate against configured token limits.
- Generate a neatly structured
.txtfile containing your project's files, clearly delineated for optimal AI ingestion.
Example output structure:
Recommended Use
Codex Dump streamlines preparing codebases for AI-assisted development. It is ideal for:
- Providing comprehensive context to AI coding assistants like ChatGPT.
- Quick reference exports for structured AI interactions.
- Facilitating efficient onboarding and understanding of large codebases.
Testing
The package includes comprehensive tests to ensure reliability:
Contributing
Contributions are welcome. Please submit pull requests or issues directly to the GitHub repository.
License
Codex Dump is released under the MIT License.
