phploc

Analyze a directory and print the result

$ phploc [path/to/directory]

$ phploc [path/to/directory] --names '[path/to/file1,path/to/file2,...]'

$ phploc [path/to/directory] --names-exclude '[path/to/file1,path/to/file2,...]'

$ phploc [path/to/directory] --exclude [path/to/exclude_directory]

$ phploc [path/to/directory] --log-csv [path/to/file]

$ phploc [path/to/directory] --log-xml [path/to/file]

$ phploc [path/to/directory] --count-tests

phploc [options] <path> [<path> ...]

--help -h
    Display help message.

--quiet -q
    Do not output any message.

--version -V
    Display application version.

--ansi
    Force ANSI output.

--no-ansi
    Disable ANSI output.

--no-interaction -n
    Do not ask interactive questions.

--profile
    Display timing and memory usage.

--verbose -v|-vv|-vvv
    Increase verbosity level.

--configuration= -c
    Read configuration from file.

--count-tests
    Include test code in analysis.

--names=
    Use custom names from file.

--no-configuration
    Ignore default config file.

--progress[=<type>]
    Show progress bar.

--no-progress
    Disable progress output.

--log-json=<file>
    Log JSON report to file.

--log-xml=<file>
    Log XML report to file.

--log-csv=<file>
    Log CSV report to file.

--log-html=<file>
    Log HTML report to file.

phploc is a command-line tool designed to analyze PHP codebases, providing metrics on project size, structure, and complexity. It recursively scans specified directories or files, counting lines of code (physical, logical, executable), comments, blanks, namespaces, interfaces, traits, classes, abstract classes, methods, functions, and more.

It calculates key metrics like average lines per method, cyclomatic complexity (minimum, average, maximum), and lack of cohesion in methods (LCOM). Output is a formatted console report, with options for JSON, XML, CSV, or HTML logs. Ideal for code audits, CI/CD pipelines, and maintaining code quality in PHP projects. Supports modern PHP features and can optionally include test code in analysis.

Analyzes only PHP files (.php, .php5, .phtml, .inc); requires PHP ≥7.3. Ignores non-PHP files and vendor dirs by default in configs. Not suitable for runtime analysis.

Install via Composer: composer global require phploc/phploc. Add ~/.composer/vendor/bin to PATH.
Usage: phploc src tests.

Console shows tables with directories, volumes, complexity, hierarchies, etc. Logs enable parsing in tools like Jenkins.

Developed by Sebastian Bergmann, first released in 2011 as part of PHP QA tools. Evolved to support PHP 8+, integrated into CI workflows. Maintained on GitHub; version 10+ focuses on modern metrics.

php(1), composer(1), phpunit(1)