README

A CodeIgniter 4 package that gives you a clean, driver-based abstraction for talking to AI language models. Point it at Claude, OpenAI, or Gemini — your application code stays the same regardless of which provider you use.

📖 Full Documentation →

What it does

You define a Prompt class that describes what you want the AI to do. Scribe takes care of building the system prompt, calling the right provider, and returning a normalized AIResponse you can work with in plain PHP.

<?php

// Define once
class SummarizePrompt extends BasePrompt
{
    public function __construct(private string $text) {}

    public function systemPrompt(): string
    {
        return 'You are a concise summarizer. Return a 2-sentence summary.';
    }

    public function userPrompt(): string
    {
        return 'Summarize: ' . $this->text;
    }
}

// Use anywhere in your CI4 app
$response = service('scribe')->run(new SummarizePrompt($articleText));
echo $response->content;

Key Features

• Driver-based — swap providers (Claude, OpenAI, Gemini) without touching your prompt classes
• Structured output — pass a JSON schema and get typed data back via toArray()
• Test-friendly — FakeDriver lets you unit-test prompts without any HTTP calls
• CI4-native — auto-discovered via Composer, wired into CI4's service layer; no manual wiring needed

What it isn't

• No streaming — responses are returned as a complete string, not streamed token-by-token
• No conversation management — each run() call is stateless; multi-turn chat history is your responsibility
• No agent loop — there is no built-in tool-calling or autonomous reasoning loop
• Not a full AI framework — no embeddings, RAG, vector search, or fine-tuning helpers
• Not a managed client — it does not retry, throttle, or rotate API keys on your behalf

If you need those features, this library is intentionally out of scope for them.

Requirements

• PHP 8.2+
• CodeIgniter 4.7+

Installation

Install via Composer:

composer require lonnieezell/scribe

Publish the config file so you can add your API keys:

php spark publish:config AI

Then open app/Config/AI.php and set at least one driver's apiKey:

public array $drivers = [
    'claude' => [
        'apiKey' => env('CLAUDE_API_KEY', ''),
        'model'  => 'claude-haiku-4-5',
    ],
    // ...
];

Quick Start

1. Create a Prompt class

<?php

namespace App\Prompts;

use Myth\Scribe\Prompts\BasePrompt;

class ClassifyEmailPrompt extends BasePrompt
{
    public function __construct(private string $emailBody) {}

    public function systemPrompt(): string
    {
        return 'Classify the email as spam or not_spam.';
    }

    public function userPrompt(): string
    {
        return $this->emailBody;
    }

    public function schema(): ?array
    {
        return [
            'type'       => 'object',
            'properties' => ['label' => ['type' => 'string', 'enum' => ['spam', 'not_spam']]],
            'required'   => ['label'],
        ];
    }
}

2. Run it

$response = service('scribe')->run(new ClassifyEmailPrompt($body));
$result   = $response->toArray(); // ['label' => 'spam']

3. Test it

use Myth\Scribe\Drivers\FakeDriver;

$fake = new FakeDriver(['content' => '{"label":"spam"}']);
// inject $fake into your service or swap the driver in config

Configuration

The AI config class lives at app/Config/AI.php after publishing. The key settings:

A specific prompt can override the driver at runtime:

$prompt = new SummarizePrompt($text);
$prompt->driver = 'openai';

Documentation

Full documentation — installation, core concepts, configuration, structured output, testing, and the changelog — is available at:

https://lonnieezell.github.io/scribe

Contributing

1. Fork the repo and create a feature branch.
2. Run the full CI suite before opening a PR: composer ci
3. All new code must include tests and pass PHPStan level 5.

License

MIT — see LICENSE.