README

AI-powered content assistance for Statamic Bard using OpenAI

Features

AI Agent with conversational modal for multi-turn interactions with full document context
Global AI chat widget available throughout the Statamic control panel
AI completion for auto-completing text based on context
Content enhancement to improve grammar, clarity, and readability
Text summarization for creating concise summaries
Translation capabilities for multiple languages
Tone adjustment (formal, casual, professional, friendly)
Context-aware assistance that understands your page, collection, and entry
Keyboard shortcuts for quick access to AI features
Conversation history maintained across sessions

How to Install

composer require alt-design/alt-ai

Publish the configuration file:

php artisan vendor:publish --tag=alt-ai-config

This will create a configuration file at config/alt-ai.php

Configuration

API Key Setup

Get your OpenAI API key from OpenAI Platform and add it to your .env file:

OPENAI_API_KEY=your_openai_api_key_here
OPENAI_MODEL=gpt-4

Configuration Options

Edit config/alt-ai.php to customize the addon:

return [
    'api_key' => env('OPENAI_API_KEY', ''),
    
    'capabilities' => [
        'completion' => true,
        'enhancement' => true,
        'summarization' => true,
        'translation' => true,
        'tone_adjustment' => true,
    ],
    
    'model' => [
        'name' => env('OPENAI_MODEL', 'gpt-4'),
        'temperature' => 0.7,
        'max_tokens' => 2000,
    ],
];

Available OpenAI models: gpt-4 (most capable), gpt-4-turbo-preview (faster), or gpt-3.5-turbo (efficient for simpler tasks).

Usage

Enabling AI Buttons in Bard Fields

The addon registers AI toolbar buttons, but you must manually enable them in your Bard field configurations:

Open your blueprint in the Statamic Control Panel
Edit your Bard field settings
In the Buttons section, add: aiAgent, aiComplete, aiEnhance, aiSummarize
Save and refresh

Example Bard field configuration in YAML:

-
  handle: content
  field:
    type: bard
    display: Content
    buttons:
      - h2
      - h3
      - bold
      - italic
      - link
      - aiAgent      # AI conversational modal
      - aiComplete   # AI auto-complete
      - aiEnhance    # AI text enhancement
      - aiSummarize  # AI summarization

Using the AI Agent

The AI Agent button (chat bubble icon) opens a conversational modal:

Click the AI Agent button in the Bard toolbar
Ask the AI to help with your content - it has access to your full document and selected text
Example requests:
- "Make this section more formal"
- "Add more detail about the benefits"
- "Rewrite this in a more engaging tone"
- "Check for grammar and clarity issues"
Click "Apply to Editor" to insert AI-generated content

Using the Global Chat Widget

A chat widget appears in the bottom-right corner of the Statamic CP:

Context-aware: knows what page you're viewing, which collection you're editing, and entry titles
Ask for help with content creation, editing, or general Statamic questions
Conversation history saved in browser session
Click minimize to get it out of the way

Example questions:

"How should I structure this blog post?"
"Help me write a meta description for this page"
"What's a good way to phrase this call-to-action?"

Keyboard Shortcuts

Cmd/Ctrl + Space: Trigger AI completion
Cmd/Ctrl + Shift + E: Enhance selected text

Button Functions

AI Agent: Opens conversational modal for complex interactions
AI Complete: Auto-complete text from cursor position
AI Enhance: Improve grammar, clarity, and readability of selected text
AI Summarize: Generate concise summary of selected text

Programmatic Usage

Trigger AI features programmatically using editor commands:

editor.commands.aiComplete()
editor.commands.aiEnhance()
editor.commands.aiSummarize()
editor.commands.aiTranslate('es')
editor.commands.aiAdjustTone('formal')

Troubleshooting

Buttons not showing

Clear your browser cache
Run php artisan cache:clear and php please stache:clear
Refresh the control panel

API Key Issues

Ensure OPENAI_API_KEY is set correctly in .env
Check the browser console for authentication errors
Verify your OpenAI account has sufficient credits
Confirm your API key has necessary permissions

No AI Suggestions

Check your internet connection
Verify the OpenAI API is accessible
Check the browser console for API errors
Ensure you're using a valid OpenAI model

Rate Limiting

OpenAI has rate limits based on your account tier. Consider upgrading your OpenAI plan if you encounter rate limit errors.

Questions etc

Drop us a big shout-out if you have any questions, comments, or concerns. We're always looking to improve our addons, so if you have any feature requests, we'd love to hear them.

Starter Kits

Alt Starter Kit

Addons

Postcardware

Send us a postcard from your hometown if you like this addon. We love getting mail from other cool peeps!

Alt Design
St Helens House
Derby
DE1 3EE
UK

alt-design / alt-ai

Maintainers

Details