PHPackages                             etobi/coreapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. etobi/coreapi

AbandonedArchivedTypo3-cms-extension[CLI &amp; Console](/categories/cli)

etobi/coreapi
=============

Provides 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.

1.3.0(10y ago)6144.0k37[25 issues](https://github.com/TYPO3-coreapi/ext-coreapi/issues)[1 PRs](https://github.com/TYPO3-coreapi/ext-coreapi/pulls)PHP

Since May 30Pushed 7y ago2 watchersCompare

[ Source](https://github.com/TYPO3-coreapi/ext-coreapi)[ Packagist](https://packagist.org/packages/etobi/coreapi)[ RSS](/packages/etobi-coreapi/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (7)DependenciesVersions (9)Used By (0)

[![Stories in Ready](https://camo.githubusercontent.com/b18ca2946c88911f5b23d361f89db3bcbbe8ba89e405bf66e33d39325c43148e/68747470733a2f2f62616467652e776166666c652e696f2f7479706f332d636f72656170692f6578742d636f72656170692e706e673f6c6162656c3d7265616479267469746c653d5265616479)](https://waffle.io/typo3-coreapi/ext-coreapi) [![Build Status](https://camo.githubusercontent.com/705b64513f2b02aa38d8926a67df4b51dcf81a56f211599db7b6ecd659c867d6/68747470733a2f2f7472617669732d63692e6f72672f5459504f332d636f72656170692f6578742d636f72656170692e7376673f6272616e63683d666561747572652532464d616b65457874656e73696f6e417069436f6d70617469626c65546f3632)](https://travis-ci.org/TYPO3-coreapi/ext-coreapi) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/a0116f3a87bd90522bc9bfe7270ed598043580df50a6ae07c19a60cd99e5636c/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f5459504f332d636f72656170692f6578742d636f72656170692f6261646765732f7175616c6974792d73636f72652e706e673f623d666561747572652532464d616b65457874656e73696f6e417069436f6d70617469626c65546f3632)](https://scrutinizer-ci.com/g/TYPO3-coreapi/ext-coreapi/?branch=feature%2FMakeExtensionApiCompatibleTo62) [![Code Coverage](https://camo.githubusercontent.com/3b7802842e9968d79539450942a4600e3c674ea885b155b4066050d581153506/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f5459504f332d636f72656170692f6578742d636f72656170692f6261646765732f636f7665726167652e706e673f623d666561747572652532464d616b65457874656e73696f6e417069436f6d70617469626c65546f3632)](https://scrutinizer-ci.com/g/TYPO3-coreapi/ext-coreapi/?branch=feature%2FMakeExtensionApiCompatibleTo62)

TYPO3 Extension 'coreapi'
-------------------------

[](#typo3-extension-coreapi)

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.

Beside of CLI commands, EXT:coreapi provides service classes, which can be used in your own implementation/extension.

Checkout the project website at forge.typo3.org:

### Tasks

[](#tasks)

- DatabaseApi
    - databaseCompare
- CacheApi
    - clearAllCaches
    - clearPageCache
    - clearConfigurationCache
- ExtensionApi
    - info
    - listInstalled
    - updateList from TER
    - fetch an extension from TER
    - import an extension
    - install / uninstall extension
    - create upload folders
    - configure extension
- SiteApi
    - info
    - createSysNews

#### planned/comming soon

[](#plannedcomming-soon)

- Backend
    - manage users (list, create, update, delete)
    - lock/unlock the TYPO3 backend
- PageTree
    - print/get
- DataApi
    - generic list/create/update/delete records (and not doing the plain SQL, but using the DataHandler (aka tcemain)!)
    - getRecordsByPid
    - create a database dump (exclude "temporary" tables like caches, sys\_log, ...)
- ReportsApi
    - run/check the reports from the reports module
- ConfigurationApi
    - list, get and set TYPO3 configurations

### CLI call:

[](#cli-call)

Make sure you have a backend user called `_cli_lowlevel`

If you want to use the cache clearing commands, you need to add the following snippet to the TSconfig field of this backend user:

```
options.clearCache.all=1
options.clearCache.pages=1

```

#### TYPO3 6.2 and below

[](#typo3-62-and-below)

Support for TYPO3 CMS below 6.2 was removed with version 0.2.0 of this extension. In case you need to use ext:coreapi in combination with lower version of TYPO3 CMS use version [0.1.0-beta](https://github.com/TYPO3-coreapi/ext-coreapi/releases/tag/0.1.0-beta "0.1.0-beta").

#### TYPO3 6.2+

[](#typo3-62)

If you are using TYPO3 6.2+, you can use the awesome CommandController of Extbase.

This will show you all available calls ./typo3/cli\_dispatch.phpsh extbase help

### Usage in Composer

[](#usage-in-composer)

```
{
    "name": "typo3cms/test-website",
    "description": "TYPO3 CMS: test.com",
    "keywords": ["typo3", "cms"],
    "require": {
        "php": ">=5.3.3",
        "typo3core/cms": "*",
        "etobi/coreapi": "dev-master",
    },
    "extra": {
        "installer-paths": {
            "typo3conf/ext/{$name}": [
                "type:typo3-cms-extension"
            ]
        }
    },
    "minimum-stability": "dev",
    "require-dev": {},
    "scripts": {}
}

```

### Running the unit tests

[](#running-the-unit-tests)

The Unit Tests rely on [vfsStream](https://github.com/mikey179/vfsStream "vfsStream"). For some reasons ext:coreapi don't add this dependencies by itself but uses the one which is alread defined for Core Unit Tests. To install vfsStream copy the composer.json from the TYPO3 CMS package into you webroot folder and execute the command `composer install`. This will install all dependencies into Packages/Libraries/.

Then run the Unit Tests.

```
cp typo3_src/composer.json .
composer install
./bin/phpunit --colors -c typo3/sysext/core/Build/UnitTests.xml typo3conf/ext/coreapi/Tests/Unit/

```

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance12

Infrequent updates — may be unmaintained

Popularity39

Limited adoption so far

Community25

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 69.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~121 days

Recently: every ~140 days

Total

6

Last Release

3765d ago

Major Versions

0.1.0-beta → 1.0.0-beta2014-07-13

### Community

Maintainers

![](https://www.gravatar.com/avatar/630fea7235adb809ecdb88d9245986f5c3a82c4b0b036967d95872a566ac2900?d=identicon)[etobi](/maintainers/etobi)

![](https://www.gravatar.com/avatar/b6aaf47df633cf9e260061e733e6cb82af4dabde0023bbcd2096dac330f41eb9?d=identicon)[Konafets](/maintainers/Konafets)

---

Top Contributors

[![etobi](https://avatars.githubusercontent.com/u/152207?v=4)](https://github.com/etobi "etobi (58 commits)")[![georgringer](https://avatars.githubusercontent.com/u/1905663?v=4)](https://github.com/georgringer "georgringer (6 commits)")[![bmoex](https://avatars.githubusercontent.com/u/2414665?v=4)](https://github.com/bmoex "bmoex (3 commits)")[![7elix](https://avatars.githubusercontent.com/u/878514?v=4)](https://github.com/7elix "7elix (2 commits)")[![oliverklee](https://avatars.githubusercontent.com/u/765746?v=4)](https://github.com/oliverklee "oliverklee (2 commits)")[![Konafets](https://avatars.githubusercontent.com/u/363363?v=4)](https://github.com/Konafets "Konafets (2 commits)")[![smichaelsen](https://avatars.githubusercontent.com/u/912435?v=4)](https://github.com/smichaelsen "smichaelsen (2 commits)")[![thomashohn](https://avatars.githubusercontent.com/u/3414869?v=4)](https://github.com/thomashohn "thomashohn (1 commits)")[![waffle-iron](https://avatars.githubusercontent.com/u/6912981?v=4)](https://github.com/waffle-iron "waffle-iron (1 commits)")[![christophlehmann](https://avatars.githubusercontent.com/u/4953689?v=4)](https://github.com/christophlehmann "christophlehmann (1 commits)")[![DanielSiepmann](https://avatars.githubusercontent.com/u/354250?v=4)](https://github.com/DanielSiepmann "DanielSiepmann (1 commits)")[![greinerdavid](https://avatars.githubusercontent.com/u/3600696?v=4)](https://github.com/greinerdavid "greinerdavid (1 commits)")[![jdreesen](https://avatars.githubusercontent.com/u/424602?v=4)](https://github.com/jdreesen "jdreesen (1 commits)")[![jmverges](https://avatars.githubusercontent.com/u/2902073?v=4)](https://github.com/jmverges "jmverges (1 commits)")[![madsbrunn](https://avatars.githubusercontent.com/u/213785?v=4)](https://github.com/madsbrunn "madsbrunn (1 commits)")

---

Tags

cliextensiontypo3deploymentcommandline

### Embed Badge

![Health badge](/badges/etobi-coreapi/health.svg)

```
[![Health](https://phpackages.com/badges/etobi-coreapi/health.svg)](https://phpackages.com/packages/etobi-coreapi)
```

###  Alternatives

[helhum/typo3-console

A reliable and powerful command line interface for TYPO3 CMS

2939.0M192](/packages/helhum-typo3-console)[b13/make

Kickstarter CLI tool for various TYPO3 functionalities

47250.0k1](/packages/b13-make)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
