Follow QuickStart Guide to Install and execute your first test in 6 easy steps.

Composer (recommended)

Install a Composer to your project's root


composer require codeception/codeception --dev

From now on Codeception (with installed PHPUnit) can be run as:

php vendor/bin/codecept

Initialize your testing environment with

php vendor/bin/codecept bootstrap

Minimal Codeception

Currently Codeception installs Webdriver and Guzzle libraries as dependencies. If you don't plan to do acceptance testing, you can get minimal installation of Codeception by requiring `codeception/base`

Prepare tests directory and configs

composer require codeception/base --dev



Execute it as php codecept.phar


Execute it as php codecept.phar

sudo curl -LsS -o /usr/local/bin/codecept
sudo chmod a+x /usr/local/bin/codecept

Execute it as codecept


Alternative installation method for bugfixing, contributions and hacking

Clone from GitHub:

git clone [email protected]:Codeception/Codeception.git && cd Codeception

Install dependencies with Composer

composer install

Execute bootstrap, specifying path to your directory.

php codecept bootstrap /path/to/demo/project

To run tests use -c option for specifing path.

php codecept run -c /path/to/demo/project

If you want to build phar package you need to install Robo Task Runner and execute

robo build:phar

To generate documentation files run

robo build:docs

Don't forget to send Pull Requests!

Not sure what to test?

Let your users tell you!

Turn user feedback into tests

with Bugira Bugtracker