Installation

Install and configure Atlas in your Laravel application.

Requirements

• PHP 8.2+
• Laravel 11, 12, or 13
• Composer

Install via Composer

composer require atlas-php/atlas

Publish Configuration

php artisan vendor:publish --tag=atlas-config

This creates config/atlas.php with all configurable options. Atlas manages its own provider configuration — no external config files needed.

Configure Provider Credentials

Add your AI provider credentials to .env:

# OpenAI
OPENAI_API_KEY=sk-...

# or Anthropic
ANTHROPIC_API_KEY=sk-ant-...

See Configuration for the full list of supported providers and their environment variables.

Verify Installation

Test that Atlas is working correctly:

$response = Atlas::text('openai', 'gpt-4o')
    ->message('Hello, Atlas!')
    ->asText();

echo $response->text; // "Hello! How can I help you?"

Quick Start

Define an Agent

use Atlasphp\Atlas\Agent;

class SupportAgent extends Agent
{
    public function provider(): ?string
    {
        return 'openai';
    }

    public function model(): ?string
    {
        return 'gpt-4o';
    }

    public function instructions(): ?string
    {
        return 'You are a helpful support agent for {company}.';
    }

    public function tools(): array
    {
        return [LookupOrderTool::class];
    }
}

Use the Agent

$response = Atlas::agent('support')
    ->withVariables(['company' => 'Acme'])
    ->message('Where is my order?')
    ->asText();

Artisan Commands

Scaffold agents and tools with Artisan:

php artisan make:agent SupportAgent
php artisan make:tool LookupOrderTool

Optional: Enable Persistence

Atlas works fully stateless by default. To enable conversation persistence and execution tracking:

php artisan vendor:publish --tag=atlas-migrations
php artisan migrate

Then set ATLAS_PERSISTENCE_ENABLED=true in your .env.

Common Issues

Provider Not Configured

If you see "Provider not configured" errors:

1. Verify the API key environment variable is set in .env
2. Check that the provider is configured in config/atlas.php under providers
3. Run php artisan config:clear after changes

Missing Dependencies

If you encounter class not found errors, ensure you've run:

composer dump-autoload

Next Steps

• Configuration — Complete configuration reference
• Agents — Build your first AI agent
• Tools — Add callable tools for agents