---

layout: bootstrap

title: Codeception Installation

---

<div class="container">

<div class="page-header">

<div class="pull-right well">

<h4>Requirements</h4>

<strong>

<div>PHP 5.6+</div>

<div>CURL enabled</div>

</strong>

</div>

<h1>Installation</h1>

</div>

<div class="row">

<div class="col-sm-8 col-lg-8">

<div class="well">

<div class="pull-right">

&nbsp;

<a class="btn btn-lg btn-warning" href="/quickstart">QuickStart Guide &rarr;</a>

</div>

<h4>Follow QuickStart Guide to Install and execute your first test in 6 easy

steps.

</h4>

</div>

</div>

</div>

<div class="row">

<div class="col-sm-6 col-lg-6">

<div class="page">

<h3>Composer <small><i>(recommended)</i></small></h3>

<p>Install a <a href="http://getcomposer.org">Composer</a> to your project's root</p>

<p>Run</p>

<div class="highlight">

<pre><code>composer require codeception/codeception --dev</code></pre>

</div>

<p>From now on Codeception (with installed PHPUnit) can be run as:</p>

<div class="highlight">

<pre><code>php vendor/bin/codecept</code></pre>

</div>

<p>Initialize your testing environment with</p>

<div class="highlight">

<pre><code>php vendor/bin/codecept bootstrap</code></pre>

</div>

<h3>Minimal Codeception</h3>

<p>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`</p>

<p>Prepare tests directory and configs</p>

<div class="highlight">

<pre><code>composer require codeception/base --dev</code></pre>

</div>

</div>

</div>

<div class="col-sm-6 col-lg-6">

<h3>Phar</h3>

{% include phar.html %}

</div>

</div>

<hr>

<div class="row page">

<h3>Git</h3>

<p>Alternative installation method for bugfixing, contributions and hacking</p>

<p>

Clone from GitHub:

</p>

<div class="highlight">

<pre><code>git clone git@github.com:Codeception/Codeception.git && cd Codeception</code></pre>

</div>

<p>

Install dependencies with Composer

</p>

<div class="highlight">

<pre><code>composer install</code></pre>

</div>

<p>

Execute bootstrap, specifying path to your directory.

</p>

<div class="highlight">

<pre><code>php codecept bootstrap /path/to/demo/project</code></pre>

</div>

<p>

To <strong>run tests</strong> use <code>-c</code> option for specifing path.

</p>

<div class="highlight">

<pre><code>php codecept run -c /path/to/demo/project</code></pre>

</div>

<p>If you want to build phar package you need to install <a href="http://robo.li">Robo Task Runner</a> and execute

</p>

<div class="highlight">

<pre><code>robo build:phar</code></pre>

</div>

<p>To generate documentation files run</p>

<div class="highlight">

<pre><code>robo build:docs</code></pre>

</div>

</p>

<p>Don't forget to send Pull Requests!</p>

</div>

</div> <!-- /.container -->