PHPackages                             code-lts/doctum - 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. [API Development](/categories/api)
4. /
5. code-lts/doctum

ActiveApplication[API Development](/categories/api)

code-lts/doctum
===============

Doctum, a PHP API documentation generator. Fork of Sami

v5.6.0(3mo ago)35077.9k↑79.2%41[12 issues](https://github.com/code-lts/doctum/issues)20MITPHPPHP ^8.1CI passing

Since Jul 18Pushed 1mo ago4 watchersCompare

[ Source](https://github.com/code-lts/doctum)[ Packagist](https://packagist.org/packages/code-lts/doctum)[ Docs](https://github.com/code-lts/doctum)[ GitHub Sponsors](https://github.com/sponsors/williamdes)[ Fund](https://tidelift.com/funding/github/packagist/code-lts/doctum)[ RSS](/packages/code-lts-doctum/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (16)Versions (21)Used By (20)

Doctum, a PHP API documentation generator. Fork of Sami
=======================================================

[](#doctum-a-php-api-documentation-generator-fork-of-sami)

Curious about what Doctum generates? Have a look at the [MariaDB MySQL Kbs](https://williamdes.github.io/mariadb-mysql-kbs/) or [Laravel](https://laravel.com/api/master/index.html) documentation.

Our badges
----------

[](#our-badges)

[![GitHub marketplace action](https://camo.githubusercontent.com/b2fc03518290d05e422d984877bc20b63e57e4f4d932ad715a077edf645d8707/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4769744875622532306d61726b6574706c616365253230616374696f6e2d617661696c61626c652d677265656e2e737667)](https://github.com/marketplace/actions/action-doctum)[![Project code coverage by Codecov](https://camo.githubusercontent.com/460f194e990d67b9a9c2a0a9ec5085d2fadd50dfaf5b4026e9c199eb9de3fee5/68747470733a2f2f636f6465636f762e696f2f67682f636f64652d6c74732f646f6374756d2f6272616e63682f6d61696e2f67726170682f62616467652e7376673f6272616e63683d6d61696e)](https://codecov.io/gh/code-lts/doctum)[![Project test suite](https://github.com/code-lts/doctum/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/code-lts/doctum/actions/workflows/tests.yml)Installation
------------

[](#installation)

Caution!

Doctum requires **PHP 8.1** or later.

Get Doctum as a [phar file](https://doctum.long-term.support/releases/latest/doctum.phar):

```
$ curl -O https://doctum.long-term.support/releases/latest/doctum.phar
```

You can also find some alternative phar versions:

- `major`
- `major`. `minor` (any version since 5.1)
- `major`. `minor`. `patch`
- [latest](https://doctum.long-term.support/releases/latest/doctum.phar)
- [dev](https://doctum.long-term.support/releases/dev/doctum.phar) (not always up to date)
- `major`-dev
- `major`. `minor`-dev (most of the time it exists)
- `major`. `minor`. `patch`-dev (sometimes it exists)

```
$ curl -O https://doctum.long-term.support/releases/${version}/doctum.phar && chmod +x doctum.phar
```

Check that everything worked as expected by executing the `doctum.phar` file without any arguments:

```
$ doctum.phar
```

Since 5.3.0 the phar does not require to use php keyword anymore because the shebang was added to the phar file. You can now call doctum.phar directly after adding execution rights onto the file.

You can use our [GitHub marketplace action](https://github.com/marketplace/actions/action-doctum) into your GitHub CI.

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

[](#configuration)

Before generating documentation, you must create a configuration file. Here is the simplest possible one:

```