PHPackages                             xul/laravel-project-map - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. xul/laravel-project-map

ActiveLibrary[Testing & Quality](/categories/testing)

xul/laravel-project-map
=======================

Laravel package for generating project structure maps

v1.0.0(1mo ago)21↑2900%MITPHPPHP ^8.2CI passing

Since Mar 24Pushed 1mo agoCompare

[ Source](https://github.com/Xultech-LTD/laravel-project-map)[ Packagist](https://packagist.org/packages/xul/laravel-project-map)[ RSS](/packages/xul-laravel-project-map/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (4)Versions (2)Used By (0)

Laravel Project Map
===================

[](#laravel-project-map)

 **Generate clean, configurable maps of your Laravel project structure.**

 [ ![Tests](https://camo.githubusercontent.com/5cf917b16b33fab21a29d781f89601980893550b3494ced3b0abb1df27a887f0/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f58756c746563682d4c54442f6c61726176656c2d70726f6a6563742d6d61702f74657374732e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265) ](https://github.com/Xultech-LTD/laravel-project-map/actions) [ ![Latest Version](https://camo.githubusercontent.com/1bdec99dfb6852d98d42c51d97d07b2f64522afdce2c16c494609fde80c20fb0/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f78756c2f6c61726176656c2d70726f6a6563742d6d61703f7374796c653d666c61742d737175617265) ](https://packagist.org/packages/xul/laravel-project-map) [ ![PHP Version](https://camo.githubusercontent.com/0ea38866162a826952e5516f6872a5415ad292bb002de3f79ffc88a639aca371/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f78756c2f6c61726176656c2d70726f6a6563742d6d61703f7374796c653d666c61742d737175617265) ](https://packagist.org/packages/xul/laravel-project-map) [ ![Laravel Versions](https://camo.githubusercontent.com/8a3c018f78999b51383ef38b65c4769977a27e6e559002d79de179cd639adb90/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c61726176656c2d31312532307c25323031322532307c25323031332d7265643f7374796c653d666c61742d737175617265) ](https://packagist.org/packages/xul/laravel-project-map) [ ![License](https://camo.githubusercontent.com/8b358689a7a2a9eef36e7ea03e4a3e90c1d340917485898900f58bd96b9f6450/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f58756c746563682d4c54442f6c61726176656c2d70726f6a6563742d6d61703f7374796c653d666c61742d737175617265) ](LICENSE.md)

📌 Overview
----------

[](#-overview)

**Laravel Project Map** is a developer-focused tool for generating a structured view of your application's filesystem.

It helps you:

- visualize your project structure
- audit large codebases
- inspect architecture quickly
- generate shareable project maps (text or JSON)

⚡ Features
----------

[](#-features)

- Artisan command: `project:map`
- Recursive directory mapping
- Configurable depth
- Include/exclude files
- Hidden file support
- Vendor & node\_modules toggles
- JSON and text output formats
- Save output to file
- Fully tested (Pest)

📦 Installation
--------------

[](#-installation)

```
composer require xul/laravel-project-map
```

⚙️ Publish Configuration (Optional)
-----------------------------------

[](#️-publish-configuration-optional)

```
php artisan vendor:publish --tag=project-map-config
```

🚀 Usage
-------

[](#-usage)

### Basic

[](#basic)

```
php artisan project:map
```

### Include files

[](#include-files)

```
php artisan project:map --files
```

### Limit depth

[](#limit-depth)

```
php artisan project:map --depth=2
```

### Include vendor and node\_modules

[](#include-vendor-and-node_modules)

```
php artisan project:map --vendor --node-modules
```

### Include hidden files

[](#include-hidden-files)

```
php artisan project:map --hidden
```

### Output as JSON

[](#output-as-json)

```
php artisan project:map --format=json
```

### Save output to file

[](#save-output-to-file)

```
php artisan project:map --save=project-map.txt
```

### Combine options

[](#combine-options)

```
php artisan project:map --files --depth=3 --vendor --format=json --save=map.json
```

### 🧾 Example Output

[](#-example-output)

#### Text Output

[](#text-output)

```
project-root/
├── app/
│   ├── Http/
│   └── Models/
├── routes/
│   └── web.php
└── config/

```

#### JSON Output

[](#json-output)

```
[
    {
        "name": "app",
        "type": "directory",
        "path": "/project/app",
        "children": [...]
    }
]
```

⚙️ Configuration
----------------

[](#️-configuration)

```