PHPackages                             ubeeqo/laravel-scout-settings - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. ubeeqo/laravel-scout-settings

ActiveLibrary[Search & Filtering](/categories/search)

ubeeqo/laravel-scout-settings
=============================

Import/Export Algolia settings into your Laravel Scout project

2.0.1(7y ago)029MITPHP

Since Jul 6Pushed 7y ago1 watchersCompare

[ Source](https://github.com/ubeeqo/laravel-scout-settings)[ Packagist](https://packagist.org/packages/ubeeqo/laravel-scout-settings)[ RSS](/packages/ubeeqo-laravel-scout-settings/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (5)Versions (6)Used By (0)

Laravel Scout Settings
======================

[](#laravel-scout-settings)

**Import/Export Algolia settings, synonyms and query rules into your Laravel Scout project.**

The easiest way to manage your settings is usually to go to your Algolia dashboard because it has a nice UI and you can test the relevancy directly there.

Once you fine tuned your configuration, you may want to add it to your project.

This package adds two Laravel commands to your project:

- one to save your settings, synonyms and query rules into JSON files
- one to push everything back to Algolia

This has 3 major advantages:

1. You can version your configuration with your VCS
2. You can set up a new environment or restore backups easily
3. It lets you customize your settings in JSON format before pushing them

Install
-------

[](#install)

Install this package with composer

```
composer require algolia/laravel-scout-settings
```

#### Laravel 5.5

[](#laravel-55)

If you use Laravel 5.5, this package will take advantage of the [Package Auto-Discovery](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518) feature. Nothing more to do to register the commands.

#### Laravel 5.4 and prior

[](#laravel-54-and-prior)

If you use an older version of Laravel, you will have to add the Service Provider to the `providers` array in `config/app.php`

```
Algolia\Settings\ServiceProvider::class,
```

Usage
-----

[](#usage)

You will now get two new commands available in `artisan`. They both take a model's fully qualified class name, just like Laravel Scout does to import/flush data.

The following example assume you have an `App\Contact` class, which uses the `Searchable` trait.

Note: Scout allows you to customize the index name with the [`searchableAs()`](https://laravel.com/docs/scout#configuring-model-indexes) method. This package will follow this naming convention.

### Backing up settings (Project ⬅️ Algolia)

[](#backing-up-settings-project-️-algolia)

The following command will export all the settings and synonyms from the `App\Contact`'s index into the following files:

- **Settings**: `resources/algolia-settings/index_name.json`
- **Synonyms**: `resources/algolia-settings/index_name-synonyms.json`
- **Query Rules**: `resources/algolia-settings/index_name-rules`

```
php artisan algolia:settings:backup "App\Contact"

```

Note that if you want to add the prefix to your file names (which was the default behavior in v1), you can pass the `--prefix` option.

```
php artisan algolia:settings:backup "App\Contact" --prefix

```

### Pushing settings (Project ➡️ Algolia)

[](#pushing-settings-project-️-algolia)

The following command will read all the settings, synonyms and query rules from the files in `resources/algolia-settings/` and import them into Algolia's index.

```
php artisan algolia:settings:push "App\Contact"

```

You can also pass the `--prefix` option, just like the backup command.

### Customizing directory

[](#customizing-directory)

By default, settings, rules and synonyms are saved into the `resources/algolia-settings`. The directory can be customized by the defining an environment variable named `ALGOLIA_SETTINGS_FOLDER`. For example, the following command will save all the index resources into `resources/indexmeta`.

```
ALGOLIA_SETTINGS_FOLDER=indexmeta php artisan algolia:settings:backup

```

Testing
-------

[](#testing)

```
composer test
```

Need help?
----------

[](#need-help)

Feel free to open a thread on our [Community forum](https://discourse.algolia.com/)

### Contribute

[](#contribute)

Contributions are welcome!

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity7

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 84.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~65 days

Recently: every ~76 days

Total

6

Last Release

2905d ago

Major Versions

0.2.0 → 1.0.02017-10-19

1.0.1 → 2.0.02018-03-21

### Community

Maintainers

![](https://www.gravatar.com/avatar/9ce4288739722a543c862a594d786cb5ad9c81a7a1b24d2b9d73d2d47dcaa428?d=identicon)[aspitzer](/maintainers/aspitzer)

---

Top Contributors

[![julienbourdeau](https://avatars.githubusercontent.com/u/1525636?v=4)](https://github.com/julienbourdeau "julienbourdeau (39 commits)")[![taylornotwell](https://avatars.githubusercontent.com/u/78162749?v=4)](https://github.com/taylornotwell "taylornotwell (2 commits)")[![ChrisThompsonTLDR](https://avatars.githubusercontent.com/u/348801?v=4)](https://github.com/ChrisThompsonTLDR "ChrisThompsonTLDR (1 commits)")[![tomcoonen](https://avatars.githubusercontent.com/u/988013?v=4)](https://github.com/tomcoonen "tomcoonen (1 commits)")[![weotch](https://avatars.githubusercontent.com/u/77567?v=4)](https://github.com/weotch "weotch (1 commits)")[![skylerrichter](https://avatars.githubusercontent.com/u/24211861?v=4)](https://github.com/skylerrichter "skylerrichter (1 commits)")[![rayrutjes](https://avatars.githubusercontent.com/u/5570853?v=4)](https://github.com/rayrutjes "rayrutjes (1 commits)")

---

Tags

searchlaravelalgolia

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ubeeqo-laravel-scout-settings/health.svg)

```
[![Health](https://phpackages.com/badges/ubeeqo-laravel-scout-settings/health.svg)](https://phpackages.com/packages/ubeeqo-laravel-scout-settings)
```

###  Alternatives

[algolia/scout-extended

Scout Extended extends Laravel Scout adding algolia-specific features

4186.3M6](/packages/algolia-scout-extended)[jeroen-g/explorer

Next-gen Elasticsearch driver for Laravel Scout.

397612.3k](/packages/jeroen-g-explorer)[algolia/laravel-scout-settings

Import/Export Algolia settings into your Laravel Scout project

23396.9k](/packages/algolia-laravel-scout-settings)[mmanos/laravel-search

A search package for Laravel 5.

36475.7k1](/packages/mmanos-laravel-search)[zing/laravel-scout-opensearch

Laravel Scout custom engine for OpenSearch

33340.2k](/packages/zing-laravel-scout-opensearch)[gtk/larasearch

A driver based solution to searching your Eloquent models supports Laravel 5.2 and Elasticsearch engine.

133.9k](/packages/gtk-larasearch)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)