PHPackages                             michelmelo/meilisearch-php - 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. [API Development](/categories/api)
4. /
5. michelmelo/meilisearch-php

ActiveLibrary[API Development](/categories/api)

michelmelo/meilisearch-php
==========================

PHP wrapper for the MeiliSearch API

03PHP

Since Mar 18Pushed 3y ago1 watchersCompare

[ Source](https://github.com/michelmelo/meilisearch-php)[ Packagist](https://packagist.org/packages/michelmelo/meilisearch-php)[ RSS](/packages/michelmelo-meilisearch-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

 [![MeiliSearch-PHP](https://camo.githubusercontent.com/ab08a659393c98c8fd2d4368d00bceaa24ac3e940ea6a69070c9abe498e0da40/68747470733a2f2f7265732e636c6f7564696e6172792e636f6d2f6d65696c697365617263682f696d6167652f75706c6f61642f76313538373430323333382f53444b732f6d65696c697365617263685f7068702e737667)](https://camo.githubusercontent.com/ab08a659393c98c8fd2d4368d00bceaa24ac3e940ea6a69070c9abe498e0da40/68747470733a2f2f7265732e636c6f7564696e6172792e636f6d2f6d65696c697365617263682f696d6167652f75706c6f61642f76313538373430323333382f53444b732f6d65696c697365617263685f7068702e737667)

MeiliSearch PHP
===============

[](#meilisearch-php)

####  [MeiliSearch](https://github.com/meilisearch/MeiliSearch) | [Documentation](https://docs.meilisearch.com) | [Slack](https://slack.meilisearch.com) | [Roadmap](https://roadmap.meilisearch.com/tabs/1-under-consideration) | [Website](https://www.meilisearch.com) | [FAQ](https://docs.meilisearch.com/faq)

[](#--meilisearch---documentation---slack---roadmap---website---faq)

 [![Latest Stable Version](https://camo.githubusercontent.com/ac00e69993e9172d34edc09ade09894eb5f1c5c7736c76b352ac428d33e85952/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d65696c697365617263682f6d65696c697365617263682d706870)](https://packagist.org/packages/meilisearch/meilisearch-php) [![Test](https://github.com/meilisearch/meilisearch-php/workflows/Tests/badge.svg)](https://github.com/meilisearch/meilisearch-php/actions) [![License](https://camo.githubusercontent.com/221ae99f391396653ec4cf4158e721ec628894184f54dd612610bb095a02125c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d696e666f726d6174696f6e616c)](https://github.com/meilisearch/meilisearch-php/blob/main/LICENSE) [![Bors enabled](https://camo.githubusercontent.com/203d2b5ff5b042e964812f6af35b8856f889051d5455f18184e369e8fb49c821/68747470733a2f2f626f72732e746563682f696d616765732f62616467655f736d616c6c2e737667)](https://app.bors.tech/repositories/28780)

⚡ The MeiliSearch API client written for PHP 🐘

**MeiliSearch PHP** is the MeiliSearch API client for PHP developers.

**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)

Table of Contents
------------------

[](#table-of-contents-)

- [📖 Documentation](#-documentation)
- [🔧 Installation](#-installation)
- [🚀 Getting Started](#-getting-started)
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
- [💡 Learn More](#-learn-more)
- [🧰 HTTP Client Compatibilities](#-http-client-compatibilities)
    - [Customize your HTTP Client](#customize-your-http-client)
- [⚙️ Development Workflow and Contributing](#%EF%B8%8F-development-workflow-and-contributing)

📖 Documentation
---------------

[](#-documentation)

See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).

🔧 Installation
--------------

[](#-installation)

To get started, simply require the project using [Composer](https://getcomposer.org/).
You will also need to install packages that "provide" [`psr/http-client-implementation`](https://packagist.org/providers/psr/http-client-implementation) and [`psr/http-factory-implementation`](https://packagist.org/providers/psr/http-factory-implementation).
A list with compatible HTTP clients and client adapters can be found at [php-http.org](http://docs.php-http.org/en/latest/clients.html).

**If you don't know which HTTP client to use, we recommend using Guzzle 7**:

```
composer require meilisearch/meilisearch-php guzzlehttp/guzzle http-interop/http-factory-guzzle:^1.0
```

Here is an example of installation with the `symfony/http-client`:

```
composer require meilisearch/meilisearch-php symfony/http-client nyholm/psr7:^1.0
```

💡 *More HTTP client installations compatible with this package can be found [in this section](#-http-client-compatibilities).*

### Run MeiliSearch

[](#run-meilisearch-)

There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).

For example, if you use Docker:

```
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
```

NB: you can also download MeiliSearch from **Homebrew** or **APT**.

🚀 Getting Started
-----------------

[](#-getting-started)

#### Add documents

[](#add-documents-)

```