# FriendsOfPHP/Sami

An API documentation generator

Repository: https://github.com/FriendsOfPHP/Sami
Canonical: https://ross.abutalabs.com/products/sami
Language: PHP
License: MIT
License Family: permissive
Archived: true
Last push: 2018-09-13T16:44:29+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 5223, "days_push": 2911, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases, archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1967, forks 280 (observed 2026-08-28T04:05:59.954480+00:00)

## What it is
Sami is a PHP API documentation generator that parses PHP source code and produces static HTML documentation, famously used for the Symfony API docs. It supports versioned documentation from Git tags and configurable themes.

## Use cases
- generate API documentation from PHP source code
- create versioned docs for multiple releases of a PHP library
- produce static HTML class reference like the Symfony API
- document a PHP project from Git tags and branches

## When to choose
- you maintain a legacy PHP 7 project already configured with Sami
- you want Symfony-style API documentation with Git version support

## When to avoid
- starting a new PHP documentation project - it is officially unmaintained
- you need PHP 8 support or active community support
- consider alternatives like phpDocumentor or Doctum instead

## Facets
- artifact type: cli-tool
- maturity: abandoned
- function: documentation, api-documentation, parser
- domain: documentation, developer-tools
- platform: cli, php, cross-platform
- tags: api-docs, php-documentation, static-html-output, deprecated, php

## Member repositories
- FriendsOfPHP/Sami (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:59.954480+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:05:13.141189+00:00, confidence not recorded.
  - readme: https://github.com/FriendsOfPHP/Sami (fetched 2026-08-28T04:05:59.954480+00:00, sha 42958202ed75)
- Data as of 2026-08-30T08:39:29.467469+00:00.