Symfony Console

https://github.com/symfony/console
Admin
Symfony Console is a PHP library that eases the creation of beautiful, testable, and robust command...
Tokens:141,580
Snippets:1,061
Trust Score:9.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get raw list of commands

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Outputs a raw list of commands, which is useful for embedding a command runner.

```bash
%%PHP_BINARY%% %%PHP_SELF%% list --raw
```

--------------------------------

### Get raw command list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run2.txt

Outputs a raw list of commands, which is useful for embedding in a command runner.

```bash
app/console list --raw
```

--------------------------------

### Run shell completion tests directly

Source: https://github.com/symfony/console/blob/8.2/Tests/shell-completion/README.md

Execute completion tests using shells installed on the local machine. Requires running composer install in the Console component first; missing shells are automatically skipped.

```bash
Tests/shell-completion/run.sh
Tests/shell-completion/run.sh bash
```

--------------------------------

### Display help in XML format

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Outputs the help information in XML format using the --format option.

```bash
%%PHP_BINARY%% %%PHP_SELF%% help --format=xml list
```

--------------------------------

### help

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.rst

The help command displays help for a given command. It supports outputting help in various formats and raw text.

```APIDOC
## help

### Description
Display help for a command.

### Usage
`help [--format FORMAT] [--raw] [--] [<command_name>]`

### Arguments
- **command_name** (string) - Optional - The name of the command to display help for.

### Options
- **--format** (string) - Required - The output format (txt, xml, json, or md). Default: 'txt'.
- **--raw** (boolean) - Optional - To output raw command help. Default: false.
```

--------------------------------

### Display help in XML format

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run5.txt

Outputs the help information for a command in XML format using the --format option.

```bash
app/console help --format=xml list
```

--------------------------------

### List all commands

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Lists all available commands using the list command.

```bash
%%PHP_BINARY%% %%PHP_SELF%% list
```

--------------------------------

### Display help for a command

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.md

The help command displays help for a given command. You can also output the help in other formats by using the --format option.

```text
%%PHP_BINARY%% %%PHP_SELF%% help list
```

```text
%%PHP_BINARY%% %%PHP_SELF%% help --format=xml list
```

--------------------------------

### Display help for a command

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Displays help for a specific command using the help command.

```bash
%%PHP_BINARY%% %%PHP_SELF%% help list
```

--------------------------------

### List commands for a namespace

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Displays commands belonging to a specific namespace.

```bash
%%PHP_BINARY%% %%PHP_SELF%% list test
```

--------------------------------

### help

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Displays help information for a specific command. Users can specify the command name and choose an output format.

```APIDOC
## help

### Description
Display help for a command.

### Usage
help [--format FORMAT] [--raw] [--] [<command_name>]

### Arguments
- **command_name** - Optional - The name of the command to display help for.

### Options
- **--format** (string) - Optional - The output format (txt, xml, json, or md). Default: 'txt'.
- **--raw** (boolean) - Optional - To output raw command help.
```

--------------------------------

### List commands in XML format

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Outputs the list of commands in XML format using the --format option.

```bash
%%PHP_BINARY%% %%PHP_SELF%% list --format=xml
```

--------------------------------

### Display help for a command

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run5.txt

Displays the help information for a specific command using the help command.

```bash
app/console help list
```

--------------------------------

### help

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.md

Displays help information for a specific command. Supports output in various formats like txt, xml, json, or md.

```APIDOC
## help

### Description
Display help for a command.

### Usage
help [--format FORMAT] [--raw] [--] [<command_name>]

### Arguments
- **command_name** (string) - Optional - The command name.

### Options
- **--format** (string) - Required - The output format (txt, xml, json, or md).
- **--raw** (boolean) - Optional - To output raw command help.
```

--------------------------------

### help

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Displays help information for a specific command. Users can specify the command name and choose an output format.

