PHPackages                             thewoods96/doc-shamer - 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. [CLI & Console](/categories/cli)
4. /
5. thewoods96/doc-shamer

ActiveLibrary[CLI & Console](/categories/cli)

thewoods96/doc-shamer
=====================

A basic Laravel Artisan command to check an OpenAPI spec against application API routes to summarise doc coverage

1.0.0(2y ago)013.4k↓47%MITPHPPHP ^7.4|^8.0

Since Nov 16Pushed 2y ago1 watchersCompare

[ Source](https://github.com/thewoods96/doc-shamer)[ Packagist](https://packagist.org/packages/thewoods96/doc-shamer)[ Docs](https://github.com/thewoods96/doc-shamer)[ RSS](/packages/thewoods96-doc-shamer/feed)WikiDiscussions main Synced 1mo ago

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

Doc Shamer
==========

[](#doc-shamer)

[![Latest Version on Packagist](https://camo.githubusercontent.com/00cb98a7161b30669a0433efa6c3f544faeb965d841612404715f595a3d772f7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f746865776f6f647339362f646f632d7368616d65722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/thewoods96/doc-shamer)[![Total Downloads](https://camo.githubusercontent.com/10368a9685fe3d759cb4ddcc4d247200e87879be2f5347521053f4d02a85ac11/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f746865776f6f647339362f646f632d7368616d65722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/thewoods96/doc-shamer)

A basic Laravel Artisan command to check an OpenAPI spec against application API routes to summarise doc coverage.

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require thewoods96/doc-shamer
```

Usage
-----

[](#usage)

**Usage:**

```
$ php artisan doc-shamer [options] [arguments]
```

#### Options:

[](#options)

\--show-coverage: Output tables detailing documented, missing and ignored routes

\--dry-run: When set to true the command will always exit with status 0 regardless of doc coverage.

### Testing

[](#testing)

```
composer test
```

### Changelog

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Connor Woods](https://github.com/thewoods96)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Laravel Package Boilerplate
---------------------------

[](#laravel-package-boilerplate)

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

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

Unknown

Total

1

Last Release

915d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/354ea36dc6333427f4ec7e2579b72d14c70fb4a0ad7d17b397a5c6e382a37ccf?d=identicon)[thewoods96](/maintainers/thewoods96)

---

Top Contributors

[![thewoods96](https://avatars.githubusercontent.com/u/10032197?v=4)](https://github.com/thewoods96 "thewoods96 (3 commits)")

---

Tags

thewoods96doc-shamer

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/thewoods96-doc-shamer/health.svg)

```
[![Health](https://phpackages.com/badges/thewoods96-doc-shamer/health.svg)](https://phpackages.com/packages/thewoods96-doc-shamer)
```

###  Alternatives

[laravel/sail

Docker files for running a basic Laravel application.

1.9k186.9M1.0k](/packages/laravel-sail)[nunomaduro/laravel-console-menu

Laravel Console Menu is an output method for your Laravel/Laravel Zero commands.

815412.0k48](/packages/nunomaduro-laravel-console-menu)[orchestra/canvas

Code Generators for Laravel Applications and Packages

20917.2M158](/packages/orchestra-canvas)[laravel/roster

Detect packages & approaches in use within a Laravel project

15510.4M7](/packages/laravel-roster)[ryangjchandler/orbit

A flat-file database driver for Eloquent.

922256.2k5](/packages/ryangjchandler-orbit)[fumeapp/modeltyper

Generate TypeScript interfaces from Laravel Models

196277.9k](/packages/fumeapp-modeltyper)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)