---
title: "Installation — Query Builder for Laravel | Roundly"
description: "Install via Composer, optionally publish the config and translations, and inspect the live wire contract with artisan about."
url: https://roundly-consulting.com/open-source/docs/query-builder-for-laravel/installation
language: en
---

[All packages](https://roundly-consulting.com/open-source.md)

[Query Builder for Laravel](https://roundly-consulting.com/open-source/docs/query-builder-for-laravel.md)

# Installation

Require the package. The service provider is auto-discovered and there is nothing to migrate — the package ships no migrations or models. It only reads the request and mutates a query builder your application owns:

```bash
composer require roundly-consulting/query-builder-for-laravel
```

The config file is optional — the shipped defaults are the intended wire contract. Publish it only to change parameter names, page-size bounds, unknown-parameter behaviour or request limits:

```bash
php artisan vendor:publish --tag="query-builder-config"
```

The two HTTP 400 error messages are translatable and ship in English and Slovak. Publish them to override the wording or add a locale:

```bash
php artisan vendor:publish --tag="query-builder-translations"
```

## Inspect the wire contract

The package contributes a section to php artisan about that prints the contract it is currently serving — parameter names, page-size bounds, unknown-parameter modes and limits:

```bash
php artisan about --only=query-builder
```

| Line | Default output |
| --- | --- |
| Filter parameter | `filter` |
| Sort parameter | `sort` |
| Page parameters | `page / per_page` |
| Page size | `20 default, 100 max` |
| Unknown filter | `REJECT` |
| Unknown sort | `REJECT` |
| Request limits | `50 value(s), 255 char(s), 5 sort(s)` |

Nothing in this section is secret: the config is the public wire contract a client already sends.

## Show your open-source love

This package is free and MIT-licensed. If it saves you time, a one-off donation or a Patreon membership keeps it maintained, tested and documented.

[More ways to support, including crypto](https://roundly-consulting.com/support-us.md)

By donating, you agree to our [donation terms](https://roundly-consulting.com/donation-terms.md).

[Support our open source work (opens in a new tab)](https://donate.stripe.com/dRmeVe8FX5PF1Qd9pXcEw00) [Join us on Patreon (opens in a new tab)](https://www.patreon.com/cw/roundly)

## Want this built into your product?

We integrate our packages into custom Laravel and AI builds. Tell us what you're working on and we'll reply within 48 hours.

[Get a quote in 48 hours](https://roundly-consulting.com/contact.md) [Browse all packages](https://roundly-consulting.com/open-source/docs/query-builder-for-laravel.md)