Download the PHP package bmorg/ai_proofread without Composer
On this page you can find all versions of the php package bmorg/ai_proofread. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bmorg/ai_proofread
More information about bmorg/ai_proofread
Files in bmorg/ai_proofread
Package ai_proofread
Short Description AI-assisted proofreading of TYPO3 page content
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ai_proofread
AI Proof Reader for Typo3
AI-assisted proofreading for TYPO3 page content. Detects issues like spelling, punctuation, grammar, gender-inclusive language, style. Results are shown in a dedicated report, where suggestions can be applied to the content with one click.
Status: alpha. Works and is in production use on TYPO3 11, but has not been widely tested. See "Limitations" below. If you are using this, please report any issues!
Limitations
This is an early exploratory version with quite some limitations:
- German content only. The A.I. prompt was optimized over multiple iterations for German language content.
- Single backend: OpenRouter The general idea is to support generic OpenAI-compatible backends, but I have not been able to test this with anything other than OpenRouter yet. The extension currently relies on a strict JSON output format.
- Single page language only. So far, only L=0 is checked.
- No workspace support. The extension reads and reports on live content only; workspaces are ignored and untested.
- Only tested on Typo3 11. Targets Typo3 11-13, but 12-13 are thus untested.
How it works
-
Access the new module "KI-Lektorat" from any page:
-
Checks need to be scheduled ("Report erstellen"). Depending on settings the check can take multiple minutes.
-
When ready, the report is automatically shown:
- Findings can be auto-applied (where possible), marked as manually applied or discarded.
- When done, mark the report as "Geprüft" to update the header icon and statistics.
Installation
- TYPO3: 11.5 / 12.4 / 13.4 · PHP: 8.2+
Or download via Github Releases.
In the TYPO3 backend:
- Database tables are created on install.
- Adapt extension configuration (see below).
- Scheduler task Register the command
aiproofread:process-queueas a recurring Scheduler task (every 60s).
Configuration
1. Extension settings
Admin Tools → Settings → Extension Configuration → ai_proofread
Fill in at least the provider settings. Recommended:
| Setting | Value |
|---|---|
baseUrl |
https://openrouter.ai/api/v1 |
apiKey |
sk-or-… |
requestTimeout |
|
maxConcurrency |
|
useMock |
0 |
2. Model configuration (KI-Lektorat → Dropdown: Einstellungen)
Model selection
Ships with a set of preconfigured models.
The current prompt was tested against a set of ~25 frontier models with a sample page and scored against a set of expected finds (+ false-positives).
| Preset | Findings |
|---|---|
| Claude Opus 4.8 (default) | finds most errors; no false positives; sightly cheaper than Sol |
| GPT 5.6 Sol | found all must-finds; low false positives; costly |
| Claude Fable 5 | found all must-finds; low false positives; prohibitively costly (~3× Sol) |
| GPT 5.6 Luna | finds most errors; few false positives; fast; cheap (0.2× Sol) |
Recommendations:
- Reasoning on gives much better results (slower and more expensive).
- Pin a provider (e.g.
anthropic) if the default routing lands on providers that e.g. don't return the required JSON.
Prompt config
| Setting | Value |
|---|---|
siteDescription |
For better context |
extraPromptInstructions |
Allows adding of custom rules |
enableGenderInclusiveLanguage |
1 |
genderInclusiveStyle |
E.g. "Nutzer/innen" |
Recommendations:
- When using
extraPromptInstructions, use strict language, e.g. "Korrigiere NIE Anführungszeichen". Permissive wording ("kann ignoriert werden") will get ignored by some models.
Development
This is an exercise in vibe-coding. Fully developed by Claude Code (Opus 4.8 and Fable 5) - heavily guided and reviewed, but almost no code was handwritten.
Contributions are welcome, although some form of human involvement is much encouraged.
License
MIT — see LICENSE.
All versions of ai_proofread with dependencies
ext-dom Version *
ext-libxml Version *
ext-mbstring Version *
typo3/cms-core Version ^11.5 || ^12.4 || ^13.4
typo3/cms-backend Version ^11.5 || ^12.4 || ^13.4
typo3/cms-fluid Version ^11.5 || ^12.4 || ^13.4
guzzlehttp/guzzle Version ^7.0
guzzlehttp/psr7 Version ^1.7 || ^2.0
psr/http-message Version ^1.0 || ^2.0