Blame view

vendor/symfony/console/Tests/Fixtures/application_1.md 2.63 KB
c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
1
2
Console Tool
============
6c4edfa3   Alexandre   First Commit LabI...
3

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
4
5
* [`help`](#help)
* [`list`](#list)
6c4edfa3   Alexandre   First Commit LabI...
6

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
7
8
`help`
------
6c4edfa3   Alexandre   First Commit LabI...
9

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
10
Displays help for a command
6c4edfa3   Alexandre   First Commit LabI...
11

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
12
### Usage
6c4edfa3   Alexandre   First Commit LabI...
13

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
14
* `help [--format FORMAT] [--raw] [--] [<command_name>]`
6c4edfa3   Alexandre   First Commit LabI...
15

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
16
The help command displays help for a given command:
6c4edfa3   Alexandre   First Commit LabI...
17

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
18
  php app/console help list
6c4edfa3   Alexandre   First Commit LabI...
19

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
20
You can also output the help in other formats by using the --format option:
6c4edfa3   Alexandre   First Commit LabI...
21

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
22
  php app/console help --format=xml list
6c4edfa3   Alexandre   First Commit LabI...
23

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
24
To display the list of available commands, please use the list command.
6c4edfa3   Alexandre   First Commit LabI...
25

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
26
27
28
29
30
### Arguments

#### `command_name`

The command name
6c4edfa3   Alexandre   First Commit LabI...
31

6c4edfa3   Alexandre   First Commit LabI...
32
33
* Is required: no
* Is array: no
6c4edfa3   Alexandre   First Commit LabI...
34
35
* Default: `'help'`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
36
### Options
6c4edfa3   Alexandre   First Commit LabI...
37

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
38
39
40
#### `--format`

The output format (txt, xml, json, or md)
6c4edfa3   Alexandre   First Commit LabI...
41

6c4edfa3   Alexandre   First Commit LabI...
42
43
44
* Accept value: yes
* Is value required: yes
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
45
46
* Default: `'txt'`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
47
48
49
#### `--raw`

To output raw command help
6c4edfa3   Alexandre   First Commit LabI...
50

6c4edfa3   Alexandre   First Commit LabI...
51
52
53
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
54
55
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
56
57
58
#### `--help|-h`

Display this help message
6c4edfa3   Alexandre   First Commit LabI...
59

6c4edfa3   Alexandre   First Commit LabI...
60
61
62
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
63
64
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
65
66
67
#### `--quiet|-q`

Do not output any message
6c4edfa3   Alexandre   First Commit LabI...
68

6c4edfa3   Alexandre   First Commit LabI...
69
70
71
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
72
73
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
74
75
76
#### `--verbose|-v|-vv|-vvv`

Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
6c4edfa3   Alexandre   First Commit LabI...
77

6c4edfa3   Alexandre   First Commit LabI...
78
79
80
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
81
82
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
83
84
85
#### `--version|-V`

Display this application version
6c4edfa3   Alexandre   First Commit LabI...
86

6c4edfa3   Alexandre   First Commit LabI...
87
88
89
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
90
91
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
92
93
94
#### `--ansi`

Force ANSI output
6c4edfa3   Alexandre   First Commit LabI...
95

6c4edfa3   Alexandre   First Commit LabI...
96
97
98
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
99
100
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
101
102
103
#### `--no-ansi`

Disable ANSI output
6c4edfa3   Alexandre   First Commit LabI...
104

6c4edfa3   Alexandre   First Commit LabI...
105
106
107
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
108
109
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
110
111
112
#### `--no-interaction|-n`

Do not ask any interactive question
6c4edfa3   Alexandre   First Commit LabI...
113

6c4edfa3   Alexandre   First Commit LabI...
114
115
116
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
117
118
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
119
120
121
122
`list`
------

Lists commands
6c4edfa3   Alexandre   First Commit LabI...
123

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
124
### Usage
6c4edfa3   Alexandre   First Commit LabI...
125

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
126
* `list [--raw] [--format FORMAT] [--] [<namespace>]`
6c4edfa3   Alexandre   First Commit LabI...
127

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
128
The list command lists all commands:
6c4edfa3   Alexandre   First Commit LabI...
129

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
130
  php app/console list
6c4edfa3   Alexandre   First Commit LabI...
131
132
133

You can also display the commands for a specific namespace:

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
134
  php app/console list test
6c4edfa3   Alexandre   First Commit LabI...
135

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
136
You can also output the information in other formats by using the --format option:
6c4edfa3   Alexandre   First Commit LabI...
137

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
138
  php app/console list --format=xml
6c4edfa3   Alexandre   First Commit LabI...
139
140
141

It's also possible to get raw list of commands (useful for embedding command runner):

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
142
  php app/console list --raw
6c4edfa3   Alexandre   First Commit LabI...
143

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
144
### Arguments
6c4edfa3   Alexandre   First Commit LabI...
145

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
146
147
148
#### `namespace`

The namespace name
6c4edfa3   Alexandre   First Commit LabI...
149

6c4edfa3   Alexandre   First Commit LabI...
150
151
* Is required: no
* Is array: no
6c4edfa3   Alexandre   First Commit LabI...
152
153
* Default: `NULL`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
154
155
156
### Options

#### `--raw`
6c4edfa3   Alexandre   First Commit LabI...
157

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
158
To output raw command list
6c4edfa3   Alexandre   First Commit LabI...
159

6c4edfa3   Alexandre   First Commit LabI...
160
161
162
* Accept value: no
* Is value required: no
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
163
164
* Default: `false`

c3f2e5a1   Thibaud Ajas   MAJ DE PHP v5.6 -...
165
166
167
#### `--format`

The output format (txt, xml, json, or md)
6c4edfa3   Alexandre   First Commit LabI...
168

6c4edfa3   Alexandre   First Commit LabI...
169
170
171
* Accept value: yes
* Is value required: yes
* Is multiple: no
6c4edfa3   Alexandre   First Commit LabI...
172
* Default: `'txt'`