updated

Author: github-actions[bot]

docs/reference/Commands.md

@@ -5,17 +5,6 @@ title: Commands - Codeception - Documentation
 
 # Console Commands
 
-## GherkinSteps
-
-Prints all steps from all Gherkin contexts for a specific suite
-
-{% highlight yaml %}
-codecept gherkin:steps Acceptance
-
-{% endhighlight %}
-
-
-
 ## GenerateStepObject
 
 Generates StepObject class. You will be asked for steps you want to implement.
@@ -26,20 +15,21 @@ Generates StepObject class. You will be asked for steps you want to implement.
 
 
 
-## Bootstrap
+## GenerateHelper
 
-Creates default config, tests directory and sample suites for current project.
-Use this command to start building a test suite.
+Creates empty Helper class.
 
-By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
+* `codecept g:helper MyHelper`
+* `codecept g:helper "My\Helper"`
 
-* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
-* `codecept bootstrap --empty` - creates `tests` dir without suites
-* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers.
-* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
-* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
 
 
+## GenerateGroup
+
+Creates empty GroupObject - extension which handles all group events.
+
+* `codecept g:group Admin`
+
 
 
 ## GherkinSnippets
@@ -56,6 +46,62 @@ Usage:
 
 
 
+## Clean
+
+Recursively cleans `output` directory and generated code.
+
+* `codecept clean`
+
+
+
+
+## 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.
+
+
+
+## CompletionFallback
+
+
+
+## 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`
+
+
+
+
+## GenerateScenarios
+
+Generates user-friendly text scenarios from scenario-driven tests (Cest).
+
+* `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
+
+
+
+## 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"`
+
+
+
+
 ## Run
 
 Executes tests.
@@ -149,24 +195,18 @@ Options:
 
 
 
-## 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"`
-
-
-
+## Bootstrap
 
-## GenerateHelper
+Creates default config, tests directory and sample suites for current project.
+Use this command to start building a test suite.
 
-Creates empty Helper class.
+By default, it will create 3 suites **Acceptance**, **Functional**, and **Unit**.
 
-* `codecept g:helper MyHelper`
-* `codecept g:helper "My\Helper"`
+* `codecept bootstrap` - creates `tests` dir and `codeception.yml` in current dir.
+* `codecept bootstrap --empty` - creates `tests` dir without suites
+* `codecept bootstrap --namespace Frontend` - creates tests, and use `Frontend` namespace for actor classes and helpers.
+* `codecept bootstrap --actor Wizard` - sets actor as Wizard, to have `TestWizard` actor in tests.
+* `codecept bootstrap path/to/the/project` - provide different path to a project, where tests should be placed
 
 
 
@@ -193,16 +233,6 @@ Starting from Codeception 2.0 actor classes are auto-generated. Use this command
 
 
 
-## GenerateEnvironment
-
-Generates empty environment configuration file into envs dir:
-
- * `codecept g:env firefox`
-
-Required to have `envs` path to be specified in `codeception.yml`
-
-
-
 ## SelfUpdate
 
 Auto-updates phar archive from official site: 'https://codeception.com/codecept.phar' .
@@ -213,103 +243,85 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept.
 
 
 
-## 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`
-
-
-
-
-## ConfigValidate
-
-Validates and prints Codeception config.
-Use it do debug Yaml configs
-
-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
-
-Check overriding config values (like in `run` command)
+## GherkinSteps
 
-* `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
+Prints all steps from all Gherkin contexts for a specific suite
 
+{% highlight yaml %}
+codecept gherkin:steps Acceptance
 
+{% endhighlight %}
 
 
-## Init
 
+## GenerateSuite
 
+Create new test suite. Requires suite name and actor name
 
-## CompletionFallback
+* ``
+* `codecept g:suite Api` -> api + ApiTester
+* `codecept g:suite Integration Code` -> integration + CodeTester
+* `codecept g:suite Frontend Front` -> frontend + FrontTester
 
 
 
-## GenerateScenarios
 
-Generates user-friendly text scenarios from scenario-driven tests (Cest).
+## GenerateEnvironment
 
-* `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
+Generates empty environment configuration file into envs dir:
 
+ * `codecept g:env firefox`
 
+Required to have `envs` path to be specified in `codeception.yml`
 
-## 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.
+## Init
 
 
 
-## Clean
+## GenerateTest
 
-Recursively cleans `output` directory and generated code.
+Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 
-* `codecept clean`
+* `codecept g:test Unit User`
+* `codecept g:test Unit "App\User"`
 
 
 
+## DryRun
 
-## GenerateSuite
+Shows step-by-step execution process for scenario driven tests without actually running them.
 
-Create new test suite. Requires suite name and actor name
+* `codecept dry-run Acceptance`
+* `codecept dry-run Acceptance MyCest`
+* `codecept dry-run Acceptance checkout.feature`
+* `codecept dry-run tests/Acceptance/MyCest.php`
 
-* ``
-* `codecept g:suite Api` -> api + ApiTester
-* `codecept g:suite Integration Code` -> integration + CodeTester
-* `codecept g:suite Frontend Front` -> frontend + FrontTester
 
 
 
+## ConfigValidate
 
-## GenerateGroup
+Validates and prints Codeception config.
+Use it do debug Yaml configs
 
-Creates empty GroupObject - extension which handles all group events.
+Check config:
 
-* `codecept g:group Admin`
+* `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
 
-## GenerateTest
+Check overriding config values (like in `run` command)
 
-Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
+* `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:test Unit User`
-* `codecept g:test Unit "App\User"`
 
 
 
@@ -324,15 +336,3 @@ Generates Feature file (in Gherkin):
 
 
 
-## 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`
-
-
-