Appearance

Configuration ​

Orbit works out of the box with sensible defaults, but every aspect can be customized via the published config file.

Publish the Config ​

bash
php artisan vendor:publish --tag=ai-orbit-config

This creates config/ai-orbit.php in your application.

Config Reference ​

Dashboard Path ​

php
'path' => env('AI_ORBIT_PATH', 'ai-orbit'),

The URI prefix where the Orbit dashboard is accessible. Change this to anything you like:

php
'path' => 'admin/ai-orbit',    // Accessible at /admin/ai-orbit
'path' => 'debug/ai',          // Accessible at /debug/ai

Authentication Guard ​

php
'auth_guard' => env('AI_ORBIT_GUARD', 'web'),

The authentication guard used when checking access. Defaults to your application's web guard.

Route Middleware ​

php
'middleware' => ['web'],

Middleware applied to all Orbit routes. The web middleware is always included automatically. Add auth or custom middleware here:

php
'middleware' => ['web', 'auth', 'verified'],

Custom Domain ​

php
'domain' => env('AI_ORBIT_DOMAIN', null),

Set a custom subdomain for Orbit routes. Leave null to use the same domain as your application.

php
'domain' => 'orbit.myapp.test',

Back to App URL ​

php
'back_to_app_url' => env('AI_ORBIT_BACK_TO_APP_URL', '/'),

The target URL for the "Back to App" link in the Orbit header.

Agent Discovery ​

php
'agent_directories' => [
    'app/AI/Agents',
    'app/Ai/Agents',
],

Directories that Orbit scans to discover agent classes. Paths are relative to your application's base path. Orbit uses PHP's tokenizer to extract class names without loading the files.

php
'agent_directories' => [
    'app/AI/Agents',
    'app/Domain/Agents',
    'modules/*/Agents',
],

Registry Cache TTL ​

php
'registry_cache_ttl' => 3600,

Number of seconds to cache discovered agent metadata. Set to 0 to disable caching entirely. The cache stores:

  • Discovered agent class names
  • Per-agent metadata (instructions, tools, temperature, schema support)

Clear the cache with:

php
app(\Ashrafic\AiOrbit\Contracts\AgentRegistryContract::class)->refresh();

Currency ​

php
'currency' => env('ORBIT_CURRENCY', 'USD'),
'currency_symbol' => env('ORBIT_CURRENCY_SYMBOL', '$'),

The default currency and symbol used for cost calculations and display throughout the dashboard.

Budget Monitoring ​

php
'budget' => [
    'enabled' => env('ORBIT_BUDGET_ENABLED', true),
    'notification_channels' => ['mail'],
],

Configure the budget alert system. Notifications are dispatched via Laravel's queue system (non-blocking) so they never slow down requests.

Prompt Lab ​

php
'prompt-lab' => [
    'max_slots' => (int) env('ORBIT_PROMPT_LAB_MAX_SLOTS', 3),
    'timeout_seconds' => (int) env('ORBIT_PROMPT_LAB_TIMEOUT', 120),
],

Settings for the Prompt Lab comparison feature:

  • max_slots — Maximum number of provider+model combinations per comparison (default: 3)
  • timeout_seconds — Request timeout per comparison slot (default: 120)

Sandbox ​

php
'sandbox' => [
    'records_per_picker' => 20,
],

Controls the number of records shown in Eloquent model picker dropdowns within the Agent Sandbox.

Export ​

php
'export' => [
    'pest_namespace' => env('ORBIT_PEST_NAMESPACE', 'Tests\\Feature\\AI'),
    'json_format' => env('ORBIT_JSON_FORMAT', 'openai'),
],

Settings for conversation export:

  • pest_namespace — Namespace used when generating Pest test files
  • json_format — Format for JSON exports (openai for fine-tuning)

Audit ​

php
'audit' => [
    'enabled' => env('ORBIT_AUDIT_ENABLED', true),
    'retention_days' => (int) env('ORBIT_RETENTION_DAYS', 90),
],

Security audit and compliance settings:

  • enabled — Toggle for PII scanning and data retention features
  • retention_days — Default data retention period for automatic cleanup

Environment Variables ​

You can control most settings via .env:

env
AI_ORBIT_PATH=ai-orbit
AI_ORBIT_GUARD=web
AI_ORBIT_DOMAIN=null
AI_ORBIT_BACK_TO_APP_URL=/

ORBIT_CURRENCY=USD
ORBIT_CURRENCY_SYMBOL=$

ORBIT_BUDGET_ENABLED=true
ORBIT_PROMPT_LAB_MAX_SLOTS=3
ORBIT_PROMPT_LAB_TIMEOUT=120

ORBIT_PEST_NAMESPACE="Tests\\Feature\\AI"
ORBIT_JSON_FORMAT=openai

ORBIT_AUDIT_ENABLED=true
ORBIT_RETENTION_DAYS=90

Programmatic Access ​

Use the OrbitConfig support class to read configuration safely:

php
use Ashrafic\AiOrbit\Support\OrbitConfig;

OrbitConfig::path();           // 'ai-orbit'
OrbitConfig::guard();          // 'web'
OrbitConfig::middleware();     // ['web']
OrbitConfig::agentDirs();      // ['/path/to/app/AI/Agents', ...]
OrbitConfig::domain();         // null
OrbitConfig::registryCacheTtl(); // 3600
OrbitConfig::backToAppUrl();   // '/'

All methods return sensible defaults if the config file hasn't been published.