{"id":19325002,"url":"https://github.com/spatie/code-outliner","last_synced_at":"2025-07-06T13:40:19.655Z","repository":{"id":32747366,"uuid":"141413296","full_name":"spatie/code-outliner","owner":"spatie","description":"Generate outline images of your code","archived":false,"fork":false,"pushed_at":"2022-03-21T13:28:12.000Z","size":320,"stargazers_count":82,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-22T20:46:58.821Z","etag":null,"topics":["php","tool"],"latest_commit_sha":null,"homepage":"https://spatie.be/en/opensource","language":"PHP","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/spatie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-18T09:33:47.000Z","updated_at":"2024-02-01T17:02:16.000Z","dependencies_parsed_at":"2022-08-07T18:01:15.467Z","dependency_job_id":null,"html_url":"https://github.com/spatie/code-outliner","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/spatie/code-outliner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fcode-outliner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fcode-outliner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fcode-outliner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fcode-outliner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/spatie","download_url":"https://codeload.github.com/spatie/code-outliner/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/spatie%2Fcode-outliner/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263909199,"owners_count":23528600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["php","tool"],"created_at":"2024-11-10T02:08:32.898Z","updated_at":"2025-07-06T13:40:19.638Z","avatar_url":"https://github.com/spatie.png","language":"PHP","readme":"\n[\u003cimg src=\"https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1\" /\u003e](https://supportukrainenow.org)\n\n# Create a visual representation of your code\n\n[![Latest Version](https://img.shields.io/github/release/spatie/code-outliner.svg?style=flat-square)](https://github.com/spatie/code-outliner/releases)\n[![Quality Score](https://img.shields.io/scrutinizer/g/spatie/code-outliner.svg?style=flat-square)](https://scrutinizer-ci.com/g/spatie/code-outliner)\n[![StyleCI](https://github.styleci.io/repos/141413296/shield?branch=master)](https://github.styleci.io/repos/141413296)\n[![Total Downloads](https://img.shields.io/packagist/dt/spatie/code-outliner.svg?style=flat-square)](https://packagist.org/packages/spatie/code-outliner)\n\nYou're reading code on a daily basis, code should be optimised for that. \nThis tool helps you visualise how the code in your project looks, \nand might be a trigger to better structure your files.\n\nMore information about the visual perception of code here: [https://www.stitcher.io/blog/visual-perception-of-code](https://www.stitcher.io/blog/visual-perception-of-code).\n\n## Support us\n\n[\u003cimg src=\"https://github-ads.s3.eu-central-1.amazonaws.com/code-outliner.jpg?t=1\" width=\"419px\" /\u003e](https://spatie.be/github-ad-click/code-outliner)\n\nWe invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).\n\nWe highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).\n\n## Installation\n\n[spatie/browsershot](https://github.com/spatie/browsershot) is required to generate images. \nPlease refer to the Browsershot documentation for all details, most important is to install puppeteer.\n\n```\nnpm install puppeteer --global\n```\n\nYou can install the package via composer:\n\n```\ncomposer global require spatie/code-outliner\n```\n\n## Usage\n\n```bash\ncode-outliner \u003cfile\u003e [--output=] [--extensions=]\n```\n\n### Outlining a single file\n\nPass a single file to the command, and you'll get output like this.\n\n![Outline of a single file](https://spatie.github.io/code-outliner/outline-single.png)\n\n### Overlaying multiple files\n\nPass a directory path to the command, and it'll overlay all files on top of each other.\nThe darker areas represent areas where there's more code across all files.\n\n![Outline of multiple files](https://spatie.github.io/code-outliner/outline-multiple.png)\n\n### Filtering extensions\n\nBy default, PHP files will be scanned. \nYou're able to specify other and multiple extensions with the `--extensions` option.\n\n```php\ncode-outliner --extensions=\"html,twig\"\n```\n\n### Security\n\nIf you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.\n\n## Postcardware\n\nYou're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.\n\nOur address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.\n\nWe publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).\n\n## Credits\n\n- [Brent Roose](https://github.com/brendt)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fcode-outliner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspatie%2Fcode-outliner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspatie%2Fcode-outliner/lists"}