---

layout: bootstrap

title: Quick Start Codeception

---

</div></div>

<div class="hero" style="background-image: url(/images/backgrounds/quickstart.jpg); height: 50vh; min-height: 400px; ">

<div class="wide">

<div class="container-fluid">

<div class="row">

<div class="col-lg-12 col-sm-12 text-center">

<h1>Codeception<br> Quickstart Guide</h1>

</div>

</div>

</div>

<div class="wide">

<div class="container-fluid">

<div class="row">

<div class="col-xs-12 col-lg-8">

<div class="panel panel-info">

<div class="panel-heading">

<a href="/install" style="float: right">Alternative Installations &raquo;</a>

<h4 class="panel-title">1. Install</h4></div>

<div class="panel-body">

<div class="">

<p class="lead">Install via Composer</p>

<div class="highlight">

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

</div>

<p>

Execute it as

<code>./vendor/bin/codecept</code></p>

</div>

{% include phar.html %}

<a class="" role="button" data-toggle="collapse" href="#phar-global" aria-expanded="false" aria-controls="collapseExample">

<!-- <p>Use <code>codecept</code> instead of codecept.phar in this case.</p> -->

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

</div> <!-- /.col -->

<div class="col-sm-12 col-lg-4">

<h3>Quick Start For</h3>

{% include for.html %}

<div class="row">

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

<div class="panel panel-info">

<div class="panel-heading"><h4 class="panel-title">2. Setup</h4></div>

<div class="panel-body">

<p>Execute:</p>

<div class="highlight">

<p>

<pre>codecept bootstrap</pre>

</p>

</div>

<p class="text-muted">This creates configuration file

<b>codeception.yml</b> and <b>tests</b> directory and default test suites.

Acceptance, functional, unit test suites are created as well.

</p>

<a class="btn btn-primary" role="button" data-toggle="collapse" href="#bootstrap-demo" aria-expanded="false" aria-controls="collapseExample">

See Demo

<p class="collapse" id="bootstrap-demo"><img src="/images/codecept_bootstrap.gif" alt=""></p>

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

<div class="panel panel-info">

<div class="panel-heading"><h4 class="panel-title">3. Create Test</h4></div>

<div class="panel-body">

<p>Generate your first acceptance test. Acceptance tests emulate behavior

of a real user visiting your site.</p>

<div class="highlight">

<p>

<pre>codecept generate:cest acceptance First</pre>

</p>

</div>

<p class="text-muted">Codeception scenario tests are called Cepts.</p>

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

<div class="panel panel-info">

<div class="panel-heading"><h4 class="panel-title">4. Configure Acceptance Tests</h4></div>

<div class="panel-body">

<p>Please make sure your local

<b>development server</b> is running. &nbsp;Put application URL into:&nbsp;

<b>tests/acceptance.suite.yml</b>&nbsp;</p>

<div class="highlight">

actor: AcceptanceTester

modules:

enabled:

- PhpBrowser:

url: {YOUR APP'S URL}

- \Helper\Acceptance

</div>

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

<div class="panel panel-info">

<div class="panel-heading">

<h4 class="panel-title">5. Write a Basic Test</h4>

</div>

<div class="panel-body">

<p>It's now time to write your first test. Edit the file we've just created

<b>tests/acceptance/FirstCest.php</b>

</p>

<div>

{% highlight php %}

<?php

class FirstCest

{

public function frontpageWorks(AcceptanceTester $I)

{

$I->amOnPage('/');

$I->see('Home');

}

}

{% endhighlight %}

</div>

<p class="text-muted">It will check that your frontpage contains the word <b>Home</b> in it.</p>

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

<div class="panel panel-info">

<div class="panel-heading"><h4 class="panel-title">6. Run!</h4></div>

<div class="panel-body">

<p>Tests are executed with 'run' command</p>

<div class="highlight">

<p>

<pre>codecept run --steps</pre>

</p>

</div>

<p class="text-muted">This will execute our Welcome test with

<b>PhpBrowser</b>. It's PHP script that can check HTML page contents, click

links, fill forms, and submit POST and GET requests. For more complex tests

that require a browser use Selenium with

<b>WebDriver</b> module.</p>

</div> <!-- /.panel-body -->

</div> <!-- /.panel -->

</div> <!-- /.row -->

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

<div class="page">

<h3>Simplified Setup</h3>

<p>Use predefined installation templates for common use cases.

Run them instead of <code>bootstrap</code> command.

<h4>Acceptance Testing (only)</h4>

<div class="highlight">

<pre>codecept init acceptance</pre>

<a class="btn btn-primary" role="button" data-toggle="collapse" href="#acceptance-demo" aria-expanded="false" aria-controls="collapseExample">

See Demo

</a> <a href="/docs/03-AcceptanceTests" class="btn btn-secondary">Acceptance Testing Guide &raquo;</a>

<p class="collapse" id="acceptance-demo"><img src="/images/codecept_acceptance.gif" alt=""></p>

<h4>REST API Testing (only)</h4>

<div class="highlight">

<pre>codecept init api</pre>

<a class="btn btn-primary" role="button" data-toggle="collapse" href="#api-demo" aria-expanded="false" aria-controls="collapseExample">

See Demo

<a href="/docs/10-WebServices#REST" class="btn btn-secondary">REST API Testing Guide &raquo;</a>

<p class="collapse" id="api-demo"><img src="/images/codecept_api.gif" alt=""></p>

<h4>Unit Testing (only)</h4>

<div class="highlight">

<pre>codecept init unit</pre>

<a class="btn btn-primary" role="button" data-toggle="collapse" href="#unit-demo" aria-expanded="false" aria-controls="collapseExample">

See Demo

<a href="/docs/05-UnitTests" class="btn btn-secondary">Unit Testing Guide &raquo;</a>

<p class="collapse" id="unit-demo"><img src="/images/codecept_unit.gif" alt=""></p>

<div class="row">

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

<div class="panel panel-success">

<img src="/images/codecept_run.gif" style="width:100%;" alt="">

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

<div class="page">

<h4>&raquo; Next!</h4>

<p>Read Codeception Guides to learn how to use it.</p>

<div class="list-group">

<a class="list-group-item active" href="/docs/02-GettingStarted">A Complete Getting Started Guide</a>

<a class="list-group-item" href="/docs/03-AcceptanceTests">Continue with Acceptance Tests</a>

<a class="list-group-item" href="/docs/01-Introduction">The difference &nbsp;between Acceptance Tests and Unit Tests</a>

</div>

</div>

</div>

</div>