(( gitHubWatchers )) (( gitHubStars )) (( gitHubForks ))

phpDox is a documentation generator for PHP projects.

This includes, but is not limited to, API documentation.


Install from a Git repository (with Git)

Make sure you have git and Composer and all dependencies ext-xsl installed.

Git clone the repository:
git clone git://
Change into the new directory:
cd phpdox
Install the project dependencies:
composer install
Run it:
php phpdox

Install from a PHP Archive (with curl or wget)

The PHPUnit documentation has a clear manual on how to install PHARs on Windows.

If you have the Suhosin extension enabled, make sure to allow the execution of PHARs in your php.ini:
suhosin.executor.include.whitelist = phar

Make sure all dependencies are installed: ext-xsl.

Locally (X.X.X)

Download it:
wget -O phpdox-X.X.X.phar
curl -sSL -o phpdox-X.X.X.phar
Use it:
php phpdox-X.X.X.phar

Globally (X.X.X)

Download it:
wget -O phpdox-X.X.X.phar
curl -sSL -o phpdox-X.X.X.phar
Install it as an executable:
chmod a+x phpdox-X.X.X.phar
sudo mv phpdox-X.X.X.phar /usr/local/bin/phpdox-X.X.X
Use it: