---

layout: bootstrap

title: Quick Start Codeception

---

<div class="row">

<div class="hero hero--quickstart">

<div class="wide">

<div class="container-fluid">

<div class="row">

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

<h1>

Quickstart

</h1>

</div>

</div>

</div>

</div>

</div>

<div class="wide">

<div class="container-fluid">

<div class="row">

<div class="col-xs-12 col-lg-6 col-lg-offset-3">

<div class="panel panel-info quickstart-panel">

<div class="panel-heading">

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

<a href="/install">Alternative Installations &raquo;</a>

</div>

<div class="panel-body text-center">

<div class="">

Install via Composer

<div class="highlight">

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

</div>

<p>

</div>

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

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

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

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

</div>

<div class="row">

<div class="col-sm-12 col-md-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>php vendor/bin/codecept bootstrap</pre>

</div>

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

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

</p>

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

See Demo

</a>

<div class="collapse" id="bootstrap-demo">

<div class="panel-collapse-body">

<img src="/images/codecept_bootstrap.gif" alt="codeception bootstrap" class="img-responsive">

</div>

</div>

</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>php vendor/bin/codecept generate:cest Acceptance First</pre>

</div>

</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">

<pre>

actor: AcceptanceTester

modules:

enabled:

- PhpBrowser:

url: {YOUR APP'S URL}

- Tests\Support\Helper\Acceptance

</pre>

</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 if your frontpage contains the word <b>Home</b>.</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>php vendor/bin/codecept run --steps</pre>

</div>

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

<a href="https://codeception.com/docs/modules/PhpBrowser">PhpBrowser</a>. It's PHP script that can check HTML page contents, click

links, fill forms, and submit POST and GET requests. For tests that require a real browser (e.g. JavaScript) use

the <a href="https://codeception.com/docs/modules/WebDriver">WebDriver</a> module.</p>

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

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

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

<div class="col-sm-12 col-md-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.

</p>

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

<div class="highlight">

<pre>php vendor/bin/codecept init Acceptance</pre>

</div>

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

See Demo

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

<div class="collapse" id="acceptance-demo">

<div class="panel-collapse-body">

<img src="/images/codecept_acceptance.gif" alt="codeception acceptance" class="img-responsive">

</div>

</div>

<hr>

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

<div class="highlight">

<pre>php vendor/bin/codecept init Api</pre>

</div>

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

See Demo

</a>

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

<div class="collapse" id="api-demo">

<div class="panel-collapse-body">

<img src="/images/codecept_api.gif" alt="codeception api" class="img-responsive">

</div>

</div>

<hr>

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

<div class="highlight">

<pre>php vendor/bin/codecept init Unit</pre>

</div>

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

See Demo

</a>

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

<div class="collapse" id="unit-demo">

<div class="panel-collapse-body">

<img src="/images/codecept_unit.gif" alt="codeception unit" class="img-responsive">

</div>

</div>

</div>

</div>

</div>

<div class="row">

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

<div class="panel panel-success">

<img src="/images/codecept_run.gif" alt="codeception run">

</div>

</div>

<div class="col-sm-12 col-md-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>

</div>

</div>