updated

Author: github-actions[bot]

docs/reference/Commands.md

@@ -5,16 +5,37 @@ title: Commands - Codeception - Documentation
 
 # Console Commands
 
-## DryRun
+## 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`
+
 
-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.
+
 
 
+## GherkinSnippets
+
+Generates code snippets for matched feature files in a suite.
+Code snippets are expected to be implemented in Actor or PageObjects
+
+Usage:
+
+* `codecept gherkin:snippets Acceptance` - snippets from all feature of acceptance tests
+* `codecept gherkin:snippets Acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests
+* `codecept gherkin:snippets Acceptance user_account.feature` - snippets from a single feature file
+* `codecept gherkin:snippets Acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir
+
 
 
 ## GenerateSnapshot
@@ -29,92 +50,81 @@ If suite name is provided, an actor class will be included into placeholder
 
 
 
-## Clean
-
-Recursively cleans `output` directory and generated code.
-
-* `codecept clean`
-
+## 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`
 
-## GenerateTest
 
-Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 
-* `codecept g:test Unit User`
-* `codecept g:test Unit "App\User"`
 
+## GherkinSteps
 
+Prints all steps from all Gherkin contexts for a specific suite
 
-## GenerateHelper
+{% highlight yaml %}
+codecept gherkin:steps Acceptance
 
-Creates empty Helper class.
+{% endhighlight %}
 
-* `codecept g:helper MyHelper`
-* `codecept g:helper "My\Helper"`
 
 
+## CompletionFallback
 
-## 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"`
+## 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
 
 
-## CompletionFallback
 
 
+## GenerateHelper
 
-## ConfigValidate
+Creates empty Helper class.
 
-Validates and prints Codeception config.
-Use it do debug Yaml configs
+* `codecept g:helper MyHelper`
+* `codecept g:helper "My\Helper"`
 
-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
+## GenerateEnvironment
 
-Check overriding config values (like in `run` command)
+Generates empty environment configuration file into envs dir:
 
-* `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:env firefox`
 
+Required to have `envs` path to be specified in `codeception.yml`
 
 
 
-## GherkinSteps
+## DryRun
 
-Prints all steps from all Gherkin contexts for a specific suite
+Shows step-by-step execution process for scenario driven tests without actually running them.
 
-{% highlight yaml %}
-codecept gherkin:steps Acceptance
+* `codecept dry-run Acceptance`
+* `codecept dry-run Acceptance MyCest`
+* `codecept dry-run Acceptance checkout.feature`
+* `codecept dry-run tests/Acceptance/MyCest.php`
 
-{% endhighlight %}
 
 
 
-## GeneratePageObject
+## GenerateScenarios
 
-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.
+Generates user-friendly text scenarios from scenario-driven tests (Cest).
 
-* `codecept g:page Login`
-* `codecept g:page Registration`
-* `codecept g:page Acceptance Login`
+* `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
 
 
 
@@ -211,51 +221,38 @@ Options:
 
 
 
-## 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**.
-
-* `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
-
-
-
-
-## GenerateScenarios
-
-Generates user-friendly text scenarios from scenario-driven tests (Cest).
+## ConfigValidate
 
-* `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
+Validates and prints Codeception config.
+Use it do debug Yaml configs
 
+Check config:
 
+* `codecept config`: check global config
+* `codecept config Unit`: check suite config
 
-## GenerateFeature
+Load config:
 
-Generates Feature file (in Gherkin):
+* `codecept config:validate -c path/to/another/config`: from another dir
+* `codecept config:validate -c another_config.yml`: from another config file
 
-* `codecept generate:feature suite Login`
-* `codecept g:feature suite subdir/subdir/login.feature`
-* `codecept g:feature suite login.feature -c path/to/project`
+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
 
 
 
-## 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.
+## GeneratePageObject
 
-* `codecept build`
-* `codecept build path/to/project`
+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`
 
 
 
@@ -267,17 +264,23 @@ Creates empty GroupObject - extension which handles all group events.
 
 
 
-## Init
+## 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**.
 
-## GenerateEnvironment
+* `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
 
-Generates empty environment configuration file into envs dir:
 
- * `codecept g:env firefox`
 
-Required to have `envs` path to be specified in `codeception.yml`
+
+## Init
 
 
 
@@ -291,36 +294,24 @@ Auto-updates phar archive from official site: 'https://codeception.com/codecept.
 
 
 
-## GherkinSnippets
-
-Generates code snippets for matched feature files in a suite.
-Code snippets are expected to be implemented in Actor or PageObjects
-
-Usage:
-
-* `codecept gherkin:snippets Acceptance` - snippets from all feature of acceptance tests
-* `codecept gherkin:snippets Acceptance/feature/users` - snippets from `feature/users` dir of acceptance tests
-* `codecept gherkin:snippets Acceptance user_account.feature` - snippets from a single feature file
-* `codecept gherkin:snippets Acceptance/feature/users/user_accout.feature` - snippets from feature file in a dir
-
-
-
-## GenerateStepObject
-
-Generates StepObject class. You will be asked for steps you want to implement.
+## GenerateTest
 
-* `codecept g:stepobject Acceptance AdminSteps`
-* `codecept g:stepobject Acceptance UserSteps --silent` - skip action questions
+Generates skeleton for Unit Test that extends `Codeception\TestCase\Test`.
 
+* `codecept g:test Unit User`
+* `codecept g:test Unit "App\User"`
 
 
 
+## GenerateCest
 
-## Console
+Generates Cest (scenario-driven object-oriented test) file:
 
-Try to execute test commands in run-time. You may try commands before writing the test.
+* `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 console Acceptance` - starts acceptance suite environment. If you use WebDriver you can manipulate browser with Codeception commands.
 
 
 
@@ -336,3 +327,12 @@ Create new test suite. Requires suite name and actor name
 
 
 
+## Clean
+
+Recursively cleans `output` directory and generated code.
+
+* `codecept clean`
+
+
+
+