Download the PHP package oliverkroener/ok-ai-writer without Composer

On this page you can find all versions of the php package oliverkroener/ok-ai-writer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Informations about the package ok-ai-writer

AI Writer for CKEditor (ok_ai_writer)

TYPO3 12 TYPO3 13 TYPO3 14 PHP 8.1+ CKEditor 5 License: GPL v2+ Version

TYPO3 extension that adds CKEditor 5 toolbar buttons for AI text generation, AI translation, and Lorem Ipsum insertion. Supports both Azure OpenAI and OpenAI (ChatGPT) APIs with per-site configuration and encrypted credential storage.

Features

AI Text Generator

AI Translate

Lorem Ipsum

Per-Site Configuration

Dark Mode Support

Credential Handling

Requirements

Installation

Composer (recommended)

Local path repository

Add the package to your repositories and require sections in composer.json:

Then run:

Activate the extension

The database:updateschema step creates the tx_okaiwriter_configuration table used for per-site credential storage.

Configuration

Global Extension Configuration

Open Admin Tools > Settings > Extension Configuration > ok_ai_writer to set the global defaults:

Setting Type Default Description
devMode boolean false Allow editors to override credentials in localStorage
mode select azure AI provider: azure or openai
apiUrl string API endpoint URL
apiKey string API key (displayed blinded to editors)
model string gpt-4o Model name (OpenAI mode only, ignored for Azure)

These values serve as the global fallback for sites without per-site configuration.

Per-Site Configuration (Backend Module)

Navigate to Web > AI Writer in the TYPO3 backend and select a page from the page tree. The module resolves the site root and lets you configure credentials per site:

If no per-site configuration is set, the global extension configuration is used as fallback. The module displays an info banner when the global fallback is active.

Note: The backend module requires admin access and a configured TYPO3 site for the selected page.

RTE Preset Setup

Import the AI Writer YAML into your custom RTE preset and add aiText, aiTranslate, and loremIpsum to your toolbar:

Register your preset in ext_localconf.php:

And activate it via page TSconfig:

Provider Setup

Azure OpenAI

  1. Create an Azure OpenAI resource in the Azure Portal
  2. Deploy a model (e.g. gpt-4, gpt-4o, gpt-35-turbo)
  3. Set mode = azure, apiUrl to your deployment endpoint, apiKey to your Azure key
  4. Endpoint URL format:

OpenAI (ChatGPT)

  1. Create an API key at platform.openai.com
  2. Set mode = openai, apiUrl = https://api.openai.com/v1/chat/completions, apiKey to your sk-... key
  3. Set model to the desired model (e.g. gpt-4o, gpt-4, gpt-3.5-turbo)

Architecture

Configuration Resolution

File Structure

License

GPL-2.0-or-later

Author

Oliver Kroeneroliver-kroener.de[email protected]


All versions of ok-ai-writer with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
typo3/cms-core Version ^12.4 || ^13 || ^14
typo3/cms-rte-ckeditor Version ^12.4 || ^13 || ^14
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package oliverkroener/ok-ai-writer contains the following files

Loading the files please wait ...