-
Notifications
You must be signed in to change notification settings - Fork 80
New CLI commands #594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
New CLI commands #594
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
2c22829
addon management CLI
intoeetive 9d13583
addons:update --all
intoeetive a309c4e
Merge branch '7.dev' into feature/7.x/cli-addon-install
intoeetive a896d44
Update add-on management docs
matthewjohns0n 00a3e37
Add backup:database documentation, as well as config and env command …
matthewjohns0n 300e0ef
Update addon docs
matthewjohns0n 8567734
Update addons.md
matthewjohns0n 79a8fa1
Update backup database wording on absolute path
matthewjohns0n File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# backup:database | ||
|
||
Database backups | ||
|
||
## Options list: | ||
|
||
--relative_path=<value> | ||
-p <value> | ||
Path to database backup, relative to the cache folder | ||
|
||
--absolute_path=<value> | ||
-a <value> | ||
Absolute path to the directory the database backup will be stored | ||
|
||
--file_name=<value> | ||
-f <value> | ||
Name of sql file to be saved | ||
|
||
--speed=<value> | ||
-s <value> | ||
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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=<value> | ||
-c <value> | ||
The config item to modify | ||
|
||
--value=<value> | ||
-v <value> | ||
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=<value> | ||
-e <value> | ||
The env item to set/modify | ||
|
||
--value=<value> | ||
-v <value> | ||
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 | ||
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.