Skip to content

Commit a896d44

Browse files
Update add-on management docs
1 parent a309c4e commit a896d44

File tree

2 files changed

+33
-21
lines changed

2 files changed

+33
-21
lines changed
Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,46 @@
1-
# Addons Management
1+
# Add-on Management
22

3-
Set of CLI commands that allows listing, installing, updating and uninstalling add-ons
3+
Set of CLI commands that allows listing, installing, updating and uninstalling add-ons.
44

55
[TOC]
66

77
## `addons:list`
88

9-
List all add-on available in the system
9+
Lists all add-ons available in the system.
1010

1111
php eecli.php addons:list
1212

13-
List add-ons that can be installed
13+
List add-ons that can be installed:
1414

1515
php eecli.php addons:list i
16+
1617
or
18+
1719
php eecli.php addons:list installed
1820

19-
List add-ons that can be updated
21+
List add-ons that have an update available:
2022

2123
php eecli.php addons:list a
24+
2225
or
26+
2327
php eecli.php addons:list update-available
2428

2529
List add-ons that can be uninstalled
2630

2731
php eecli.php addons:list u
2832
or
29-
php eecli.php addons:list uninstalled
33+
34+
php eecli.php addons:list uninstalled:
3035

3136
## `addons:install`
3237

33-
Installs an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option
38+
Installs an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option.
3439

3540
php eecli.php addons:install
41+
3642
or
43+
3744
php eecli.php addons:install --addon block_and_allow
3845

3946
## `addons:update`
@@ -42,15 +49,20 @@ Updates an add-on. Add-on name can be selected (typed) in dialog or provided wit
4249
You can also set `--all` flag to run all add-on updates that are available.
4350

4451
php eecli.php addons:update
52+
4553
or
54+
4655
php eecli.php addons:update --addon block_and_allow
56+
4757
or
58+
4859
php eecli.php addons:update --all
4960

5061
## `addons:uninstall`
5162

52-
Uninstalls an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option
63+
Uninstalls an add-on. Add-on name can be selected (typed) in dialog or provided with `--addon` or `-a` option.
5364

5465
php eecli.php addons:uninstall
5566
or
67+
5668
php eecli.php addons:uninstall --addon block_and_allow

docs/toc_sections/_advanced_usage_toc.yml

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@
7070
- name: Find and Replace
7171
href: add-ons/pro-search/find-and-replace.md
7272
- name: Upgrade from Low Search
73-
href: add-ons/pro-search/upgrade-from-low-search.md
73+
href: add-ons/pro-search/upgrade-from-low-search.md
7474
- name: Development
7575
items:
7676
- name: Creating your own Filter
@@ -98,7 +98,7 @@
9898
- name: Fieldtype
9999
href: add-ons/pro-variables/fieldtype.md
100100
- name: Upgrade from Low Variables
101-
href: add-ons/pro-variables/upgrade-from-low-variables.md
101+
href: add-ons/pro-variables/upgrade-from-low-variables.md
102102
- name: Development
103103
items:
104104
- name: Fieldtype Bridge
@@ -315,7 +315,7 @@
315315
href: development/architecture.md
316316
- name: Services
317317
items:
318-
- name: Addon Service
318+
- name: Add-on Service
319319
href: development/services/addon.md
320320
- name: CP/Alert Service
321321
href: development/services/alert.md
@@ -399,15 +399,15 @@
399399
items:
400400
- name: Working with Models
401401
href: development/models/working-with-models.md
402-
- name: Addon Action Model
402+
- name: Add-on Action Model
403403
href: development/models/addon-action.md
404-
- name: Addon Module Model
404+
- name: Add-on Module Model
405405
href: development/models/addon-module.md
406-
- name: Addon Extension Model
406+
- name: Add-on Extension Model
407407
href: development/models/addon-extension.md
408-
- name: Addon Fieldtype Model
408+
- name: Add-on Fieldtype Model
409409
href: development/models/addon-fieldtype.md
410-
- name: Addon Plugin Model
410+
- name: Add-on Plugin Model
411411
href: development/models/addon-plugin.md
412412
- name: Category Model
413413
href: development/models/category.md
@@ -630,7 +630,7 @@
630630
href: development/v6-add-on-migration.md
631631
- name: Automated Upgrading
632632
href: development/automated-upgrading.md
633-
633+
634634
- name: Command Line Interface (CLI)
635635
items:
636636
- name: Introduction
@@ -639,9 +639,9 @@
639639
href: cli/usage.md
640640
- name: Built In Commands
641641
items:
642-
- name: Addon Management
642+
- name: Add-on Management
643643
href: cli/built-in-commands/addons.md
644-
- name: Addon Generator
644+
- name: Add-on Generator
645645
href: cli/built-in-commands/make-addon.md
646646
- name: Clear Cache
647647
href: cli/built-in-commands/cache-clear.md
@@ -665,7 +665,7 @@
665665

666666
- name: Entry Cloning
667667
href: channels/entry_cloning.md
668-
668+
669669
- name: Front-end Content Management
670670
items:
671671
- name: Overview
@@ -680,4 +680,4 @@
680680
- name: Overview
681681
href: msm/overview.md
682682
- name: Variables and Parameter
683-
href: msm/code.md
683+
href: msm/code.md

0 commit comments

Comments
 (0)