Skip to main content
Adding Geni to your Laravel project takes two commands: one to pull the package via Composer, and one to publish the configuration file. There is no database setup, no environment variable required, and no application boot at install time.

​
Requirements

Before installing, confirm your environment meets the following minimum versions:

​
Install via Composer

Run the appropriate Composer command for your use case:
Install Geni as a standard dependency when you want to serve the interactive documentation portal in non-local environments such as staging or behind an authenticated intranet. Install it as a --dev dependency when you only need it for CLI exports (geni:export) and CI drift detection (geni:check) — in that case, Geni never ships to your production image.

​
Publish the configuration file

Publish Geni’s default configuration to your project:
This creates config/geni.php in your project. Open that file to customise:
  • Route prefixes for the docs portal and JSON specification endpoints
  • Documentation title and branding displayed in the portal
  • Security schemes such as Bearer tokens or API keys
  • Authentication for the portal itself (form-based login or HTTP Basic)
  • Multi-version API definitions and the version-switcher dropdown
The default configuration works out of the box for standard Laravel applications. You only need to edit config/geni.php when your project uses non-default route prefixes, requires portal authentication, or serves multiple API versions.

​
Next steps

Quickstart Guide

Browse your auto-generated documentation portal, export your first OpenAPI file, and set up CI drift detection.