{"id":37012372,"url":"https://github.com/iamsabbiralam/ghost-notes","last_synced_at":"2026-01-14T01:04:47.399Z","repository":{"id":328923010,"uuid":"1117355089","full_name":"iamsabbiralam/ghost-notes","owner":"iamsabbiralam","description":"👻 Transform hidden code tags into a professional dev-diary. Features a sleek dashboard, Git integration, VS Code links, and multi-format exports for Laravel projects.","archived":false,"fork":false,"pushed_at":"2025-12-19T06:27:55.000Z","size":4365,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-19T20:07:20.063Z","etag":null,"topics":["code-analysis","dev-diary","developer-experience","developer-tools","ghost-notes","laravel","laravel-package","package","php","productivity-tool","technical-debt"],"latest_commit_sha":null,"homepage":"","language":"Blade","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iamsabbiralam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-16T07:42:08.000Z","updated_at":"2025-12-19T06:27:58.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/iamsabbiralam/ghost-notes","commit_stats":null,"previous_names":["iamsabbiralam/ghost-notes"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/iamsabbiralam/ghost-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamsabbiralam%2Fghost-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamsabbiralam%2Fghost-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamsabbiralam%2Fghost-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamsabbiralam%2Fghost-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iamsabbiralam","download_url":"https://codeload.github.com/iamsabbiralam/ghost-notes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iamsabbiralam%2Fghost-notes/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28407640,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T00:40:43.272Z","status":"ssl_error","status_checked_at":"2026-01-14T00:40:42.636Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-analysis","dev-diary","developer-experience","developer-tools","ghost-notes","laravel","laravel-package","package","php","productivity-tool","technical-debt"],"created_at":"2026-01-14T01:04:46.615Z","updated_at":"2026-01-14T01:04:47.376Z","avatar_url":"https://github.com/iamsabbiralam.png","language":"Blade","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 👻 GhostNotes - Transform Code Comments into a Dev Diary\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/iamsabbiralam/ghost-notes.svg?style=flat-square)](https://packagist.org/packages/iamsabbiralam/ghost-notes)\n[![Total Downloads](https://img.shields.io/packagist/dt/iamsabbiralam/ghost-notes.svg?style=flat-square)](https://packagist.org/packages/iamsabbiralam/ghost-notes)\n[![License](https://img.shields.io/packagist/l/iamsabbiralam/ghost-notes.svg?style=flat-square)](https://packagist.org/packages/iamsabbiralam/ghost-notes)\n\n![Ghost Notes Preview](src/images/ghost-notes.png)\n\n**GhostNotes** is a powerful Laravel utility that scans your codebase for hidden tags like `@ghost`, `@todo`, or `@fixme` and compiles them into a beautiful, organized developer diary, multi-format reports, and a modern Web Dashboard.\n\n![Dashboard Preview](src/images/dashboard.png)\n\n---\n\n## ✨ Features\n\n- 🔍 **Advanced Tag Scanning:** Automatically finds `@ghost`, `@todo`, `@fixme`, and `@note` with optional **Priority Levels** (high|medium|low).\n- 🎨 **Modern Dashboard:** A sleek, Tailwind-powered dashboard with **Search**, **Priority Badges**, and **Source Code Snippets**.\n- 📊 **Multi-Format Export:** Export your dev-diary into **Markdown**, **JSON**, or **CSV** (Excel compatible).\n- 🏆 **Resolved Graveyard:** Track resolved notes in the \"Resolved Ghosts\" history after clearing them from your code.\n- 🚀 **VS Code \u0026 GitHub Integration:** Open files directly in VS Code from the dashboard or view them on GitHub with line-specific links.\n- 👤 **Git Context:** Automatically identifies the author using `git blame`.\n- 🧹 **Code Cleanup:** Use the `--clear` flag to safely remove tags from source code once they are logged.\n- 🔒 **Safe for Devs:** Dashboard and routes are automatically disabled in production.\n\n---\n\n## 🚀 Installation\n\nInstall the package via composer:\n\n```bash\ncomposer require iamsabbiralam/ghost-notes\n```\nSet up everything with a single command:\n```bash\nphp artisan ghost:install\n```\nThis command publishes the config file and prepares the internal storage.\n\n---\n\n## 🛠 Usage\n1. Adding Tags in Code\nYou can now add priority levels to your tags:\n```bash\n// @ghost:high: Fix this critical security vulnerability\n// @todo:medium: Implement the user profile update logic\n// @fixme:low: Minor alignment issue on the footer\n// @note: This is a general architectural note\n```\n2. Generating the Diary\nRun the command to scan files and update the dashboard cache:\n```bash\nphp artisan ghost:write\n```\n3. Exporting Reports\nGenerate reports in your preferred format:\n```bash\nphp artisan ghost:write --format=markdown\nphp artisan ghost:write --format=json\nphp artisan ghost:write --format=csv\n```\n4. Clearing and Archiving\nLog the notes to the Resolved History and remove them from your code:\n```bash\nphp artisan ghost:write --clear\n```\n\n---\n\n## 🖥 Web Dashboard\nVisit the interactive dashboard at: http://your-app.test/ghost-notes\n\nIn the Dashboard you can:\n* 🔍 Search through notes by author, message, or file name.\n* 🖱️ One-click Open files directly in VS Code.\n* 📦 Download reports as CSV, JSON, or Markdown.\n* 🖨️ Print a clean PDF report of your technical debt.\n* 📜 View History of all resolved/cleared notes.\n\n---\n\n## ⚙️ Configuration\nThe configuration file ```(config/ghost-notes.php)``` allows you to customize:\n```bash\nreturn [\n    'tags' =\u003e ['@ghost', '@todo', '@fixme', '@note'],\n    'filename' =\u003e 'GHOST_LOG.md',\n    'ignore_folders' =\u003e ['vendor', 'node_modules', 'storage', 'tests'],\n    'git_context' =\u003e true,\n    'repo_url' =\u003e env('GHOST_NOTES_REPO_URL', ''), // Auto-detected if empty\n    'default_branch' =\u003e 'main',\n];\n```\n---\n\n## 🤝 Contributing\nContributions are welcome! If you have any ideas, feel free to open an issue or submit a pull request.\n\n---\n\n## 📄 License\nThe MIT License (MIT). Please see License File for more information.\n\nDeveloped by [Sabbir Alam](https://github.com/iamsabbiralam)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamsabbiralam%2Fghost-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiamsabbiralam%2Fghost-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiamsabbiralam%2Fghost-notes/lists"}