Skip to content

Add note about class properties for IO/Args #8233

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
markstory merged 2 commits into from
Feb 21, 2026
Merged

Add note about class properties for IO/Args #8233

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89599a5
Add note about class properties for IO/Args
Feb 20, 2026
d504667
Replace wrong GitHub-style note with proper Vitepress syntax
Feb 20, 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
14 changes: 12 additions & 2 deletions docs/en/console-commands/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ class HelloCommand extends Command
```

Command classes must implement an `execute()` method that does the bulk of
their work. This method is called when a command is invoked. Let's call our first
command application directory, run:
their work. This method is called when a command is invoked. Let's call our
first command. From your application directory, run:

```bash
bin/cake hello
Expand All @@ -48,6 +48,16 @@ You should see the following output:

Hello world.

::: info
The `Arguments` and `ConsoleIo` instances passed to `execute()` are also
available on the command instance as `$this->args` and `$this->io`.
In 6.x, the `execute()` method signature will drop these arguments
and `$this->args` / `$this->io` will be the only way to access
these objects. See the
[6.x command refactor](https://github.com/cakephp/cakephp/pull/18983) for
details.
:::

Our `execute()` method isn't very interesting let's read some input from the
command line:

Expand Down