Skip to content
TYPO3Dev Companion

It answers before it guesses

A local server for the three audiences that do TYPO3 work. Every answer names the source it came from and the versions it holds for.

Install

It runs as a subprocess of your client. It needs PHP 8.2 or newer and nothing else — no daemon, no database, and no network unless a tool asks docs.typo3.org for a page.

bash 
# standalone: clone, install once
$ composer install
✓ published 9 task skills to .agents/skills

Settings

What a project has to set, and what it can leave alone. One entry per value: the name it goes under, the facts a machine checks, and a sentence that says what happens either way.

siteTitle required #
type
string
default
"TYPO3"
The name the site calls itself — the browser tab, the header lockup, and the fallback for any page that declares no title of its own.
cache.lifetime #
type
int
default
86400
unit
seconds
How long a rendered page can come from cache. 0 disables caching, which is a development setting and never a production one.

Before you file an issue

The three questions the install step raises, kept on the page it raises them on. Folded, because a reader who has none of them reads the next section instead of three answers on the way past.

The client starts it and nothing registers
The binary ran with a PHP older than 8.2 and exited before it announced anything. Run php -v as the client runs it — a shell and a desktop client rarely have the same one.
It answers, but not about my installation
It found nothing to read. The server takes the project root as an argument and falls back to bundled knowledge without it, which is the answer you get.
A tool says the installation did not boot
It read the package registry from disk instead, and the answer says so rather than looks complete: every declared package is in it and none of the ones registered at run time.

Next

The signpost at the end of an overview, and the one place a card wall belongs: four ways on, read down as one block rather than compared as four things.

The tool surface

Every tool the server registers, the question it takes and what it answers with.

Read the reference

The bundled knowledge

What ships inside the package, how it takes a version, and what it is not.

See what is in it

Writing a task skill

The shape of a skill, and the one rule that decides if it earns a file.

Write one