It displays the given string as the command title. This method is meant to be used only once in a given command, but nothing prevents you to use it repeatedly:

1

$io->title('Lorem ipsum dolor sit amet');

It displays the given string as the title of some command section. This is only needed in complex commands which want to better separate their contents:

1
2
3
4
5
6
7

$io->section('Adding a User');

// ...

$io->section('Generating the Password');

// ...

It displays the given string or array of strings as regular text. This is useful to render help messages and instructions for the user running the command:

1
2
3
4
5
6
7
8
9
10
11

// use simple strings for short messages
$io->text('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long messages
$io->text([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
    'Aenean sit amet arcu vitae sem faucibus porta',
]);

It displays an unordered list of elements passed as an array:

1
2
3
4
5

$io->listing([
    'Element #1 Lorem ipsum dolor sit amet',
    'Element #2 Lorem ipsum dolor sit amet',
    'Element #3 Lorem ipsum dolor sit amet',
]);

It displays the given array of headers and rows as a compact table:

1
2
3
4
5
6
7
8

$io->table(
    ['Header 1', 'Header 2'],
    [
        ['Cell 1-1', 'Cell 1-2'],
        ['Cell 2-1', 'Cell 2-2'],
        ['Cell 3-1', 'Cell 3-2'],
    ]
);

It displays the given array of headers and rows as a compact horizontal table:

1
2
3
4
5
6
7
8

$io->horizontalTable(
    ['Header 1', 'Header 2'],
    [
        ['Cell 1-1', 'Cell 1-2'],
        ['Cell 2-1', 'Cell 2-2'],
        ['Cell 3-1', 'Cell 3-2'],
    ]
);

It displays the given key => value pairs as a compact list of elements:

1
2
3
4
5
6
7
8
9

$io->definitionList(
    'This is a title',
    ['foo1' => 'bar1'],
    ['foo2' => 'bar2'],
    ['foo3' => 'bar3'],
    new TableSeparator(),
    'This is another title',
    ['foo4' => 'bar4']
);

It displays a blank line in the command output. Although it may seem useful, most of the times you won't need it at all. The reason is that every helper already adds their own blank lines, so you don't have to care about the vertical spacing:

1
2
3
4
5

// outputs a single blank line
$io->newLine();

// outputs three consecutive blank lines
$io->newLine(3);

It displays the given string or array of strings as a highlighted admonition. Use this helper sparingly to avoid cluttering command's output:

1
2
3
4
5
6
7
8
9
10
11

// use simple strings for short notes
$io->note('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long notes
$io->note([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
    'Aenean sit amet arcu vitae sem faucibus porta',
]);

Similar to the note() helper, but the contents are more prominently highlighted. The resulting contents resemble an error message, so you should avoid using this helper unless strictly necessary:

1
2
3
4
5
6
7
8
9
10
11

// use simple strings for short caution message
$io->caution('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long caution messages
$io->caution([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
    'Aenean sit amet arcu vitae sem faucibus porta',
]);

It displays a progress bar with a number of steps equal to the argument passed to the method (don't pass any value if the length of the progress bar is unknown):

1
2
3
4
5

// displays a progress bar of unknown length
$io->progressStart();

// displays a 100-step length progress bar
$io->progressStart(100);

It makes the progress bar advance the given number of steps (or 1 step if no argument is passed):

1
2
3
4
5

// advances the progress bar 1 step
$io->progressAdvance();

// advances the progress bar 10 steps
$io->progressAdvance(10);

It finishes the progress bar (filling up all the remaining steps when its length is known):

1

$io->progressFinish();

If your progress bar loops over an iterable collection, use the progressIterate() helper:

1
2
3
4
5

$iterable = [1, 2];

foreach ($io->progressIterate($iterable) as $value) {
    // ... do some work
}

It asks the user to provide some value:

1

$io->ask('What is your name?');

You can pass the default value as the second argument so the user can hit the <Enter> key to select that value:

1

$io->ask('Where are you from?', 'United States');

In case you need to validate the given value, pass a callback validator as the third argument:

1
2
3
4
5
6
7

$io->ask('Number of workers to start', 1, function ($number) {
    if (!is_numeric($number)) {
        throw new \RuntimeException('You must type a number.');
    }

    return (int) $number;
});

It's very similar to the ask() method but the user's input will be hidden and it cannot define a default value. Use it when asking for sensitive information:

1

$io->askHidden('What is your password?');

In case you need to validate the given value, pass a callback validator as the second argument:

1
2
3
4
5
6
7

$io->askHidden('What is your password?', function ($password) {
    if (empty($password)) {
        throw new \RuntimeException('Password cannot be empty.');
    }

    return $password;
});

It asks a Yes/No question to the user and it only returns true or false:

1

$io->confirm('Restart the web server?');

You can pass the default value as the second argument so the user can hit the <Enter> key to select that value:

1

$io->confirm('Restart the web server?', true);

It asks a question whose answer is constrained to the given list of valid answers:

1

$io->choice('Select the queue to analyze', ['queue1', 'queue2', 'queue3']);

You can pass the default value as the third argument so the user can hit the <Enter> key to select that value:

1

$io->choice('Select the queue to analyze', ['queue1', 'queue2', 'queue3'], 'queue1');

It displays the given string or array of strings highlighted as a successful message (with a green background and the [OK] label). It's meant to be used once to display the final result of executing the given command, but you can use it repeatedly during the execution of the command:

1
2
3
4
5
6
7
8
9
10

// use simple strings for short success messages
$io->success('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long success messages
$io->success([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
]);

It's similar to the success() method (the given string or array of strings are displayed with a green background) but the [OK] label is not prefixed. It's meant to be used once to display the final result of executing the given command, without showing the result as a successful or failed one:

1
2
3
4
5
6
7
8
9
10

// use simple strings for short info messages
$io->info('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long info messages
$io->info([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
]);

It displays the given string or array of strings highlighted as a warning message (with a red background and the [WARNING] label). It's meant to be used once to display the final result of executing the given command, but you can use it repeatedly during the execution of the command:

1
2
3
4
5
6
7
8
9
10

// use simple strings for short warning messages
$io->warning('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long warning messages
$io->warning([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
]);

It displays the given string or array of strings highlighted as an error message (with a red background and the [ERROR] label). It's meant to be used once to display the final result of executing the given command, but you can use it repeatedly during the execution of the command:

1
2
3
4
5
6
7
8
9
10

// use simple strings for short error messages
$io->error('Lorem ipsum dolor sit amet');

// ...

// consider using arrays when displaying long error messages
$io->error([
    'Lorem ipsum dolor sit amet',
    'Consectetur adipiscing elit',
]);