PHPackages                             sami/sami - 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. sami/sami

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

sami/sami
=========

Sami, an API documentation generator

v4.1.2(7y ago)2.0k1.2M↑47.3%283[41 issues](https://github.com/FriendsOfPHP/Sami/issues)20MITPHPPHP ^7.1.3

Since Apr 5Pushed 7y ago2 watchersCompare

[ Source](https://github.com/FriendsOfPHP/Sami)[ Packagist](https://packagist.org/packages/sami/sami)[ Docs](http://sami.sensiolabs.org)[ RSS](/packages/sami-sami/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependencies (12)Versions (45)Used By (20)

Sami: an API documentation generator
====================================

[](#sami-an-api-documentation-generator)

**WARNING**: Sami is not supported nor maintained anymore. Feel free to fork.

Curious about what Sami generates? Have a look at the [Symfony API](http://api.symfony.com/).

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

[](#installation)

Caution!

Sami requires **PHP 7**.

Get Sami as a [phar file](http://get.sensiolabs.org/sami.phar):

```
$ curl -O http://get.sensiolabs.org/sami.phar
```

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

```
$ php sami.phar
```

Note

Installing Sami as a regular Composer dependency is NOT supported. Sami is a tool, not a library. As such, it should be installed as a standalone package, so that Sami's dependencies do not interfere with your project's dependencies.

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

[](#configuration)

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

```