---
title: "Overview"
description: "What Auto Search Chips does, what it needs, and where to start."
---

> Documentation Index
> Fetch the complete documentation index at: https://auto-search-chips.mdick85.workers.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

`meirdick/auto-search-chips` turns a plain sentence into typed filters on an Eloquent model. The user types `videos by Ada above 10k views`. The text stays in the box. Under the box, three chips show how the package read it: `Type is Video`, `Author contains Ada` and `Views greater than 10,000`. The list filters. The user can remove any chip.

This version is 0.1. It is not released. The API can change before 1.0.

## What you get

- A search box that the user can read. Each chip shows one filter.
- A rules engine that works with no AI, no API key and no network.
- An optional AI engine that adds chips for words the rules did not explain.
- An allow-list of fields, operators and value types. The AI never writes SQL.
- A PHP API: `SearchChips::for()` and the `autoSearch` scope.
- A filter panel in the Livewire and React components. It shows the same filters as controls.

## Basic features

| Feature | Where to read more |
| --- | --- |
| Declare which fields are filterable | [Define fields](https://auto-search-chips.mdick85.workers.dev/docs/guides/define-fields/) |
| Register a model under an alias | [Register models](https://auto-search-chips.mdick85.workers.dev/docs/guides/register-models/) |
| Search from PHP | [Search in PHP](https://auto-search-chips.mdick85.workers.dev/docs/guides/search-in-php/) |
| Choose an engine | [Engines](https://auto-search-chips.mdick85.workers.dev/docs/concepts/engines/) |
| Use Cloudflare Clairic or a chat model | [AI engines](https://auto-search-chips.mdick85.workers.dev/docs/guides/ai-engines/) |
| Send keyword text through Laravel Scout | [Laravel Scout](https://auto-search-chips.mdick85.workers.dev/docs/guides/scout/) |
| Lock down the routes and fields | [Security](https://auto-search-chips.mdick85.workers.dev/docs/guides/security/) |

## Front ends

| Stack | Page |
| --- | --- |
| Livewire | [Livewire](https://auto-search-chips.mdick85.workers.dev/docs/frontend/livewire/) |
| Blade and Alpine | [Blade and Alpine](https://auto-search-chips.mdick85.workers.dev/docs/frontend/blade-alpine/) |
| Inertia with React | [React](https://auto-search-chips.mdick85.workers.dev/docs/frontend/react/) |
| Inertia with Vue | [Vue](https://auto-search-chips.mdick85.workers.dev/docs/frontend/vue/) |
| Inertia with Svelte | [Svelte](https://auto-search-chips.mdick85.workers.dev/docs/frontend/svelte/) |
| Your own UI | [Headless core](https://auto-search-chips.mdick85.workers.dev/docs/frontend/headless-core/) |

The Vue and Svelte components are not compiled or run in a starter kit yet. See [Limits](https://auto-search-chips.mdick85.workers.dev/docs/limits/).

## Requirements

- PHP 8.3 or later.
- Laravel 12 or 13. The package requires `illuminate/*` packages at `^12.0` or `^13.0`.

The test suite runs on PHP 8.3, 8.4 and 8.5 with Laravel 12 and 13, on SQLite. See [Limits](https://auto-search-chips.mdick85.workers.dev/docs/limits/) for what is not tested.

## Optional packages

| Package | Use |
| --- | --- |
| `livewire/livewire` (3 or 4) | The `<livewire:search-chips>` component |
| `laravel/ai` | The chat engine (`ai`) |
| `laravel/scout` | Keyword text and chips through Scout for `Searchable` models |
| `meirdick/laravel-cf-workersai` (1.3 or later) | The transport for the System One engine. It adds retries, failover and AI Gateway routing. |

The package does not require any of these.

## Next steps

- Install the package and run a first search with the [Quickstart](https://auto-search-chips.mdick85.workers.dev/docs/quickstart/).
- Learn the parts in [How it works](https://auto-search-chips.mdick85.workers.dev/docs/concepts/how-it-works/).
- See every setting in [Configuration](https://auto-search-chips.mdick85.workers.dev/docs/reference/configuration/).

Source: https://auto-search-chips.mdick85.workers.dev/docs/overview/index.mdx
