PHPackages                             artarts36/artisan-documentator - 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. artarts36/artisan-documentator

ActiveLibrary[Utility & Helpers](/categories/utility)

artarts36/artisan-documentator
==============================

Laravel Artisan Documentator

0.3.2(4y ago)063MITPHP

Since Nov 8Pushed 4y ago1 watchersCompare

[ Source](https://github.com/ArtARTs36/php-artisan-documentator)[ Packagist](https://packagist.org/packages/artarts36/artisan-documentator)[ RSS](/packages/artarts36-artisan-documentator/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (9)Versions (13)Used By (0)

Artisan Documentator
====================

[](#artisan-documentator)

This package provides generate documentation about your app console commands.

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

[](#installation)

Run commands:

- `composer require --dev artarts36/artisan-documentator`
- `php artisan vendor:publish --provider="ArtARTs36\ArtisanDocumentator\Providers\ArtisanDocumentatorServiceProvider" --tag=config`

Console commands
----------------

[](#console-commands)

After installation, you can run command `php artisan command:doc {path}`. Example: `php artisan command:doc docs/command.md`

Configuration
-------------

[](#configuration)

You can set command's namespaces in the file: `config/artisan_documentator.php` in section 'namespaces':

```
    'namespaces' => [
        // 'namespace:' => 'title,
        // 'app:' => 'App Commands',
        // 'make:' => 'Laravel make Commands',
    ],
```

Using in CI
-----------

[](#using-in-ci)

In order to use generation in CI you need to specify your login and token in the file in the file: `config/artisan_documentator.php` in section 'git.remotes':

```
    'git' => [
        'dir' => base_path(),
        'remote' => [
            'login' => 'my-name',
            'token' => env('ARTISAN_DOCUMENTATOR_GIT_REMOTE_TOKEN'),
        ],
        'commit' => [
            'message' => '[DOCS] auto-build console documentation',
        ],
    ],
```

Command call in your CI conf file:

`php artisan command:doc docs/command.md --ci`

### Command Description

[](#command-description)

Must fill property `description` in console commands for full documentation.

Use the [PHP CS Fixer rule](https://github.com/ArtARTs36/php-cs-fixer-good-fixers) `PhpCsFixerGoodFixers/laravel_command_no_empty_description` to prevent undescribed commands from entering your repository.

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

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

Every ~8 days

Recently: every ~17 days

Total

10

Last Release

1572d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/8027278?v=4)[Artem Ukrainskii](/maintainers/ArtARTs36)[@ArtARTs36](https://github.com/ArtARTs36)

---

Top Contributors

[![ArtARTs36](https://avatars.githubusercontent.com/u/8027278?v=4)](https://github.com/ArtARTs36 "ArtARTs36 (27 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/artarts36-artisan-documentator/health.svg)

```
[![Health](https://phpackages.com/badges/artarts36-artisan-documentator/health.svg)](https://phpackages.com/packages/artarts36-artisan-documentator)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[tucker-eric/eloquentfilter

An Eloquent way to filter Eloquent Models

1.8k4.8M26](/packages/tucker-eric-eloquentfilter)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M158](/packages/orchestra-canvas)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)[flarum/core

Delightfully simple forum software.

211.3M1.9k](/packages/flarum-core)[laragear/preload

Effortlessly make a Preload script for your Laravel application.

119363.5k](/packages/laragear-preload)

PHPackages © 2026

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