cline/laravel-scout-opensearch

Laravel Scout custom engine for OpenSearch

1.0.0 2026-06-30 12:11 UTC

Requires

• php: ^8.5.0
• ext-json: *
• laravel/scout: ^11.0 || ^12.0
• opensearch-project/opensearch-php: ^2.4

Requires (Dev)

• cline/coding-standard: ^4.0.0
• ergebnis/composer-normalize: ^2.50.0
• larastan/larastan: ^3.7
• mockery/mockery: ^1.6.12
• orchestra/testbench: ^10.9
• pestphp/pest: ^4.4.1
• pestphp/pest-plugin-laravel: ^4.1
• pestphp/pest-plugin-type-coverage: ^4.0.3
• php-http/discovery: ^1.20
• phpstan/phpstan-mockery: ^2.0
• react/promise: ^3.3
• symfony/var-dumper: ^7.4.6 || ^8.0

MIT

• Brian Faust

• php

README

laravel-scout-opensearch

Laravel Scout custom engine for OpenSearch

Requirements

Requires PHP 8.5+

Installation

composer require cline/laravel-scout-opensearch

Documentation

• Getting Started - Installation and Scout setup
• Configuration - OpenSearch client and Scout options
• Basic Usage - Search, filters, sorting, and callbacks
• Query Behavior - How Scout queries map to OpenSearch
• Testing - Local and CI verification commands
• Troubleshooting - Common cluster and indexing issues

Usage

use App\Models\Product;

$results = Product::search('headphones')
    ->where('is_active', true)
    ->orderBy('id', 'desc')
    ->get();

Change log

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

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please use the GitHub security reporting form rather than the issue queue.

Credits

• Brian Faust
• All Contributors

License

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