PHPackages                             neosidekick/ai-assistant - 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. [Utility &amp; Helpers](/categories/utility)
4. /
5. neosidekick/ai-assistant

ActiveNeos-plugin[Utility &amp; Helpers](/categories/utility)

neosidekick/ai-assistant
========================

Use the power of GPT-4 to assist you in writing content

v2.6.1(2mo ago)226.9k↓35.5%[3 PRs](https://github.com/NEOSidekick/NEOSidekick.AiAssistant/pulls)GPL-3.0-or-laterTypeScriptPHP ^8.0CI passing

Since Mar 19Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/NEOSidekick/NEOSidekick.AiAssistant)[ Packagist](https://packagist.org/packages/neosidekick/ai-assistant)[ RSS](/packages/neosidekick-ai-assistant/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (5)Versions (45)Used By (0)

[NEOSidekick](https://neosidekick.com/) - Your Personal Writing Assistant for Neos
==================================================================================

[](#neosidekick---your-personal-writing-assistant-for-neos)

Create content drafts faster, brainstorm new ideas, and turn thoughts into brilliant text. Based on the latest findings in artificial intelligence.

Installation
------------

[](#installation)

`NEOSidekick.AiAssistant` is available via Packagist. Add `"neosidekick/ai-assistant" : "^2.5"` to the require section of the composer.json or run:

```
composer require neosidekick/ai-assistant
```

We use semantic versioning, so every breaking change will increase the major version number.

Configuration
-------------

[](#configuration)

### API Key

[](#api-key)

You can use the free version, or [get more features with a license](https://www.neosidekick.com/en/pricing). To configure your license key, add the following to your Settings.yaml:

```
NEOSidekick:
  AiAssistant:
    apikey: 'your-api-key-here'
```

### Content Language

[](#content-language)

If you're using content dimensions in your Neos setup, we will retrieve the content language from the currently active content dimension. However, if you are not using this feature of Neos, you need to define the default content language in the configuration, like this:

```
NEOSidekick:
  AiAssistant:
    defaultLanguage: 'en'
```

English (`en`) is configured out of the box. Supported languages are:

- English `en`
- English (US) `en_US`
- English (Australia) `en_AU`
- English (UK) `en_UK`
- French `fr`
- French (Belgium) `fr_BE`
- French (Switzerland) `fr_CH`
- French (France) `fr_FR`
- French (Canada) `fr_CA`
- German `de`
- German (Austria) `de_AT`
- German (Germany) `de_DE`
- German (Switzerland) `de_CH`
- Italian `it`
- Italian (Italy) `it_IT`
- Italian (Switzerland) `it_CH`
- Spanish `es`
- Spanish (Spain) `es_ES`
- Spanish (Mexico) `es_MX`
- Spanish (Argentina) `es_AR`

### Permissions

[](#permissions)

By default, every editor can use the assistant. However, if you want to restrict the access to certain roles, you can copy this configuration into your site package. It will give you an additional role `AiAssistantEditor`.

```
roles:
  'Neos.Neos:AbstractEditor':
    privileges:
      - privilegeTarget: NEOSidekick.AiAssistant:CanUse
        permission: ABSTAIN

  'NEOSidekick.AiAssistant:AiAssistantEditor':
    description: Grants access to the NEOSidekick AiAssistant sidebar
    privileges:
      - privilegeTarget: NEOSidekick.AiAssistant:CanUse
        permission: GRANT

  'Neos.Neos:Administrator':
    privileges:
      - privilegeTarget: NEOSidekick.AiAssistant:CanUse
        permission: GRANT
```

Of course, you can also define the privilege for any other role that you are using for example `Neos.Neos:Administrator`.

### Page-specific AI briefings

[](#page-specific-ai-briefings)

By default, we add the mixin `NEOSidekick.AiAssistant:Mixin.AiPageBriefing` to the Neos.Neos:Document NodeType to allow editors to fine-tune the NEOSidekick AI Assistant behavior. Advanced users can also build their own based on the [NEOSidekick YAML API](https://neosidekick.com/en/product/features/build-your-own-ai#page-specific-briefings).

[![AiPageBriefing.png](docs%2FAiPageBriefing.png)](docs%2FAiPageBriefing.png)

### ImageAltTextEditor and ImageTitleEditor

[](#imagealttexteditor-and-imagetitleeditor)

With a few simple YAML configurations, you can configure NodeType properties for image alternative text and image titles. In addition to AI generation, it also offers the option to configure classic fallbacks:

- If no text is set, use the title or description of the asset
- If that is not set, use the file name

This allows you to easily implement the same behavior in the editor and frontend. And my personal favorite: every time the image changes or is set, it automatically generates new text.

[![Image-AltText-Editor.gif](docs%2FImage-AltText-Editor.gif)](docs%2FImage-AltText-Editor.gif)

[Read the docs](https://neosidekick.com/en/developer-guide/image-description-generator)

### Image Description Generator

[](#image-description-generator)

With this tool, you can create image descriptions for the media browser and save them in the title or description field of the media asses. These help you better search for images in the media browser and can be used as fallback alternative text for an image. They are optimized as image alternative texts for SEO and accessibility.

[Read the tutorial](https://neosidekick.com/en/product/features/image-description-generator) on how create dozens of image descriptions in no time, and use them as image fallback alternative texts.

[![Alternate-Image-Text-Generator.png](docs%2FAlternate-Image-Text-Generator.png)](docs%2FAlternate-Image-Text-Generator.png)

### SEO Title and Meta Description Generator

[](#seo-title-and-meta-description-generator)

We have designed a two-step process to help you create great SEO titles and meta descriptions, that are both search engine friendly and engaging for your readers. We designed a special backend module just to ease the to make it fast and efficient.

In the first step, we look at the pages and suggest a likely focus keyword for this page.

[![Focus-Keyword-Generator.gif](docs%2FFocus-Keyword-Generator.gif)](docs%2FFocus-Keyword-Generator.gif)

Next we create SEO titles and meta description optimized for the given focus keyword.

[![SEO-Title-and-Meta-Description-Generator.gif](docs%2FSEO-Title-and-Meta-Description-Generator.gif)](docs%2FSEO-Title-and-Meta-Description-Generator.gif)

### SEO Image Alternative Text Generator

[](#seo-image-alternative-text-generator)

Images boost user engagement, but search engines can't interpret visuals—they rely on alt text.

The [Image Description Generator](#image-description-generator) helps you create effective descriptions for your media. This improves the searchability of extensive media libraries and by serving as a [fallback alternative text for images](https://neosidekick.com/en/product/features/image-description-generator) it makes your site more accessible. To craft SEO-optimized alt texts, it's crucial to understand the page content and context. The same image can need different descriptions depending on how it's used. Since Neos NodeTypes do not automatically link image attributes to alt text properties, you must [configure these details for NEOSidekick in YAML](https://neosidekick.com/produkt/features/property-text-generieren#alt-tags). After this setup, you can generate SEO-friendly alt texts directly in the Neos content editor. Here, you can also systematically apply these alt texts on bulk.

NEOSidekick can identify the most relevant pages for you and provide suggestions for each image title and alternative text of these pages.

[![SEO-Image-Alternative-Text-Generator.gif](docs%2FSEO-Image-Alternative-Text-Generator.gif)](docs%2FSEO-Image-Alternative-Text-Generator.gif)

License
=======

[](#license)

You can use it for free with our [free and paid plans](https://neosidekick.com/preise). You are not allowed to modify, reuse or resell this code. For additional feature wishes, write us an email to .

###  Health Score

51

—

FairBetter than 96% of packages

Maintenance87

Actively maintained with recent releases

Popularity30

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 53.4% 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 ~42 days

Recently: every ~121 days

Total

26

Last Release

88d ago

Major Versions

v1.6.2 → v2.0.02023-10-28

### Community

Maintainers

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

---

Top Contributors

[![gradinarufelix](https://avatars.githubusercontent.com/u/4405087?v=4)](https://github.com/gradinarufelix "gradinarufelix (117 commits)")[![rolandschuetz](https://avatars.githubusercontent.com/u/735982?v=4)](https://github.com/rolandschuetz "rolandschuetz (99 commits)")[![mhsdesign](https://avatars.githubusercontent.com/u/85400359?v=4)](https://github.com/mhsdesign "mhsdesign (2 commits)")[![krsriq](https://avatars.githubusercontent.com/u/2337648?v=4)](https://github.com/krsriq "krsriq (1 commits)")

---

Tags

aiopenaiflowNeosgptChatGptgpt-4writing

### Embed Badge

![Health badge](/badges/neosidekick-ai-assistant/health.svg)

```
[![Health](https://phpackages.com/badges/neosidekick-ai-assistant/health.svg)](https://phpackages.com/packages/neosidekick-ai-assistant)
```

###  Alternatives

[shel/neos-colorpicker

A plugin for Neos CMS which provides a colorpicker editor

1494.4k6](/packages/shel-neos-colorpicker)[shel/neos-hyphens

A plugin for Neos CMS which provides hyphens for the inline editor

20200.7k1](/packages/shel-neos-hyphens)[techdivision/ckstyles

Neos package which enables you adding your custom style classes for the CkEditor with a simple Yaml configuration

21166.3k](/packages/techdivision-ckstyles)[salehhashemi/laravel-intelli-git

An intelligent Git helper package for Laravel applications. It utilizes OpenAI's GPT to analyze your Git repository, providing features such as automatic generation of commit messages based on staged changes.

131.5k](/packages/salehhashemi-laravel-intelli-git)

PHPackages © 2026

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