Skip to content

Commit f3bd690

Browse files
Update CLI docs
1 parent 45db16b commit f3bd690

File tree

7 files changed

+109
-9
lines changed

7 files changed

+109
-9
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# make:action
2+
3+
Action Generator -- Creates a new action for an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Folder for third-party add-on you want to add action to
11+
```
12+
13+
## Examples:
14+
15+
### Generating an action:
16+
17+
`php eecli.php make:action MyNewAction --addon=my_existing_addon`

docs/cli/built-in-commands/make-addon.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ Check out our video tutorial generating an add-on!
3434
-e <value>
3535
Add-on has settings (yes/no)
3636
37+
--compatibility-mode
38+
-p
39+
Generate add-on that is compatible with ExpressionEngine versions lower than 7.2.0 and lower than 6.4.0
40+
3741
--version=<value>
3842
-v <value>
3943
Version of the add-on
@@ -86,3 +90,7 @@ Check out our video tutorial generating an add-on!
8690

8791
`php eecli.php make:addon my_awesome_mod --mod --description "Description of addon" --version="1.0.0" --author="Joe Shmoe" --author-url='www.example.com' --has-settings='yes'`
8892

93+
### Generating a module in compatibility mode:
94+
95+
`php eecli.php make:addon my_awesome_mod --mod --description "Description of addon" --version="1.0.0" --author="Joe Shmoe" --author-url='www.example.com' --has-settings='yes' --compatibility-mode`
96+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# make:extension-hook
2+
3+
Extension Hook Generator -- Implements an EE extension hook in an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Folder for third-party add-on you want to add extension hook to
11+
```
12+
13+
## Examples:
14+
15+
### Implementing the sessions_start extension hook:
16+
17+
`php eecli.php make:extension-hook sessions_start --addon=my_existing_addon`
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# make:tag
2+
3+
Tag Generator -- Creates a new tag for an add-on
4+
5+
## Options list:
6+
7+
```
8+
--addon=<value>
9+
-a <value>
10+
Folder for third-party add-on you want to add tag to
11+
```
12+
13+
## Examples:
14+
15+
### Generating a new tag:
16+
17+
`php eecli.php make:tag MyNewTag --addon=my_existing_addon`

docs/cli/built-in-commands/make-widget.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# make:prolet
1+
# make:widget
22

33
Widget Generator -- Creates a new Dashboard Widget for an add-on
44

@@ -13,6 +13,6 @@ Widget Generator -- Creates a new Dashboard Widget for an add-on
1313

1414
## Examples:
1515

16-
### Generating a prolet:
16+
### Generating a widget:
1717

1818
`php eecli.php make:widget MyNewWidget --addon=my_existing_addon`
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# sync:conditional-fields
2+
3+
Sync Conditional Field Logic -- Checks each channel entry to see if its connditional logic is correct. If it is not, it updates the conditional logic and saves the entry.
4+
5+
## Options list:
6+
7+
```
8+
--channel_id=<value>
9+
-c <value>
10+
Channel ID to sync. Defaults to all channels
11+
12+
--verbose
13+
-v
14+
Verbose
15+
16+
--clear
17+
-x
18+
Clear
19+
```
20+
21+
## Examples:
22+
23+
### Sync all conditional fields:
24+
25+
`php eecli.php sync:conditional-fields`
26+
27+
### Sync conditional fields for channel_id 1 in verbose mode:
28+
29+
`php eecli.php sync:conditional-fields --channel_id=1 -v`

docs/cli/intro.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,28 @@ By default the CLI is located `system/ee/eecli.php` .
88

99
- [Basic Usage](cli/usage.md)
1010
- Built In Commands
11-
- [Addon Generator](cli/built-in-commands/make-addon.md)
1211
- [Clear Cache](cli/built-in-commands/cache-clear.md)
13-
- [Command Generator](cli/built-in-commands/make-command.md)
14-
- [Generating a migration](cli/built-in-commands/migrate.md)
1512
- [List](cli/built-in-commands/list.md)
16-
- [Make migration](cli/built-in-commands/make-migration.md)
17-
- [Model Generator](cli/built-in-commands/make-model.md)
13+
- Make
14+
- [make:action - Creates a new action for an add-on](cli/built-in-commands/make-action.md)
15+
- [make:addon - Creates a new add-on](cli/built-in-commands/make-addon.md)
16+
- [make:command - Creates a new CLI command for an add-on](cli/built-in-commands/make-command.md)
17+
- [make:extension-hook - Implements an EE extension hook in an add-on](cli/built-in-commands/make-extension-hook.md)
18+
- [make:migration - Creates a new migration](cli/built-in-commands/make-migration.md)
19+
- [make:model - Creates a new model for an add-on](cli/built-in-commands/make-model.md)
20+
- [make:prolet - Creates a new prolet for an add-on](cli/built-in-commands/make-prolet.md)
21+
- [make:tag - Creates a new tag for an add-on](cli/built-in-commands/make-tag.md)
22+
- [make:widget - Generates widgets for existing add-ons](cli/built-in-commands/make-widget.md)
23+
- Migrate
24+
- [migrate - Runs specified migrations (all, core, or add-ons)](cli/built-in-commands/migrate.md)
25+
- [migrate:addon - Runs add-on migrations](cli/built-in-commands/migrate.md)
26+
- [migrate:all - Runs core migrations, then each add-on's migrations](cli/built-in-commands/migrate.md)
27+
- [migrate:core - Runs core migrations](cli/built-in-commands/migrate.md)
28+
- [migrate:reset - Rolls back all migrations](cli/built-in-commands/migrate.md)
29+
- [migrate:rollback - Rolls back most recent migration group](cli/built-in-commands/migrate.md)
30+
- Sync
31+
- [sync:conditional-fields - Sync channel entry conditional logic](cli/built-in-commands/sync-conditional-fields.md)
1832
- [Update ExpressionEngine](cli/built-in-commands/update.md)
19-
- [Prolet Generator](cli/built-in-commands/make-prolet.md)
20-
- [Widget Generator](cli/built-in-commands/make-widget.md)
2133
- [Creating a Command](cli/creating-a-command.md)
2234
- [Defining Input](cli/defining-input.md)
2335
- [Displaying Output](cli/displaying-output.md)

0 commit comments

Comments
 (0)