From 0a337e7b48ba078df6cfefece586cb4501ba6a54 Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Mon, 15 Sep 2025 15:26:29 -0400 Subject: [PATCH 1/2] adding docs for the new cli commands --- docs/cli/built-in-commands/channels-list.md | 72 +++++++++++++ docs/cli/built-in-commands/fields-list.md | 102 ++++++++++++++++++ docs/cli/built-in-commands/fieldtypes-list.md | 82 ++++++++++++++ docs/cli/built-in-commands/version.md | 50 +++++++++ 4 files changed, 306 insertions(+) create mode 100644 docs/cli/built-in-commands/channels-list.md create mode 100644 docs/cli/built-in-commands/fields-list.md create mode 100644 docs/cli/built-in-commands/fieldtypes-list.md create mode 100644 docs/cli/built-in-commands/version.md diff --git a/docs/cli/built-in-commands/channels-list.md b/docs/cli/built-in-commands/channels-list.md new file mode 100644 index 000000000..8bfed6a60 --- /dev/null +++ b/docs/cli/built-in-commands/channels-list.md @@ -0,0 +1,72 @@ +# `channels:list` + +Lists all channels in the system with their details in various formats. + +TIP: If you would like to create or manage channels programmatically, see the Channel Model documentation. + +## php eecli.php channels:list + +### Options list: + +``` + --site= + -s + Site ID to list channels for + + --format= + -f + Output format: table, json, or csv + + --channel_id= + -c + Filter by specific channel ID +``` + +## Examples: + +### Listing all channels: + +The following commands will list all channels in table format (default): + +`php eecli.php channels:list` + +`php eecli.php channels:list --format=table` + +`php eecli.php channels:list -f table` + +### Listing channels for a specific site: + +`php eecli.php channels:list --site=1` + +`php eecli.php channels:list -s 1` + +### Filtering by channel ID: + +`php eecli.php channels:list --channel_id=5` + +`php eecli.php channels:list -c 5` + +### Output in JSON format: + +`php eecli.php channels:list --format=json` + +`php eecli.php channels:list -f json` + +### Output in CSV format: + +`php eecli.php channels:list --format=csv` + +`php eecli.php channels:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php channels:list --site=1 --format=json` + +`php eecli.php channels:list -s 1 -c 5 -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2024 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/fields-list.md b/docs/cli/built-in-commands/fields-list.md new file mode 100644 index 000000000..9ed4051e1 --- /dev/null +++ b/docs/cli/built-in-commands/fields-list.md @@ -0,0 +1,102 @@ +# `fields:list` + +Lists all channel fields in the system with their details in various formats. + +TIP: If you would like to create or manage channel fields programmatically, see the ChannelField Model documentation. + +## php eecli.php fields:list + +### Options list: + +``` + --site= + -s + Site ID to list fields for + + --format= + -f + Output format: table, json, or csv + + --type= + -t + Filter by field type (e.g., text, textarea, select) + + --group= + -g + Filter by field group name or short name + + --channel_id= + -c + Filter by channel ID + + --field_id= + -i + Filter by specific field ID +``` + +## Examples: + +### Listing all fields: + +The following commands will list all channel fields in table format (default): + +`php eecli.php fields:list` + +`php eecli.php fields:list --format=table` + +`php eecli.php fields:list -f table` + +### Listing fields for a specific site: + +`php eecli.php fields:list --site=1` + +`php eecli.php fields:list -s 1` + +### Filtering by field type: + +`php eecli.php fields:list --type=text` + +`php eecli.php fields:list -t textarea` + +### Filtering by field group: + +`php eecli.php fields:list --group="Blog Fields"` + +`php eecli.php fields:list -g blog_fields` + +### Filtering by channel ID: + +`php eecli.php fields:list --channel_id=5` + +`php eecli.php fields:list -c 5` + +### Filtering by field ID: + +`php eecli.php fields:list --field_id=10` + +`php eecli.php fields:list -i 10` + +### Output in JSON format: + +`php eecli.php fields:list --format=json` + +`php eecli.php fields:list -f json` + +### Output in CSV format: + +`php eecli.php fields:list --format=csv` + +`php eecli.php fields:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php fields:list --site=1 --type=text --format=json` + +`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/fieldtypes-list.md b/docs/cli/built-in-commands/fieldtypes-list.md new file mode 100644 index 000000000..9ad8422d9 --- /dev/null +++ b/docs/cli/built-in-commands/fieldtypes-list.md @@ -0,0 +1,82 @@ +# `fieldtypes:list` + +Lists all available fieldtypes provided by installed and bundled add-ons. + +TIP: If you would like to create custom fieldtypes, see the Fieldtype Development documentation. + +## php eecli.php fieldtypes:list + +### Options list: + +``` + --format= + -f + Output format: table, json, or csv + + --installed + -i + Show only fieldtypes from installed add-ons + + --addon= + -a + Filter by add-on short name(s), comma-separated + + --short= + -s + Filter by fieldtype short name(s), comma-separated +``` + +## Examples: + +### Listing all fieldtypes: + +The following commands will list all available fieldtypes in table format (default): + +`php eecli.php fieldtypes:list` + +`php eecli.php fieldtypes:list --format=table` + +`php eecli.php fieldtypes:list -f table` + +### Listing only installed fieldtypes: + +`php eecli.php fieldtypes:list --installed` + +`php eecli.php fieldtypes:list -i` + +### Filtering by add-on: + +`php eecli.php fieldtypes:list --addon=pro_search` + +`php eecli.php fieldtypes:list -a channel_files,structure` + +### Filtering by fieldtype short name: + +`php eecli.php fieldtypes:list --short=text` + +`php eecli.php fieldtypes:list -s textarea,select,radio` + +### Output in JSON format: + +`php eecli.php fieldtypes:list --format=json` + +`php eecli.php fieldtypes:list -f json` + +### Output in CSV format: + +`php eecli.php fieldtypes:list --format=csv` + +`php eecli.php fieldtypes:list -f csv` + +### Combining filters: + +You can combine multiple filters to narrow down your results: + +`php eecli.php fieldtypes:list --installed --addon=pro_search --format=json` + +`php eecli.php fieldtypes:list -i -s text,textarea -f table` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/version.md b/docs/cli/built-in-commands/version.md new file mode 100644 index 000000000..94e07990b --- /dev/null +++ b/docs/cli/built-in-commands/version.md @@ -0,0 +1,50 @@ +# `version` + +Shows the current ExpressionEngine version and system information. + +TIP: If you would like to check version information programmatically, see the Config Service documentation. + +## php eecli.php version + +### Options list: + +``` + --format= + -f + Output format: simple, or json + + --field= + -e + Output only a specific field: version, build, or php_version +``` + +## Examples: + +### Showing version information: + +The following commands will show ExpressionEngine version information in simple format (default): + +`php eecli.php version` + +`php eecli.php version --format=simple` + +`php eecli.php version -f simple` + +### Output in JSON format: + +`php eecli.php version --format=json` + +`php eecli.php version -f json` + +### Getting specific field values: + +`php eecli.php version --field=version` + +`php eecli.php version -e build` + +`php eecli.php version --field=php_version` + +--- + +ExpressionEngine 7 Docs +©2002–2025 Packet Tide,LLC. Edit this page From 7dbfa1cc1f0d2a2539d3dfcc81996a98e5d8b295 Mon Sep 17 00:00:00 2001 From: Tom Jaeger Date: Mon, 15 Sep 2025 15:28:52 -0400 Subject: [PATCH 2/2] removing footer elements. --- docs/cli/built-in-commands/channels-list.md | 7 +------ docs/cli/built-in-commands/fields-list.md | 7 +------ docs/cli/built-in-commands/fieldtypes-list.md | 5 ----- docs/cli/built-in-commands/version.md | 5 ----- 4 files changed, 2 insertions(+), 22 deletions(-) diff --git a/docs/cli/built-in-commands/channels-list.md b/docs/cli/built-in-commands/channels-list.md index 8bfed6a60..d76c52361 100644 --- a/docs/cli/built-in-commands/channels-list.md +++ b/docs/cli/built-in-commands/channels-list.md @@ -64,9 +64,4 @@ You can combine multiple filters to narrow down your results: `php eecli.php channels:list --site=1 --format=json` -`php eecli.php channels:list -s 1 -c 5 -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2024 Packet Tide,LLC. Edit this page +`php eecli.php channels:list -s 1 -c 5 -f table` \ No newline at end of file diff --git a/docs/cli/built-in-commands/fields-list.md b/docs/cli/built-in-commands/fields-list.md index 9ed4051e1..f3b855772 100644 --- a/docs/cli/built-in-commands/fields-list.md +++ b/docs/cli/built-in-commands/fields-list.md @@ -94,9 +94,4 @@ You can combine multiple filters to narrow down your results: `php eecli.php fields:list --site=1 --type=text --format=json` -`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page +`php eecli.php fields:list -s 1 -t select -g blog_fields -f table` \ No newline at end of file diff --git a/docs/cli/built-in-commands/fieldtypes-list.md b/docs/cli/built-in-commands/fieldtypes-list.md index 9ad8422d9..c5457f77d 100644 --- a/docs/cli/built-in-commands/fieldtypes-list.md +++ b/docs/cli/built-in-commands/fieldtypes-list.md @@ -75,8 +75,3 @@ You can combine multiple filters to narrow down your results: `php eecli.php fieldtypes:list --installed --addon=pro_search --format=json` `php eecli.php fieldtypes:list -i -s text,textarea -f table` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page diff --git a/docs/cli/built-in-commands/version.md b/docs/cli/built-in-commands/version.md index 94e07990b..d9196fe0a 100644 --- a/docs/cli/built-in-commands/version.md +++ b/docs/cli/built-in-commands/version.md @@ -43,8 +43,3 @@ The following commands will show ExpressionEngine version information in simple `php eecli.php version -e build` `php eecli.php version --field=php_version` - ---- - -ExpressionEngine 7 Docs -©2002–2025 Packet Tide,LLC. Edit this page