updated

Author: github-actions[bot]

docs/reference/Commands.md

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