```APIDOC
## help

### Description
Display help for a command.

### Usage
help [--format FORMAT] [--raw] [--] [<command_name>]

### Arguments
- **command_name** (string) - Optional - The name of the command to display help for.

### Options
- **--format** (string) - Optional - The output format (txt, xml, json, or md). Default: 'txt'.
- **--raw** (boolean) - Optional - To output raw command help.
```

--------------------------------

### List all commands

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run2.txt

Displays the list of all available commands in the application.

```bash
app/console list
```

--------------------------------

### help

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.md

The help command displays help information for a specific command. It supports outputting help in various formats like txt, xml, json, or md.

```APIDOC
## help

### Description
Display help for a command.

### Usage
help [--format FORMAT] [--raw] [--] [<command_name>]

### Arguments
- **command_name** (string) - Optional - The command name.

### Options
- **--format** (string) - Optional - The output format (txt, xml, json, or md).
- **--raw** (boolean) - Optional - To output raw command help.
```

--------------------------------

### help [options] [--] [<command_name>]

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run5.txt

The help command displays help information for a specified command. It supports various output formats and verbosity levels.

```APIDOC
## help [options] [--] [<command_name>]

### Description
Display help for a command. If no command name is provided, it defaults to the help command.

### Arguments
- **command_name** (string) - Optional - The command name to display help for [default: "help"]

### Options
- **--format** (string) - Optional - The output format (txt, xml, json, or md) [default: "txt"]
- **--raw** (flag) - Optional - To output raw command help
- **-h, --help** (flag) - Optional - Display help for the given command
- **--silent** (flag) - Optional - Do not output any message
- **-q, --quiet** (flag) - Optional - Only errors are displayed
- **-V, --version** (flag) - Optional - Display this application version
- **--ansi|--no-ansi** (flag) - Optional - Force or disable ANSI output
- **-n, --no-interaction** (flag) - Optional - Do not ask any interactive question
- **-v|vv|vvv, --verbose** (flag) - Optional - Increase the verbosity of messages
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.rst

The list command lists all available commands. It can be filtered by namespace and supports different output formats.

```APIDOC
## list

### Description
List commands.

### Usage
`list [--raw] [--format FORMAT] [--short] [--] [<namespace>]`

### Arguments
- **namespace** (string) - Optional - The namespace to filter commands by.

### Options
- **--raw** (boolean) - Optional - To output raw command list. Default: false.
- **--format** (string) - Required - The output format (txt, xml, json, or md). Default: 'txt'.
- **--short** (boolean) - Optional - To skip describing commands' arguments. Default: false.
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.rst

Lists all available commands or commands within a specific namespace. Supports various output formats and raw output.

```APIDOC
## list

### Description
List commands.

### Usage
list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

### Arguments
- **namespace** - Optional - The namespace to filter commands by.

### Options
- **--raw** (boolean) - Optional - To output raw command list.
- **--format** (string) - Optional - The output format (txt, xml, json, or md). Default: 'txt'.
- **--short** (boolean) - Optional - To skip describing commands' arguments.
```

--------------------------------

### descriptor:command1

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Executes command 1.

```APIDOC
## descriptor:command1

### Description
command 1 description

### Usage
descriptor:command1
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Lists all available commands in the application. Supports filtering by namespace and various output formats.

```APIDOC
## list

### Description
List commands.

### Usage
list [--raw] [--format FORMAT] [--short] [--] [<namespace>]

### Arguments
- **namespace** (string) - Optional - The namespace to filter commands by.

### Options
- **--raw** (boolean) - Optional - To output raw command list.
- **--format** (string) - Optional - The output format (txt, xml, json, or md). Default: 'txt'.
- **--short** (boolean) - Optional - To skip describing commands' arguments.
```

--------------------------------

### Output command list in XML format

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run2.txt

Uses the --format option to output the command list in XML format.

```bash
app/console list --format=xml
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.md

The list command displays all available commands in the application. It supports filtering by namespace and outputting in various formats.

