diff --git a/docs/cli/built-in-commands/addons.md b/docs/cli/built-in-commands/addons.md new file mode 100644 index 000000000..9811f3c3f --- /dev/null +++ b/docs/cli/built-in-commands/addons.md @@ -0,0 +1,68 @@ +# Add-on Management + +Set of CLI commands that allows listing, installing, updating and uninstalling add-ons. + +[TOC] + +## `addons:list` + +Lists all add-ons available in the system. + + php eecli.php addons:list + +List add-ons that are currently installed: + + php eecli.php addons:list i + +or + + php eecli.php addons:list installed + +List add-ons that have an update available: + + php eecli.php addons:list a + +or + + php eecli.php addons:list update-available + +List add-ons that are currently uninstalled: + + php eecli.php addons:list u +or + + php eecli.php addons:list uninstalled + +## `addons:install` + +Installs an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option. + + php eecli.php addons:install + +or + + php eecli.php addons:install --addon block_and_allow + +## `addons:update` + +Updates an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option. +You can also set `--all` flag to run all add-on updates that are available. + + php eecli.php addons:update + +or + + php eecli.php addons:update --addon block_and_allow + +or + + php eecli.php addons:update --all + +## `addons:uninstall` + +Uninstalls an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option. + + php eecli.php addons:uninstall +or + + php eecli.php addons:uninstall --addon block_and_allow diff --git a/docs/cli/built-in-commands/backup-database.md b/docs/cli/built-in-commands/backup-database.md new file mode 100644 index 000000000..dd90d3e27 --- /dev/null +++ b/docs/cli/built-in-commands/backup-database.md @@ -0,0 +1,39 @@ +# backup:database + +Database backups + +## Options list: + + --relative_path= + -p + Path to database backup, relative to the cache folder + + --absolute_path= + -a + Absolute path to the directory the database backup will be stored + + --file_name= + -f + Name of sql file to be saved + + --speed= + -s + Speed of database backup (between 1-10). Setting a lower speed allows for more time between database commands. Default speed is 5. + + +## Examples: + +### Backup the database to the default path, at the default speed + + php eecli.php backup:database + + # Example backup path and filename: + system/user/cache/eedatabase_2023-05-30_18h05m39sUTC.sql + +### Backup the database to the to an absolute path, with a custom filename + + php eecli.php backup:database --file_name=deploy_backup.sql --absolute_path='/home/forge/backups' + +### Backup the database at a slow speed, to help with the potential to lock up the database. + + php eecli.php backup:database --speed=1 diff --git a/docs/cli/built-in-commands/config-management.md b/docs/cli/built-in-commands/config-management.md new file mode 100644 index 000000000..7800ec24c --- /dev/null +++ b/docs/cli/built-in-commands/config-management.md @@ -0,0 +1,63 @@ +# Config Management + +Set of CLI commands that updates the config file values, as well as ENV values. These are commonly use to provision a site or as part of a deploy script. + +[TOC] + +## `config:config` + +Updates values in the config.php file. + +### Options list + --config-variable= + -c + The config item to modify + + --value= + -v + The value to set the config item to + +### Examples + +Set system to offline: + + php eecli.php config:config -c is_system_on -v n + +Set system to online: + + php eecli.php config:config -c is_system_on -v y + + +Set debug to 1: + + php eecli.php config:config -c debug -v 1 + + +## `config:env` + +Updates values in the .env.php file. + +### Options list + --env-variable= + -e + The env item to set/modify + + --value= + -v + The value to set the env item to + +### Examples + +Set system to offline: + + php eecli.php config:env -e IS_SYSTEM_ON -v n + +Set system to online: + + php eecli.php config:env -e IS_SYSTEM_ON -v y + +Set EE_INSTALL_MODE to false + + php eecli.php config:env -e EE_INSTALL_MODE -v FALSE + + diff --git a/docs/cli/built-in-commands/make-action.md b/docs/cli/built-in-commands/make-action.md index 610c92a43..436c17f09 100644 --- a/docs/cli/built-in-commands/make-action.md +++ b/docs/cli/built-in-commands/make-action.md @@ -1,6 +1,6 @@ # make:action -Action Generator -- Creates a new action for an add-on +Action Generator -- Creates a new action for an add-on ## Options list: diff --git a/docs/toc_sections/_advanced_usage_toc.yml b/docs/toc_sections/_advanced_usage_toc.yml index 6edb45c3c..38909588d 100644 --- a/docs/toc_sections/_advanced_usage_toc.yml +++ b/docs/toc_sections/_advanced_usage_toc.yml @@ -70,7 +70,7 @@ - name: Find and Replace href: add-ons/pro-search/find-and-replace.md - name: Upgrade from Low Search - href: add-ons/pro-search/upgrade-from-low-search.md + href: add-ons/pro-search/upgrade-from-low-search.md - name: Development items: - name: Creating your own Filter @@ -98,7 +98,7 @@ - name: Fieldtype href: add-ons/pro-variables/fieldtype.md - name: Upgrade from Low Variables - href: add-ons/pro-variables/upgrade-from-low-variables.md + href: add-ons/pro-variables/upgrade-from-low-variables.md - name: Development items: - name: Fieldtype Bridge @@ -315,7 +315,7 @@ href: development/architecture.md - name: Services items: - - name: Addon Service + - name: Add-on Service href: development/services/addon.md - name: CP/Alert Service href: development/services/alert.md @@ -399,15 +399,15 @@ items: - name: Working with Models href: development/models/working-with-models.md - - name: Addon Action Model + - name: Add-on Action Model href: development/models/addon-action.md - - name: Addon Module Model + - name: Add-on Module Model href: development/models/addon-module.md - - name: Addon Extension Model + - name: Add-on Extension Model href: development/models/addon-extension.md - - name: Addon Fieldtype Model + - name: Add-on Fieldtype Model href: development/models/addon-fieldtype.md - - name: Addon Plugin Model + - name: Add-on Plugin Model href: development/models/addon-plugin.md - name: Category Model href: development/models/category.md @@ -630,7 +630,7 @@ href: development/v6-add-on-migration.md - name: Automated Upgrading href: development/automated-upgrading.md - + - name: Command Line Interface (CLI) items: - name: Introduction @@ -639,10 +639,18 @@ href: cli/usage.md - name: Built In Commands items: + - name: Add-on Management + href: cli/built-in-commands/addons.md + - name: Add-on Generator + href: cli/built-in-commands/make-addon.md + - name: Backup Database + href: cli/built-in-commands/backup-database.md - name: Clear Cache href: cli/built-in-commands/cache-clear.md - name: Command Generator href: cli/built-in-commands/make-command.md + - name: Config Management + href: cli/built-in-commands/config-management.md - name: Migrations href: cli/built-in-commands/migrate.md - name: List @@ -661,7 +669,7 @@ - name: Entry Cloning href: channels/entry_cloning.md - + - name: Front-end Content Management items: - name: Overview @@ -676,4 +684,4 @@ - name: Overview href: msm/overview.md - name: Variables and Parameter - href: msm/code.md \ No newline at end of file + href: msm/code.md