The Exakat Engine : smart static analysis for PHP
Latest commit b805b3c Dec 18, 2018

README.md

Exakat

The Exakat Engine is an automated code reviewing engine for PHP.

Installation

Installation with the phar

Phar is the recommended installation process.

The Exakat engine is distributed as a phar archive, that contains all the needed PHP code. The rest of the installation (NGremlin-server) is detailled in the documentation.

The quick installation guide is the following (command line, MacOS. See docs for more options):

mkdir exakat
cd exakat
curl -o exakat.phar http://dist.exakat.io/index.php?file=latest
curl -o apache-tinkerpop-gremlin-server-3.2.6-bin.zip http://ftp.tudelft.nl/apache/tinkerpop/3.2.6/apache-tinkerpop-gremlin-server-3.2.6-bin.zip
unzip apache-tinkerpop-gremlin-server-3.2.6-bin.zip
mv apache-tinkerpop-gremlin-server-3.2.6 tinkergraph
rm -rf apache-tinkerpop-gremlin-server-3.2.6-bin.zip

# Optional : install neo4j engine.
cd tinkergraph
bin/gremlin-server.sh -i org.apache.tinkerpop neo4j-gremlin 3.2.6
cd ..

php exakat.phar doctor

Run online

Projects smaller than 1k lines of code may be tested online, with the most recent version of exakat.

Contribute

See CONTRIBUTING.md for information on how to contribute to the Exakat engine.

Changelog

See Changelog.txt for information on how to contribute to the Exakat engine.