Skip to content

Fix #406: Clarify console application setup — template vs. component #407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
samdark merged 2 commits into from
Mar 30, 2026
Merged

Fix #406: Clarify console application setup — template vs. component #407

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d55762e
Initial plan
Copilot Mar 30, 2026
a7e8346
Update console-applications.md: clarify installation vs component
Copilot Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions src/guide/tutorial/console-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,25 @@

Console applications are mainly used to create utility, background processing and maintenance tasks.

To get support for console application in your project, get `yiisoft/yii-console` via composer:
## Getting started

If you're using [yiisoft/app](https://github.com/yiisoft/app) or
[yiisoft/app-api](https://github.com/yiisoft/app-api), console support is already included.
You can access the entry point as:

```
composer require yiisoft/yii-console
./yii
```
Comment on lines +9 to 13
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrasing "You can access the entry point as:" is grammatically awkward for this context. Consider rewording to something like "Run the entry point script:" / "Use the entry point script:" to make the instruction clearer.

Copilot uses AI. Check for mistakes.

After it's installed, you can access the entry point as
If you want a standalone console-only application, use the
[yiisoft/app-console](https://github.com/yiisoft/app-console) project template:

```sh
composer create-project yiisoft/app-console your-project
```
./yii
```

To add console support to an existing project from scratch, refer to the
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"To add console support to an existing project from scratch" reads as contradictory (an existing project vs. from scratch) and may confuse readers. Please rephrase to clarify whether this is about integrating into an existing app (non-template) or starting a new app with manual setup.

Suggested change
To add console support to an existing project from scratch, refer to the
To manually add console support to an existing project, refer to the

Copilot uses AI. Check for mistakes.
[yiisoft/yii-console package documentation](https://github.com/yiisoft/yii-console).

Out of the box only `serve` command is available. It's starting PHP built-in web server to serve the application locally.

Expand Down
Loading