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

Abandoned → [sugared-rim/sami](/?search=sugared-rim%2Fsami)Library

schnittstabil/sugared-sami
==========================

Sami sweetened with ease

0.5.0(8y ago)2281MITPHPPHP >=7

Since Apr 8Pushed 8y ago1 watchersCompare

[ Source](https://github.com/schnittstabil/sugared-sami)[ Packagist](https://packagist.org/packages/schnittstabil/sugared-sami)[ RSS](/packages/schnittstabil-sugared-sami/feed)WikiDiscussions master Synced 1mo ago

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

SugaredRim\\Sami [![Build Status](https://camo.githubusercontent.com/237a83cef7acc85f466dec6f2c1920de73082199706efcf00642835e295ce8cf/68747470733a2f2f7472617669732d63692e6f72672f737567617265642d72696d2f73616d692e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/sugared-rim/sami) [![Coverage Status](https://camo.githubusercontent.com/2cd3e6777c2416e6eec5d9d1d2de51b6d1900e39ee0e1abb2f8b8406c8525c6e/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f737567617265642d72696d2f73616d692f62616467652e7376673f6272616e63683d6d617374657226736572766963653d676974687562)](https://coveralls.io/github/sugared-rim/sami?branch=master) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/75c6dde4f3e47fea5b1067f01791c57f7ad6b136e825015af23d1ab8f268efff/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f737567617265642d72696d2f73616d692f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/sugared-rim/sami/?branch=master) [![Code Climate](https://camo.githubusercontent.com/19f29fc320c3e3df06a16d12172bfd45c6db487b27f7d1117215fb01fe179746/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f737567617265642d72696d2f73616d692f6261646765732f6770612e737667)](https://codeclimate.com/github/sugared-rim/sami)
================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#sugaredrimsami----)

[![SensioLabsInsight](https://camo.githubusercontent.com/7971d16a2ac2b338758fe25a23d13f26680ffb8ac7403376874a5167d4c022f0/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f31343934396364392d366461332d343731662d616664382d3239323735326565636338662f6269672e706e67)](https://insight.sensiolabs.com/projects/14949cd9-6da3-471f-afd8-292752eecc8f)

> Sami sweetened with ease 🍒

SugaredRim\\Sami takes an opinionated view of generating documentation with [Sami](https://github.com/FriendsOfPHP/Sami), it is preconfigured to get you up and running as quickly as possible.

Install
-------

[](#install)

```
$ composer require --dev sugared-rim/sami

```

Usage
-----

[](#usage)

Instead of creating a configuration file and running `sami.phar update /path/to/config.php`, just run `sugared-rim-sami` - that's it:

```
{
    ...
    "require-dev": {
        "sugared-rim/sami": ...
    },
    "scripts": {
        "doc": "sugared-rim-sami"
    }
}
```

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

[](#configuration)

You may overwrite some options by putting it in your `composer.json`.

Some of the default settings:

```
{
    ...
    "scripts": {
        "doc": "sugared-rim-sami"
    },
    "extra": {
        "sugared-rim/sami": {
            "files": "src",
            "filter": "SugaredRim\\Sami\\ProtectedFilter",
            "build_dir": "build/sami",
            "cache_dir": "build/cache/sami"
        }
    }
}
```

All `extra.sugared-rim/sami` options are passed through the [Sami constructor](https://github.com/FriendsOfPHP/Sami#configuration), except:

- `filter`: A FQCN of the filter to use, `sugared-rim-sami` will create an instance for you.

License
-------

[](#license)

MIT © [Michael Mayer](http://schnittstabil.de)

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity11

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity57

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 ~81 days

Recently: every ~101 days

Total

6

Last Release

3274d ago

PHP version history (2 changes)0.1.1PHP >=5.6.0

0.5.0PHP >=7

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/6059032?v=4)[Michael Mayer](/maintainers/schnittstabil)[@schnittstabil](https://github.com/schnittstabil)

---

Top Contributors

[![schnittstabil](https://avatars.githubusercontent.com/u/6059032?v=4)](https://github.com/schnittstabil "schnittstabil (6 commits)")

---

Tags

phpdocsamisugaredpreconfiguredsugared-rim

### Embed Badge

![Health badge](/badges/schnittstabil-sugared-sami/health.svg)

```
[![Health](https://phpackages.com/badges/schnittstabil-sugared-sami/health.svg)](https://phpackages.com/packages/schnittstabil-sugared-sami)
```

###  Alternatives

[phpdocumentor/reflection-common

Common reflection classes used by phpdocumentor to reflect the code structure

9.1k706.8M26](/packages/phpdocumentor-reflection-common)[barryvdh/laravel-ide-helper

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

14.9k123.0M683](/packages/barryvdh-laravel-ide-helper)[symfony/property-info

Extracts information about PHP class' properties using metadata of popular sources

2.2k256.7M851](/packages/symfony-property-info)[phpdocumentor/phpdocumentor

Documentation Generator for PHP

4.4k3.1M874](/packages/phpdocumentor-phpdocumentor)[symfony/type-info

Extracts PHP types information.

19751.9M114](/packages/symfony-type-info)[phpdocumentor/reflection

Reflection library to do Static Analysis for PHP Projects

12521.4M108](/packages/phpdocumentor-reflection)

PHPackages © 2026

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