init

vendor/codeception/base/docs/modules/Cli.md

@@ -0,0 +1,75 @@
+# Cli
+
+
+Wrapper for basic shell commands and shell output
+
+## Responsibility
+* Maintainer: **davert**
+* Status: **stable**
+* Contact: codecept@davert.mail.ua
+
+*Please review the code of non-stable modules and provide patches if you have issues.*
+
+## Actions
+
+### dontSeeInShellOutput
+ 
+Checks that output from latest command doesn't contain text
+
+ * `param` $text
+
+
+
+### runShellCommand
+ 
+Executes a shell command.
+Fails If exit code is > 0. You can disable this by setting second parameter to false
+
+```php
+<?php
+$I->runShellCommand('phpunit');
+
+// do not fail test when command fails
+$I->runShellCommand('phpunit', false);
+```
+
+ * `param` $command
+ * `param bool` $failNonZero
+
+
+### seeInShellOutput
+ 
+Checks that output from last executed command contains text
+
+ * `param` $text
+
+
+### seeResultCodeIs
+ 
+Checks result code
+
+```php
+<?php
+$I->seeResultCodeIs(0);
+```
+
+ * `param` $code
+
+
+### seeResultCodeIsNot
+ 
+Checks result code
+
+```php
+<?php
+$I->seeResultCodeIsNot(0);
+```
+
+ * `param` $code
+
+
+### seeShellOutputMatches
+ 
+ * `param` $regex
+
+<p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.4/src/Codeception/Module/Cli.php">Help us to improve documentation. Edit module reference</a></div>