Skip to content

Installation

Getting started with Laravel AI Orbit takes less than a minute. The package auto-discovers and requires zero frontend build steps.

Requirements

Before installing, make sure your environment meets the following:

RequirementVersionNotes
PHP^8.3Required by the Laravel AI SDK
Laravel^12.0 | ^13.0Framework version
Laravel AI SDK^0.6|^0.7|^0.8laravel/ai package with migrations run
Livewire^4.0Auto-installed as a dependency

Important: The Laravel AI SDK (laravel/ai) must be installed and its migrations must have been run. Orbit reads directly from the SDK's agent_conversations and agent_conversation_messages tables.

Install via Composer

bash
composer require ashrafic/laravel-ai-orbit

After installing Orbit, publish its assets and configuration using the ai-orbit:install Artisan command. After installing Orbit, you should also run the migrate command to create the tables needed to store Orbit's data:

bash
php artisan ai-orbit:install
php artisan migrate

Orbit creates the following tables (all prefixed with orbit_):

TablePurpose
orbit_pricing_rulesEditable cost per token per model
orbit_saved_promptsPrompt library with tags and metadata
orbit_bookmarksStarred conversations
orbit_prompt_lab_sessionsPrompt Lab comparison history
orbit_budget_alertsBudget thresholds and notifications
orbit_ai_runsOne-off SDK run observability

Access the Dashboard

Visit /ai-orbit in your browser:

http://your-app.test/ai-orbit

By default, Orbit is only accessible in the local environment. See Authorization to configure access for production.

Health Check

If you see a friendly setup banner instead of the dashboard, it usually means the Laravel AI SDK tables haven't been created yet. Run:

bash
php artisan migrate

Orbit performs an automatic health check on boot and surfaces any issues clearly in the UI.

Next Steps