PHPackages iamsabbiralam/ghost-notes - 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. [Utility & Helpers](/categories/utility) 4. / 5. iamsabbiralam/ghost-notes ActiveLibrary[Utility & Helpers](/categories/utility) iamsabbiralam/ghost-notes ========================= A Laravel package to generate a dev-diary from @ghost tags in your code. v1.1.2(1w ago)26MITPHPPHP ^8.0 Since Dec 16Pushed 1w agoCompare [ Source](https://github.com/iamsabbiralam/ghost-notes)[ Packagist](https://packagist.org/packages/iamsabbiralam/ghost-notes)[ RSS](/packages/iamsabbiralam-ghost-notes/feed)WikiDiscussions main Synced today READMEChangelog (3)Dependencies (2)Versions (7)Used By (0) ๐Ÿ‘ป GhostNotes - Transform Code Comments into a Dev Diary ======================================================= [](#-ghostnotes---transform-code-comments-into-a-dev-diary) [![Latest Version on Packagist](https://camo.githubusercontent.com/f7b387588c4f0faea44c4bda9e4cd7b733748886c95994cf7814caee4b1b04e1/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f69616d736162626972616c616d2f67686f73742d6e6f7465732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/iamsabbiralam/ghost-notes)[![Total Downloads](https://camo.githubusercontent.com/1afd94cd58f9f7f57e14f9c5cdfe61c6e03fdea02d998240ad1e35639cf35c0f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f69616d736162626972616c616d2f67686f73742d6e6f7465732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/iamsabbiralam/ghost-notes)[![License](https://camo.githubusercontent.com/86a2a9904df2442757c7b61c88d9531c8a2d080d628b264b60584a68faf0b983/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f69616d736162626972616c616d2f67686f73742d6e6f7465732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/iamsabbiralam/ghost-notes)[![Laravel Version](https://camo.githubusercontent.com/1f17df5b1a601bc1ece7de06813b43c8b171cc8c655ddebfcb9e05aa38960612/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c61726176656c2d31302e7825323025374325323031312e7825323025374325323031322e782d7265643f7374796c653d666c61742d737175617265266c6f676f3d6c61726176656c)](https://laravel.com) [![Ghost Notes Preview](src/images/ghost-notes.png)](src/images/ghost-notes.png) > ๐Ÿ’ก **Tip for Devs:** Place a beautiful terminal-to-dashboard showcase GIF right here to skyrocket your GitHub Stars! **GhostNotes** is a powerful Laravel utility that scans your codebase for hidden tags like `@ghost`, `@todo`, or `@fixme`, automatically parses their type/priority, and compiles them into a beautiful, organized developer diary, multi-format reports, and a modern two-column Split-View Web Dashboard. [![Dashboard Preview](src/images/dashboard.png)](src/images/dashboard.png) --- โœจ Features ---------- [](#-features) - ๐Ÿ” **Advanced Tag Scanning:** Automatically finds `@ghost`, `@todo`, `@fixme`, and `@note` across multiple directories. - ๐Ÿท๏ธ **Type-Based Classification:** Group your debt into clear buckets using formats like `@ghost:fix`, `@ghost:feature`, or `@ghost:breaking`. - ๐Ÿ“Š **Priority Levels:** Assign critical tasks using priority modifiers (`:high`, `:medium`, `:low`). - ๐ŸŽจ **Premium Split-View Dashboard:** A modern, Telescope-like two-column layout featuring sidebar file navigation, quick searching, and interactive source code snippet expanders. - ๐Ÿ“‹ Multi-Format Export:\*\* Instantly export reports to **Markdown**, **JSON**, or **CSV** (Excel-compatible). - ๐Ÿ† **Resolved Graveyard:** Automatically archives resolved entries into a "Resolved Ghosts" history board after code cleanup. - ๐Ÿš€ **VS Code & GitHub Integration:** One-click links to jump directly to the exact file line inside VS Code or open it on GitHub. - ๐Ÿ‘ค **Git Context Awareness:** Automatically identifies the blame author using local `git blame`. - ๐Ÿงน **Smart Code Cleanup:** Safely strips tags from source files via the `--clear` flag once they are logged. - ๐Ÿ”’ **Safe Environment Protections:** Web dashboard access and route components are automatically disabled in production. --- ๐Ÿ’ป Requirements & Compatibility ---------------------------------- [](#-requirements--compatibility) - **PHP:** `^8.0` - **Laravel Framework:** `10.x`, `11.x`, and `12.x` (Fully Tested & Supported) --- ๐Ÿš€ Installation -------------- [](#-installation) Install the package via composer: ``` composer require iamsabbiralam/ghost-notes ``` Set up everything with a single command: ``` php artisan ghost:install ``` This command publishes the configuration file and prepares internal architecture files. ๐Ÿ› ๏ธ Usage 1. Adding Tags in Code Write clean, organized notes by combining tags, specific types, and priority levels: ``` // Standard tag with category type and priority modifier: // @ghost:feature:high: Implement API authentication system // @ghost:fix: Crashing issue on checkout invoice action // Works perfectly with standard developer tags too: // @todo:medium: Implement the user profile file update logic // @fixme: Minor styling alignment issue on the footer // @note: This is a general architectural context reminder ``` 2. Generating the Diary & Syncing Dashboard Run the compiler command to parse your project codebase and sync the interactive cache: ``` php artisan ghost:write ``` 3. Exporting Reports Generate standard standalone report formats: ``` php artisan ghost:write --format=markdown php artisan ghost:write --format=json php artisan ghost:write --format=csv ``` 4. Clearing and Archiving Log active entries into the Resolved Graveyard history file and strip them out from source files safely: ``` php artisan ghost:write --clear ``` ๐Ÿ–ฅ๏ธ Web Dashboard Visit your interactive local GUI hub at: Inside the Dashboard UI you can: - ๐Ÿ“‚ File Navigator: Select specific controllers/files from the left panel to filter active entries seamlessly. - ๐Ÿ” Smart Live Search: Filter notes on-the-fly by specific author name, category types, messages, or files. - ๐Ÿ–ฑ๏ธ Deep Linking: Open target files directly onto your IDE workspace layout via VS Code protocols. - ๐Ÿ–จ๏ธ Print Reports: Trigger a fully optimized blueprint layout stylesheet to print structured PDF portfolios. โš™๏ธ Configuration Customize scanning scopes inside your published config/ghost-notes.php architecture profile: ``` return [ 'tags' => ['@ghost', '@todo', '@fixme', '@note'], 'filename' => 'GHOST_LOG.md', // Directories to target during scans 'scan_directories' => [ 'app', 'routes', 'resources/views', ], // File target extensions to check 'allowed_extensions' => ['php', 'blade.php', 'js'], 'ignore_folders' => ['vendor', 'node_modules', 'storage', 'tests'], 'git_context' => true, 'repo_url' => env('GHOST_NOTES_REPO_URL', ''), // Auto-detected if empty 'default_branch' => 'main', ]; ``` ๐Ÿค Contributing Contributions are welcome! If you have any ideas, feel free to open an issue or submit a pull request. ๐Ÿ“„ License The MIT License (MIT). Please see the License File for more information. Developed with โค๏ธ by [Sabbir Alam](https://www.github.com/iamsabbiralam) ### Health Score 36 โ€” LowBetter than 79% of packages Maintenance84 Actively maintained with recent releases Popularity7 Limited adoption so far Community6 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~37 days Recently: every ~46 days Total 6 Last Release 12d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/87582364?v=4)[Sabbir Alam](/maintainers/iamsabbiralam)[@iamsabbiralam](https://github.com/iamsabbiralam) --- Top Contributors [![iamsabbiralam](https://avatars.githubusercontent.com/u/87582364?v=4)](https://github.com/iamsabbiralam "iamsabbiralam (33 commits)") --- Tags code-analysisdev-diarydeveloper-experiencedeveloper-toolsghost-noteslaravellaravel-packagepackagephpproductivity-tooltechnical-debt ### Embed Badge ![Health badge](/badges/iamsabbiralam-ghost-notes/health.svg) ``` [![Health](https://phpackages.com/badges/iamsabbiralam-ghost-notes/health.svg)](https://phpackages.com/packages/iamsabbiralam-ghost-notes) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3355.3M346](/packages/psalm-plugin-laravel)[renatomarinho/laravel-page-speed Laravel Page Speed 2.5k1.7M11](/packages/renatomarinho-laravel-page-speed)[illuminate/pagination The Illuminate Pagination package. 12234.1M1.0k](/packages/illuminate-pagination)[illuminate/pipeline The Illuminate Pipeline package. 9349.2M281](/packages/illuminate-pipeline)[illuminate/redis The Illuminate Redis package. 8314.6M375](/packages/illuminate-redis)[spatie/laravel-export Create a static site bundle from a Laravel app 674146.0k6](/packages/spatie-laravel-export) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)