Installation

Requirements

• PHP 8.3 or higher
• Laravel 12 or higher

Install via Composer

For local use, Truss is a development and inspection tool, so install it as a dev dependency:

composer require albertoarena/laravel-truss --dev

The service provider is auto-discovered by Laravel. There is nothing to publish to get started.

Running on staging or production

A --dev install is excluded from composer install --no-dev builds, which is how most servers deploy. So a dev install never reaches a non-local server, and /truss returns 404 there. To run Truss gated on staging or production, install it as a regular dependency instead:

composer require albertoarena/laravel-truss

Then enable and authorize it as described in Authorization.

Publish the config (optional)

To customise Truss, publish its configuration file to config/truss.php:

php artisan vendor:publish --tag=truss-config

Every option is documented inline and has a sensible default. See the Configuration reference.

That is it

By default Truss is enabled in the local environment only. Start your app and open:

/truss

You should see your schema as an ER diagram. Head to the Quick start for a tour of the interface, or Authorization to run it safely in a non-local environment.

Note

Truss reads the live database connection, so make sure your app’s database is migrated and there is a schema to draw. If no connection is reachable, Truss falls back to replaying your migrations on an in-memory SQLite database and shows a banner saying so.