install.html

---
layout: bootstrap
title: Codeception Installation
---
<div class="container">
  <div class="page-header">
    <div class="pull-right well">
      <h4>Requirements</h4>
      <strong>
        <div>PHP 5.3</div>
        <div>CURL enabled</div>
      </strong>
    </div>
    <h1>Installation</h1>
  </div>
  <div class="row">
    <div class="col-sm-8 col-lg-8">
      <div class="page-header">
        <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="well">
        <h3>Phar</h3>
        <a class="btn btn-lg btn-success" href="/thanks"><span class="btn-label">Download Codeception</span></a>
        <p>Alternatively download it from console</p>
        <div>
          <p>
            <pre><code>wget http://codeception.com/codecept.phar</code></pre>
          </p>
        </div>
        <p><a href="http://codeception.com/php54/codecept.phar">Download phar for for PHP 5.4 and PHP < 5.5.9</a></p>
        <p>For PHP 5.3 <a href="/builds">use the latest version of Codeception 1.8.x</a></p>
        <p>Prepare tests directory and configs</p>
        <div>
          <p>
            <pre><code>php codecept.phar bootstrap</code></pre>
          </p>
        </div>
      </div>
    </div>
    <div class="col-sm-6 col-lg-6">
      <div>
        <h3>Composer</h3>
        <p>Install a <a href="http://getcomposer.org">Composer</a> to your project's root</p>
        <p>Run</p>
        <p>
          <pre><code>php composer.phar require "codeception/codeception:*"</code></pre>
        </p>
        <p>From now on Codeception (with installed PHPUnit) can be run as:</p>
        <p>
          <pre><code>php vendor/bin/codecept</code></pre>
        </p>
        <p>Initialize your testing environment with</p>
        <p>
          <pre><code>php vendor/bin/codecept bootstrap</code></pre>
        </p>
        <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>
      </div>
      <p><a href="http://codeception.com/php54/codecept.phar">Download phar for PHP 5.4 and 5.5</a></p>
      <p>For PHP 5.3 <a href="/builds">use the latest version of Codeception 1.8.x</a></p>


      <p>Prepare tests directory and configs</p>
      <div>
        <p>
          <pre><code>php composer.phar require "codeception/base:*" --dev</code></pre>
        </p>
      </div>
    </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>
    <pre><code>git clone git@github.com:Codeception/Codeception.git</code></pre>
    <p>
      Install dependencies with Composer
    </p>
    <p>
      <pre><code>cd Codeception
        curl -s http://getcomposer.org/installer | php
        php composer.phar install</code></pre>
      </p>
      <p>
        Execute bootstrap, specifying path to your directory.
      </p>
      <pre><code>php codecept bootstrap /path/to/my/project</code></pre>
      <p>
        To <strong>run tests</strong> use <code>-c</code> option for specifing path.
      </p>
      <pre><code>php codecept run -c /path/to/my/project</code></pre>
      <p>If you want to build phar package you need to install <a href="http://robo.li">Robo Task Runner</a> and execute
        <code>robo build:phar</code>
      </p>
    </p>
    <p>Don't forget to send Pull Requests!</p>
  </div>
</div> <!-- /.container -->