Yii Console Runner
[](https://packagist.org/packages/yiisoft/yii-runner-console)
[](https://packagist.org/packages/yiisoft/yii-runner-console)
[](https://github.com/yiisoft/yii-runner-console/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/yii-runner-console)
[](https://github.com/yiisoft/yii-runner-console/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/yii-runner-console)
The package contains a bootstrap for running Yii3 console application.
## Requirements
- PHP 8.0 - 8.5.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/yii-runner-console
```
## General usage
In your console entry script do the following:
```php
#!/usr/bin/env php
run();
```
### Additional configuration
By default, the `ConsoleApplicationRunner` is configured to work with Yii application templates and follows the
[config groups convention](https://github.com/yiisoft/docs/blob/master/022-config-groups.md).
You can override the default configuration using constructor parameters and immutable setters.
#### Constructor parameters
`$rootPath` — the absolute path to the project root.
`$debug` — whether the debug mode is enabled.
`$checkEvents` — whether check events' configuration.
`$environment` — the environment name.
`$bootstrapGroup` — the bootstrap configuration group name.
`$eventsGroup` — the events' configuration group name.
`$diGroup` — the container definitions' configuration group name.
`$diProvidersGroup` — the container providers' configuration group name.
`$diDelegatesGroup` — the container delegates' configuration group name.
`$diTagsGroup` — the container tags' configuration group name.
`$paramsGroup` — the config parameters group name.
`$nestedParamsGroups` — configuration group names that are included into config parameters group. This is needed for
recursive merge parameters.
`$nestedEventsGroups` — configuration group names that are included into events' configuration group. This is needed for
reverse and recursive merge events' configurations.
#### Immutable setters
If the configuration instance settings differ from the default you can specify a customized configuration instance:
```php
/**
* @var Yiisoft\Config\ConfigInterface $config
* @var Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner $runner
*/
$runner = $runner->withConfig($config);
```
The default container is `Yiisoft\Di\Container`. But you can specify any implementation
of the `Psr\Container\ContainerInterface`:
```php
/**
* @var Psr\Container\ContainerInterface $container
* @var Yiisoft\Yii\Runner\Console\ConsoleApplicationRunner $runner
*/
$runner = $runner->withContainer($container);
```
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Console Runner is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)