updated

Author: github-actions[bot]

docs/reference/Commands.md

@@ -5,22 +5,32 @@ title: Commands - Codeception - Documentation
 
 # Console Commands
 
-## Build
+## GenerateHelper
 
-Generates Actor classes (initially Guy classes) from suite configs.
-Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually.
+Creates empty Helper class.
 
-* `codecept build`
-* `codecept build path/to/project`
+* `codecept g:helper MyHelper`
+* `codecept g:helper "My\Helper"`
 
 
 
+## GenerateTest
 
-## Console
+Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
+
+* `codecept g:test Unit User`
+* `codecept g:test Unit "App\User"`
 
-Try to execute test commands in run-time. You may try commands before writing the test.
 
-* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
+
+## Build
+
+Generates Actor classes (initially Guy classes) from suite configs.
+Starting from Codeception 2.0 actor classes are auto-generated. Use this command to generate them manually.
+
+* `codecept build`
+* `codecept build path/to/project`
+
 
 
 
@@ -38,93 +48,27 @@ Usage:
 
 
 
-## GenerateSnapshot
-
-Generates Snapshot.
-Snapshot can be used to test dynamical data.
-If suite name is provided, an actor class will be included into placeholder
-
-* `codecept g:snapshot UserEmails`
-* `codecept g:snapshot Products`
-* `codecept g:snapshot Acceptance UserEmails`
-
-
-
-## GenerateFeature
-
-Generates Feature file (in Gherkin):
-
-* `codecept generate:feature suite Login`
-* `codecept g:feature suite subdir/subdir/login.feature`
-* `codecept g:feature suite login.feature -c path/to/project`
-
-
-
-
-## GherkinSteps
-
-Prints all steps from all Gherkin contexts for a specific suite
-
-{% highlight yaml %}
-codecept gherkin:steps Acceptance
-
-{% endhighlight %}
-
-
-
-## CompletionFallback
-
-
-
-## GenerateStepObject
-
-Generates StepObject class. You will be asked for steps you want to implement.
-
-* `codecept g:stepobject Acceptance AdminSteps`
-* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
-
-
-
-
-## GenerateHelper
-
-Creates empty Helper class.
-
-* `codecept g:helper MyHelper`
-* `codecept g:helper "My\Helper"`
-
-
-
-
-## GenerateEnvironment
-
-Generates empty environment configuration file into envs dir:
-
- * `codecept g:env firefox`
-
-Required to have `envs` path to be specified in `codeception.yml`
-
-
-
-## DryRun
+## ConfigValidate
 
-Shows step-by-step execution process for scenario driven tests without actually running them.
+Validates and prints Codeception config.
+Use it do debug Yaml configs
 
-* `codecept dry-run Acceptance`
-* `codecept dry-run Acceptance MyCest`
-* `codecept dry-run Acceptance checkout.feature`
-* `codecept dry-run tests/Acceptance/MyCest.php`
+Check config:
 
+* `codecept config`: check global config
+* `codecept config Unit`: check suite config
 
+Load config:
 
+* `codecept config:validate -c path/to/another/config`: from another dir
+* `codecept config:validate -c another_config.yml`: from another config file
 
-## GenerateScenarios
+Check overriding config values (like in `run` command)
 
-Generates user-friendly text scenarios from scenario-driven tests (Cest).
+* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle
+* `codecept config:validate -o "settings: lint: false"`: disable linting
+* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter
 
-* `codecept g:scenarios Acceptance` - for all acceptance tests
-* `codecept g:scenarios Acceptance --format html` - in html format
-* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
 
 
 
@@ -221,46 +165,57 @@ Options:
 
 
 
-## ConfigValidate
+## GenerateSuite
 
-Validates and prints Codeception config.
-Use it do debug Yaml configs
+Create new test suite. Requires suite name and actor name
 
-Check config:
+* ``
+* `codecept g:suite Api` -> api + ApiTester
+* `codecept g:suite Integration Code` -> integration + CodeTester
+* `codecept g:suite Frontend Front` -> frontend + FrontTester
 
-* `codecept config`: check global config
-* `codecept config Unit`: check suite config
 
-Load config:
 
-* `codecept config:validate -c path/to/another/config`: from another dir
-* `codecept config:validate -c another_config.yml`: from another config file
 
-Check overriding config values (like in `run` command)
+## Clean
 
-* `codecept config:validate -o "settings: shuffle: true"`: enable shuffle
-* `codecept config:validate -o "settings: lint: false"`: disable linting
-* `codecept config:validate -o "reporters: report: \Custom\Reporter" --report`: use custom reporter
+Recursively cleans `output` directory and generated code.
 
