Skip to content

Commit c6cbb27

Browse files
authored
Merge pull request #1060 from ExpressionEngine/new/cli-commands-7.5.16
adding docs for the new cli commands
2 parents 59fbf32 + 7dbfa1c commit c6cbb27

File tree

4 files changed

+286
-0
lines changed

4 files changed

+286
-0
lines changed
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# `channels:list`
2+
3+
Lists all channels in the system with their details in various formats.
4+
5+
TIP: If you would like to create or manage channels programmatically, see the Channel Model documentation.
6+
7+
## php eecli.php channels:list
8+
9+
### Options list:
10+
11+
```
12+
--site=<value>
13+
-s <value>
14+
Site ID to list channels for
15+
16+
--format=<value>
17+
-f <value>
18+
Output format: table, json, or csv
19+
20+
--channel_id=<value>
21+
-c <value>
22+
Filter by specific channel ID
23+
```
24+
25+
## Examples:
26+
27+
### Listing all channels:
28+
29+
The following commands will list all channels in table format (default):
30+
31+
`php eecli.php channels:list`
32+
33+
`php eecli.php channels:list --format=table`
34+
35+
`php eecli.php channels:list -f table`
36+
37+
### Listing channels for a specific site:
38+
39+
`php eecli.php channels:list --site=1`
40+
41+
`php eecli.php channels:list -s 1`
42+
43+
### Filtering by channel ID:
44+
45+
`php eecli.php channels:list --channel_id=5`
46+
47+
`php eecli.php channels:list -c 5`
48+
49+
### Output in JSON format:
50+
51+
`php eecli.php channels:list --format=json`
52+
53+
`php eecli.php channels:list -f json`
54+
55+
### Output in CSV format:
56+
57+
`php eecli.php channels:list --format=csv`
58+
59+
`php eecli.php channels:list -f csv`
60+
61+
### Combining filters:
62+
63+
You can combine multiple filters to narrow down your results:
64+
65+
`php eecli.php channels:list --site=1 --format=json`
66+
67+
`php eecli.php channels:list -s 1 -c 5 -f table`
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# `fields:list`
2+
3+
Lists all channel fields in the system with their details in various formats.
4+
5+
TIP: If you would like to create or manage channel fields programmatically, see the ChannelField Model documentation.
6+
7+
## php eecli.php fields:list
8+
9+
### Options list:
10+
11+
```
12+
--site=<value>
13+
-s <value>
14+
Site ID to list fields for
15+
16+
--format=<value>
17+
-f <value>
18+
Output format: table, json, or csv
19+
20+
--type=<value>
21+
-t <value>
22+
Filter by field type (e.g., text, textarea, select)
23+
24+
--group=<value>
25+
-g <value>
26+
Filter by field group name or short name
27+
28+
--channel_id=<value>
29+
-c <value>
30+
Filter by channel ID
31+
32+
--field_id=<value>
33+
-i <value>
34+
Filter by specific field ID
35+
```
36+
37+
## Examples:
38+
39+
### Listing all fields:
40+
41+
The following commands will list all channel fields in table format (default):
42+
43+
`php eecli.php fields:list`
44+
45+
`php eecli.php fields:list --format=table`
46+
47+
`php eecli.php fields:list -f table`
48+
49+
### Listing fields for a specific site:
50+
51+
`php eecli.php fields:list --site=1`
52+
53+
`php eecli.php fields:list -s 1`
54+
55+
### Filtering by field type:
56+
57+
`php eecli.php fields:list --type=text`
58+
59+
`php eecli.php fields:list -t textarea`
60+
61+
### Filtering by field group:
62+
63+
`php eecli.php fields:list --group="Blog Fields"`
64+
65+
`php eecli.php fields:list -g blog_fields`
66+
67+
### Filtering by channel ID:
68+
69+
`php eecli.php fields:list --channel_id=5`
70+
71+
`php eecli.php fields:list -c 5`
72+
73+
### Filtering by field ID:
74+
75+
`php eecli.php fields:list --field_id=10`
76+
77+
`php eecli.php fields:list -i 10`
78+
79+
### Output in JSON format:
80+
81+
`php eecli.php fields:list --format=json`
82+
83+
`php eecli.php fields:list -f json`
84+
85+
### Output in CSV format:
86+
87+
`php eecli.php fields:list --format=csv`
88+
89+
`php eecli.php fields:list -f csv`
90+
91+
### Combining filters:
92+
93+
You can combine multiple filters to narrow down your results:
94+
95+
`php eecli.php fields:list --site=1 --type=text --format=json`
96+
97+
`php eecli.php fields:list -s 1 -t select -g blog_fields -f table`
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# `fieldtypes:list`
2+
3+
Lists all available fieldtypes provided by installed and bundled add-ons.
4+
5+
TIP: If you would like to create custom fieldtypes, see the Fieldtype Development documentation.
6+
7+
## php eecli.php fieldtypes:list
8+
9+
### Options list:
10+
11+
```
12+
--format=<value>
13+
-f <value>
14+
Output format: table, json, or csv
15+
16+
--installed
17+
-i
18+
Show only fieldtypes from installed add-ons
19+
20+
--addon=<value>
21+
-a <value>
22+
Filter by add-on short name(s), comma-separated
23+
24+
--short=<value>
25+
-s <value>
26+
Filter by fieldtype short name(s), comma-separated
27+
```
28+
29+
## Examples:
30+
31+
### Listing all fieldtypes:
32+
33+
The following commands will list all available fieldtypes in table format (default):
34+
35+
`php eecli.php fieldtypes:list`
36+
37+
`php eecli.php fieldtypes:list --format=table`
38+
39+
`php eecli.php fieldtypes:list -f table`
40+
41+
### Listing only installed fieldtypes:
42+
43+
`php eecli.php fieldtypes:list --installed`
44+
45+
`php eecli.php fieldtypes:list -i`
46+
47+
### Filtering by add-on:
48+
49+
`php eecli.php fieldtypes:list --addon=pro_search`
50+
51+
`php eecli.php fieldtypes:list -a channel_files,structure`
52+
53+
### Filtering by fieldtype short name:
54+
55+
`php eecli.php fieldtypes:list --short=text`
56+
57+
`php eecli.php fieldtypes:list -s textarea,select,radio`
58+
59+
### Output in JSON format:
60+
61+
`php eecli.php fieldtypes:list --format=json`
62+
63+
`php eecli.php fieldtypes:list -f json`
64+
65+
### Output in CSV format:
66+
67+
`php eecli.php fieldtypes:list --format=csv`
68+
69+
`php eecli.php fieldtypes:list -f csv`
70+
71+
### Combining filters:
72+
73+
You can combine multiple filters to narrow down your results:
74+
75+
`php eecli.php fieldtypes:list --installed --addon=pro_search --format=json`
76+
77+
`php eecli.php fieldtypes:list -i -s text,textarea -f table`
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# `version`
2+
3+
Shows the current ExpressionEngine version and system information.
4+
5+
TIP: If you would like to check version information programmatically, see the Config Service documentation.
6+
7+
## php eecli.php version
8+
9+
### Options list:
10+
11+
```
12+
--format=<value>
13+
-f <value>
14+
Output format: simple, or json
15+
16+
--field=<value>
17+
-e <value>
18+
Output only a specific field: version, build, or php_version
19+
```
20+
21+
## Examples:
22+
23+
### Showing version information:
24+
25+
The following commands will show ExpressionEngine version information in simple format (default):
26+
27+
`php eecli.php version`
28+
29+
`php eecli.php version --format=simple`
30+
31+
`php eecli.php version -f simple`
32+
33+
### Output in JSON format:
34+
35+
`php eecli.php version --format=json`
36+
37+
`php eecli.php version -f json`
38+
39+
### Getting specific field values:
40+
41+
`php eecli.php version --field=version`
42+
43+
`php eecli.php version -e build`
44+
45+
`php eecli.php version --field=php_version`

0 commit comments

Comments
 (0)