README

AI-powered components for Laravel applications built with Accelade. Add intelligent search, chat interfaces, and contextual AI assistants to your application with minimal setup.

Features

Global Search - macOS Spotlight-like search with AI enhancement (Cmd+K / Ctrl+K)
AI Chat - Full-featured ChatGPT-like chat interface with streaming responses
Copilot Widget - Floating AI assistant that understands page context
Multi-Provider Support - OpenAI, Anthropic (Claude), and Google Gemini
Framework Agnostic - Works with vanilla JS, Vue, React, Svelte, and Angular
Streaming Responses - Real-time streaming for better UX
Context Awareness - Copilot can read and understand page content

Requirements

PHP 8.2+
Laravel 11.0+ or 12.0+
Accelade ^1.0

Installation

composer require accelade/ai

Configuration

Publish the configuration file:

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

Add your API keys to .env:

# OpenAI (GPT-4, GPT-3.5)
OPENAI_API_KEY=your-openai-key

# Anthropic (Claude)
ANTHROPIC_API_KEY=your-anthropic-key

# Google AI (Gemini)
GOOGLE_AI_API_KEY=your-google-key

Quick Start

Add AI components to your Blade layout:

{{-- Global Search - Opens with Cmd+K (Mac) or Ctrl+K (Windows/Linux) --}}
<x-ai-global-search />

{{-- Full Chat Interface --}}
<x-ai-chat />

{{-- Floating Copilot Widget --}}
<x-ai-copilot />

Or use Blade directives:

@aiGlobalSearch
@aiChat
@aiCopilot

Documentation

For detailed documentation, see the docs folder:

Overview - Getting started and basic concepts
Configuration - All configuration options
Global Search - Spotlight-like search component
AI Chat - ChatGPT-style chat interface
Copilot - Contextual AI assistant widget
Providers - AI provider configuration and usage

Components

Global Search

A spotlight-like search modal combining traditional search with AI-powered queries:

<x-ai-global-search
    :keyboard-shortcut="'cmd+k'"
    :placeholder="'Search or ask anything...'"
    :use-ai="true"
/>

AI Chat

A full-featured chat interface with streaming responses:

<x-ai-chat
    provider="openai"
    model="gpt-4o"
    :streaming="true"
    :show-sidebar="true"
/>

Copilot Widget

A floating assistant that can read and understand page context:

<x-ai-copilot
    position="bottom-right"
    :read-context="true"
    :keyboard-shortcut="'cmd+shift+k'"
/>

PHP API

Use the AI facade for programmatic access:

use Accelade\AI\Facades\AI;

// Use the default provider
$response = AI::chat([
    ['role' => 'user', 'content' => 'Hello!']
]);

// Use a specific provider
$response = AI::provider('anthropic')->chat([
    ['role' => 'user', 'content' => 'Hello!']
]);

// Stream responses
foreach (AI::stream($messages) as $chunk) {
    echo $chunk;
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CODE_OF_CONDUCT for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

accelade / ai

Maintainers

Details