```APIDOC
## list

### Description
Lists all commands available in the application. You can optionally filter by namespace or change the output format.

### Arguments
- **namespace** (string) - Optional - The namespace name to filter commands.

### Options
- **--raw** (boolean) - Optional - Output raw command list.
- **--format** (string) - Optional - The output format (txt, xml, json, or md).
- **--short** (boolean) - Optional - Skip describing commands' arguments.
- **--help|-h** (boolean) - Optional - Display help for the command.
- **--silent** (boolean) - Optional - Do not output any message.
- **--quiet|-q** (boolean) - Optional - Only errors are displayed.
- **--verbose|-v|-vv|-vvv** (boolean) - Optional - Increase the verbosity of messages.
- **--version|-V** (boolean) - Optional - Display this application version.
- **--ansi|--no-ansi** (boolean) - Optional - Force or disable ANSI output.
- **--no-interaction|-n** (boolean) - Optional - Do not ask any interactive question.
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.md

The list command displays all available commands. It supports filtering by namespace and outputting in various formats.

```APIDOC
## list

### Description
Lists all available commands. Optionally filter by namespace or change the output format.

### Arguments
- **namespace** (string) - Optional - The namespace name to filter commands.

### Options
- **--raw** (boolean) - Optional - Output raw command list.
- **--format** (string) - Optional - The output format (txt, xml, json, or md).
- **--short** (boolean) - Optional - Skip describing commands' arguments.
```

--------------------------------

### descriptor:command4

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Executes command 4.

```APIDOC
## descriptor:command4

### Usage
descriptor:command4
```

--------------------------------

### descriptor:command1

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.md

Executes command 1.

```APIDOC
## descriptor:command1

### Description
Executes command 1. This command also supports aliases: alias1, alias2.
```

--------------------------------

### completion

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_1.md

The completion command dumps the shell completion script. It allows users to generate scripts for shell auto-completion.

```APIDOC
## completion

### Description
Dump the shell completion script.

### Usage
completion [--debug] [--] [<shell>]

### Arguments
- **shell** (string) - Optional - The shell type (e.g. "bash"), the value of the "$SHELL" env var will be used if this is not given.

### Options
- **--debug** (boolean) - Optional - Tail the completion debug log.
```

--------------------------------

### descriptor:command2

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Executes command 2 with a required argument and an optional flag.

```APIDOC
## descriptor:command2

### Description
command 2 description

### Usage
descriptor:command2 [-o|--option_name] [--] <argument_name>

### Arguments
- **argument_name** (string) - Required

### Options
- **--option_name|-o** (boolean) - Optional - Default: false
```

--------------------------------

### Try shell completion manually

Source: https://github.com/symfony/console/blob/8.2/Tests/shell-completion/README.md

Open a shell with the fixture application and completion loaded to test commands manually. Use the Docker command for containerized environments or the machine script for local execution.

```bash
Tests/shell-completion/docker.sh try zsh   # in Docker
Tests/shell-completion/try.sh zsh              # on the machine
```

--------------------------------

### descriptor:command5

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.rst

Executes command 5 with a deprecated option.

```APIDOC
## descriptor:command5

### Description
command 5 description

### Usage
descriptor:command5 [-y|--deprecated_option]

### Options
- **--deprecated_option|-y** (boolean) - Optional - Deprecated: yes. Default: false
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run3.txt

The list command displays a list of all available commands. It supports filtering by namespace and outputting in various formats.