+* `codecept clean`
 
 
 
-## GeneratePageObject
 
-Generates PageObject. Can be generated either globally, or just for one suite.
-If PageObject is generated globally it will act as UIMap, without any logic in it.
 
-* `codecept g:page Login`
-* `codecept g:page Registration`
-* `codecept g:page Acceptance Login`
+## GenerateEnvironment
 
+Generates empty environment configuration file into envs dir:
 
+ * `codecept g:env firefox`
 
-## GenerateGroup
+Required to have `envs` path to be specified in `codeception.yml`
 
-Creates empty GroupObject - extension which handles all group events.
 
-* `codecept g:group Admin`
+
+## Init
+
+
+
+## Console
+
+Try to execute test commands in run-time. You may try commands before writing the test.
+
+* `codecept console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
+
+
+
+## SelfUpdate
+
+Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
+
+* `php codecept.phar self-update`
+
+@author Franck Cassedanne <franck@cassedanne.com>
 
 
 
@@ -280,58 +235,103 @@ By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**
 
 
 
-## Init
+## GenerateStepObject
 
+Generates StepObject class. You will be asked for steps you want to implement.
 
+* `codecept g:stepobject Acceptance AdminSteps`
+* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
 
-## SelfUpdate
 
-Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
 
-* `php codecept.phar self-update`
 
-@author Franck Cassedanne <franck@cassedanne.com>
+## DryRun
 
+Shows step-by-step execution process for scenario driven tests without actually running them.
 
+* `codecept dry-run Acceptance`
+* `codecept dry-run Acceptance MyCest`
+* `codecept dry-run Acceptance checkout.feature`
+* `codecept dry-run tests/Acceptance/MyCest.php`
 
-## GenerateTest
 
-Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 
-* `codecept g:test Unit User`
-* `codecept g:test Unit "App\User"`
 
+## GenerateSnapshot
 
+Generates Snapshot.
+Snapshot can be used to test dynamical data.
+If suite name is provided, an actor class will be included into placeholder
 
-## GenerateCest
+* `codecept g:snapshot UserEmails`
+* `codecept g:snapshot Products`
+* `codecept g:snapshot Acceptance UserEmails`
 
-Generates Cest (scenario-driven object-oriented test) file:
 
-* `codecept generate:cest suite Login`
-* `codecept g:cest suite subdir/subdir/testnameCest.php`
-* `codecept g:cest suite LoginCest -c path/to/project`
-* `codecept g:cest "App\Login"`
 
+## CompletionFallback
 
 
 
-## GenerateSuite
+## GenerateScenarios
 
-Create new test suite. Requires suite name and actor name
+Generates user-friendly text scenarios from scenario-driven tests (Cest).
 
-* ``
-* `codecept g:suite Api` -> api + ApiTester
-* `codecept g:suite Integration Code` -> integration + CodeTester
-* `codecept g:suite Frontend Front` -> frontend + FrontTester
+* `codecept g:scenarios Acceptance` - for all acceptance tests
+* `codecept g:scenarios Acceptance --format html` - in html format
+* `codecept g:scenarios Acceptance --path doc` - generate scenarios to `doc` dir
 
 
 
+## GenerateGroup
 
-## Clean
+Creates empty GroupObject - extension which handles all group events.
 
-Recursively cleans `output` directory and generated code.
+* `codecept g:group Admin`
 
-* `codecept clean`
+
+
+## GeneratePageObject
+
+Generates PageObject. Can be generated either globally, or just for one suite.
+If PageObject is generated globally it will act as UIMap, without any logic in it.
+
+* `codecept g:page Login`
+* `codecept g:page Registration`
+* `codecept g:page Acceptance Login`
+
+
+
+## GherkinSteps
+
+Prints all steps from all Gherkin contexts for a specific suite
+
+{% highlight yaml %}
+codecept gherkin:steps Acceptance
+
+{% endhighlight %}
+
+
+
+## GenerateCest
+
+Generates Cest (scenario-driven object-oriented test) file:
+
+* `codecept generate:cest suite Login`
+* `codecept g:cest suite subdir/subdir/testnameCest.php`
+* `codecept g:cest suite LoginCest -c path/to/project`
+* `codecept g:cest "App\Login"`
+
+
+
+
+## GenerateFeature
+
+Generates Feature file (in Gherkin):
+
+* `codecept generate:feature suite Login`
+* `codecept g:feature suite subdir/subdir/login.feature`
+* `codecept g:feature suite login.feature -c path/to/project`