Skip to content
This repository was archived by the owner on Aug 15, 2023. It is now read-only.

Commit eed1fb8

Browse files
committed
[TASK] update readme
1 parent 384103d commit eed1fb8

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,51 @@
1-
## TYPO3 Extension 'coreapi' ##
1+
## TYPO3 Extension 'coreapi'
22

3-
The EXT:coreapi should provide a simple to use API for common core features.
3+
The EXT:coreapi should provide a simple to use API for common core features. Goal is to be able to do the most common tasks by CLI instead of doing it in the backend/browser.
4+
5+
Beside of CLI commands, EXT:coreapi provides service classes, which can be used in your own implementation/extension.
46

57
Checkout the project website at forge.typo3.org:
68
http://forge.typo3.org/projects/show/extension-coreapi
79

8-
### Tasks ###
10+
### Tasks
911
* DatabaseApi
1012
* databaseCompare
11-
1213
* CacheApi
1314
* clearAllCaches
1415
* clearPageCache
1516
* clearConfigurationCache
16-
1717
* ExtensionApi
1818
* info
1919
* listInstalled
2020
* updateList
21-
2221
* SiteApi
2322
* info
2423
* createSysNews
24+
25+
#### planned/comming soon
26+
27+
* Backend
28+
* manage users (list, create, update, delete)
29+
* lock/unlock the TYPO3 backend
30+
* PageTree
31+
* print/get
32+
* DataApi
33+
* generic list/create/update/delete records (and not doing the plain SQL, but using the DataHandler (aka tcemain)!)
34+
* getRecordsByPid
35+
* create a database dump (exclude "temporary" tables like caches, sys_log, ...)
36+
* ReportsApi
37+
* run/check the reports from the reports module
38+
* ConfigurationApi
39+
* list, get and set TYPO3 configurations
40+
* ExtensionApi
41+
* update an extension from TER
2542

2643
### CLI call: ###
2744

2845
Make sure you have a backend user called `_cli_lowlevel`
2946

3047
#### TYPO3 4.7+ ####
31-
If you are using TYPO3 4.7+, you can use the awesome CommandController of Extbase
48+
If you are using TYPO3 4.7+, you can use the awesome CommandController of Extbase.
3249

3350
This will show you all available calls
3451
./typo3/cli_dispatch.phpsh extbase help

0 commit comments

Comments
 (0)