```APIDOC
## list

### Description
Lists all available commands. Optionally filter by namespace or change the output format.

### Usage
list [options] [--] [<namespace>]

### Arguments
- **namespace** (string) - Optional - The namespace name to filter commands by.

### Options
- **--raw** (flag) - Optional - Output raw command list.
- **--format=FORMAT** (string) - Optional - The output format (txt, xml, json, or md). Default: "txt".
- **--short** (flag) - Optional - Skip describing commands' arguments.
- **-h, --help** (flag) - Optional - Display help for the command.
- **--silent** (flag) - Optional - Do not output any message.
- **-q, --quiet** (flag) - Optional - Only errors are displayed.
- **-V, --version** (flag) - Optional - Display application version.
- **--ansi|--no-ansi** (flag) - Optional - Force or disable ANSI output.
- **-n, --no-interaction** (flag) - Optional - Do not ask any interactive question.
- **-v|vv|vvv, --verbose** (flag) - Optional - Increase verbosity of messages.
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run2.txt

The list command displays all available commands in the application. It supports filtering by namespace and outputting in various formats.

```APIDOC
## list

### Description
Lists all available commands. You can optionally specify a namespace to filter the list or change the output format.

### Usage
list [options] [--] [<namespace>]

### Arguments
- **namespace** (string) - Optional - The namespace name to filter commands by.

### Options
- **--raw** (boolean) - Optional - Output raw command list.
- **--format=FORMAT** (string) - Optional - The output format (txt, xml, json, or md). Default: "txt".
- **--short** (boolean) - Optional - Skip describing commands' arguments.
- **-h, --help** (boolean) - Optional - Display help for the command.
- **--silent** (boolean) - Optional - Do not output any message.
- **-q, --quiet** (boolean) - Optional - Only errors are displayed.
- **-V, --version** (boolean) - Optional - Display application version.
- **--ansi|--no-ansi** (boolean) - Optional - Force or disable ANSI output.
- **-n, --no-interaction** (boolean) - Optional - Do not ask any interactive question.
- **-v|vv|vvv, --verbose** (boolean) - Optional - Increase verbosity of messages.
```

--------------------------------

### descriptor:åèä

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.rst

A specific command descriptor for åèä.

```APIDOC
## descriptor:åèä

### Description
command åèä description.

### Usage
`descriptor:åèä [-o|--option_åèä] [--] <argument_åèä>`

### Arguments
- **argument_åèä** (string) - Required - The argument for the command.

### Options
- **--option_åèä|-o** (boolean) - Optional - Option for åèä. Default: false.
```

--------------------------------

### list

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.md

The list command displays all available commands. It supports filtering by namespace and outputting in different formats.

```APIDOC
## list

### Description
Lists all available commands. Optionally filter by namespace or change the output format.

### Arguments
- **namespace** (string) - Optional - The namespace name to filter commands by.

### Options
- **--raw** (boolean) - Optional - Output raw command list.
- **--format** (string) - Optional - The output format (txt, xml, json, or md). Default: 'txt'.
- **--short** (boolean) - Optional - Skip describing commands' arguments.
```

--------------------------------

### List commands for a specific namespace

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_run2.txt

Filters the command list to show only those within the specified namespace.

```bash
app/console list test
```

--------------------------------

### descriptor:command2

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_2.md

Executes command 2 with a required argument and an optional option.

```APIDOC
## descriptor:command2

### Description
Executes command 2. Requires an argument and supports an optional option.

### Arguments
- **argument_name** (string) - Required - The required argument for the command.

### Options
- **-o|--option_name** (string) - Optional - An optional option for the command.
```

--------------------------------

### Run shell completion tests with Docker

Source: https://github.com/symfony/console/blob/8.2/Tests/shell-completion/README.md

Execute completion tests for all shells or a specific shell using the Docker environment.

```bash
Tests/shell-completion/docker.sh run       # all shells
Tests/shell-completion/docker.sh run zsh   # one shell
```

--------------------------------

### descriptor:åèä

Source: https://github.com/symfony/console/blob/8.2/Tests/Fixtures/application_mbstring.md

A specific command descriptor for åèä. It requires an argument and supports an optional flag.

```APIDOC
## descriptor:åèä

### Description
Executes the åèä command with the provided argument.

### Arguments
- **argument_åèä** (string) - Required - The required argument for the command.

### Options
- **--option_åèä|-o** (boolean) - Optional - An optional flag for the command.
```
Tokens:
Raw