README

Automatically generate llms.txt and llms-full.txt for Laravel applications, making your site more accessible to AI models and LLM-powered tools.

What is llms.txt?

The llms.txt standard defines a simple Markdown file that helps AI models understand the structure and content of a website — similar to how sitemap.xml helps search engines. This package provides a fluent PHP API and an Artisan command to generate and serve these files from your Laravel application.

Requirements

PHP 8.2+
Laravel 10, 11, 12, or 13

Installation

Install via Composer:

composer require schaefersoft/laravel-llms-txt

The package is auto-discovered by Laravel. Publish the config file:

php artisan vendor:publish --tag=llms-txt-config

Configuration

After publishing, edit config/llms-txt.php:

return [
    // Enable/disable the dynamic /llms.txt and /llms-full.txt routes
    'route_enabled' => true,

    'llms_txt_route'      => '/llms.txt',
    'llms_full_txt_route' => '/llms-full.txt',

    // Cache the generated output
    'cache_enabled' => true,
    'cache_ttl'     => 3600, // seconds

    // Filesystem disk for static file generation (php artisan llms:generate)
    'disk' => 'public',

    // Localization
    'locales'         => ['de', 'en'],   // supported locales
    'localize_routes' => false,          // register /de/llms.txt etc.
];

Usage

Binding your LlmsTxt definition

The recommended approach is to bind your LlmsTxt instance in a service provider so it is available for both dynamic routes and the Artisan command:

// app/Providers/AppServiceProvider.php

use SchaeferSoft\LaravelLlmsTxt\Entry;
use SchaeferSoft\LaravelLlmsTxt\LlmsTxt;
use SchaeferSoft\LaravelLlmsTxt\Section;

public function register(): void
{
    $this->app->bind(LlmsTxt::class, function () {
        return LlmsTxt::create()
            ->title('SchaeferSoft')
            ->description('Web development and software agency')
            ->addSection(
                Section::create('Services')
                    ->addEntry(Entry::create(
                        'Web Development',
                        'https://schaefersoft.ch/services/web',
                        'Modern web applications with Laravel and Vue.js',
                    ))
                    ->addEntry(Entry::create(
                        'Hosting',
                        'https://schaefersoft.ch/services/hosting',
                        'Managed hosting and DevOps',
                    ))
            )
            ->addSection(
                Section::create('References')
                    ->addEntry(Entry::create(
                        'Our Projects',
                        'https://schaefersoft.ch/references',
                        'Overview of all client projects',
                    ))
            );
    });
}

Once bound, visiting /llms.txt returns:

# SchaeferSoft

> Web development and software agency

## Services
- [Web Development](https://schaefersoft.ch/services/web): Modern web applications with Laravel and Vue.js
- [Hosting](https://schaefersoft.ch/services/hosting): Managed hosting and DevOps

## References
- [Our Projects](https://schaefersoft.ch/references): Overview of all client projects

Extracting the binding into a dedicated service provider

As your LlmsTxt definition grows, you may want to move it out of AppServiceProvider into its own file. Create a dedicated provider:

php artisan make:provider LlmsTxtServiceProvider

// app/Providers/LlmsTxtServiceProvider.php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use SchaeferSoft\LaravelLlmsTxt\Entry;
use SchaeferSoft\LaravelLlmsTxt\LlmsTxt;
use SchaeferSoft\LaravelLlmsTxt\Section;

class LlmsTxtServiceProvider extends ServiceProvider
{
    public function register(): void
    {
        $this->app->bind(LlmsTxt::class, function () {
            return LlmsTxt::create()
                ->title('SchaeferSoft')
                ->description('Web development and software agency')
                ->addSection(
                    Section::create('Services')
                        ->addEntry(Entry::create(
                            'Web Development',
                            'https://schaefersoft.ch/services/web',
                            'Modern web applications with Laravel and Vue.js',
                        ))
                );
        });
    }
}

Then register it in bootstrap/providers.php:

return [
    App\Providers\AppServiceProvider::class,
    App\Providers\LlmsTxtServiceProvider::class,
];

Static file generation

Use the Artisan command to write static files to the public/ directory:

# Generate public/llms.txt
php artisan llms:generate

# Generate both public/llms.txt and public/llms-full.txt
php artisan llms:generate --full

# Generate for a specific locale (writes to public/de/llms.txt)
php artisan llms:generate --locale=de

# Generate for all locales defined in config
php artisan llms:generate --all-locales

# Combine flags
php artisan llms:generate --all-locales --full

Programmatic usage

You can also call the builder directly without binding it in the container:

use SchaeferSoft\LaravelLlmsTxt\Entry;
use SchaeferSoft\LaravelLlmsTxt\LlmsTxt;
use SchaeferSoft\LaravelLlmsTxt\Section;

$content = LlmsTxt::create()
    ->title('SchaeferSoft')
    ->description('Web development agency')
    ->addSection(
        Section::create('Services')
            ->addEntry(Entry::create('Web Development', 'https://schaefersoft.ch/services/web'))
    )
    ->render();

// Write to disk directly
LlmsTxt::create()
    ->title('SchaeferSoft')
    ->writeToDisk(); // writes to the configured disk as llms.txt

// Or specify a custom filename
LlmsTxt::create()
    ->title('SchaeferSoft')
    ->writeToDisk('custom/path/llms.txt');

Localization

Single binding, all locales

The cleanest approach is a single app()->bind() that uses Laravel's __() and route() helpers directly. Because bind() re-runs the factory on every resolution, and the package always sets app()->setLocale() before resolving your binding, every call automatically picks up the correct locale — no wrappers, no duplication.

// app/Providers/AppServiceProvider.php

use SchaeferSoft\LaravelLlmsTxt\Entry;
use SchaeferSoft\LaravelLlmsTxt\LlmsTxt;
use SchaeferSoft\LaravelLlmsTxt\Section;

public function register(): void
{
    $this->app->bind(LlmsTxt::class, function () {
        return LlmsTxt::create()
            ->title(__('llms.title'))
            ->description(__('llms.description'))
            ->addSection(
                Section::create(__('llms.sections.services'))
                    ->addEntry(Entry::create(
                        __('llms.entries.web_dev'),
                        route('services.web'),
                        __('llms.entries.web_dev_desc'),
                    ))
                    ->addEntry(Entry::create(
                        __('llms.entries.hosting'),
                        route('services.hosting'),
                        __('llms.entries.hosting_desc'),
                    ))
            );
    });
}

Create the corresponding lang files:

// lang/en/llms.php
return [
    'title'       => 'SchaeferSoft',
    'description' => 'Web development and software agency',
    'sections'    => ['services' => 'Services'],
    'entries'     => [
        'web_dev'      => 'Web Development',
        'web_dev_desc' => 'Modern web applications with Laravel and Vue.js',
        'hosting'      => 'Hosting',
        'hosting_desc' => 'Managed hosting and DevOps',
    ],
];

// lang/de/llms.php
return [
    'title'       => 'SchaeferSoft',
    'description' => 'Webentwicklung und Softwareagentur',
    'sections'    => ['services' => 'Leistungen'],
    'entries'     => [
        'web_dev'      => 'Webentwicklung',
        'web_dev_desc' => 'Moderne Webanwendungen mit Laravel und Vue.js',
        'hosting'      => 'Hosting',
        'hosting_desc' => 'Verwaltetes Hosting und DevOps',
    ],
];

That's it — one binding, all locales handled automatically.

Built-in locale-prefixed routes

Enable locale-prefixed routes in config/llms-txt.php:

'locales'         => ['de', 'en'],
'localize_routes' => true,

This registers /{locale}/llms.txt and /{locale}/llms-full.txt constrained to the locales you list:

/de/llms.txt → sets locale to de, renders German content
/en/llms.txt → sets locale to en, renders English content
Any unknown locale segment returns 404

Using with mcamara/laravel-localization

If you use mcamara/laravel-localization, disable the built-in routes and drop LlmsTxtController directly into mcamara's route group:

// config/llms-txt.php
'route_enabled'   => false,
'localize_routes' => false,

// routes/web.php

use SchaeferSoft\LaravelLlmsTxt\Http\Controllers\LlmsTxtController;

Route::group(
    ['prefix' => LaravelLocalization::setLocale(), 'middleware' => ['localize']],
    function () {
        Route::get('/llms.txt',      [LlmsTxtController::class, 'index']);
        Route::get('/llms-full.txt', [LlmsTxtController::class, 'full']);
    }
);

mcamara's localize middleware sets app()->getLocale() before the controller runs, so __() inside your binding returns the right language automatically.

Advanced: Closure-based fields

If you need to defer evaluation beyond container resolution (e.g. when using singleton() instead of bind()), all string fields accept a Closure:

LlmsTxt::create()
    ->title(fn () => __('llms.title'))
    ->addSection(
        Section::create(fn () => __('llms.sections.services'))
            ->addEntry(Entry::create(
                fn () => __('llms.entries.web_dev'),
                fn () => route('services.web'),
            ))
    );

Closures are evaluated lazily each time render() is called, so they always reflect the current app()->getLocale().

Writing locale-specific static files

LlmsTxt::create()
    ->title('SchaeferSoft')
    ->locale('de')
    ->writeToDisk(); // writes to de/llms.txt

Use the Artisan command to generate for all locales at once:

php artisan llms:generate --all-locales
php artisan llms:generate --all-locales --full

llms-full.txt

The extended llms-full.txt format fetches the content of each entry URL and appends it below the entry. This gives AI models access to the full text of each linked page.

$content = LlmsTxt::create()
    ->title('SchaeferSoft')
    ->addSection(
        Section::create('Services')
            ->addEntry(Entry::create('Web Development', 'https://schaefersoft.ch/services/web'))
    )
    ->renderFull(); // performs HTTP requests for each entry URL

// Or write directly to disk
LlmsTxt::create()
    ->title('SchaeferSoft')
    ->writeFullToDisk();

Entries whose URLs cannot be fetched are silently skipped.

Caching

When cache_enabled is true in config, the rendered output is cached using Laravel's cache system:

// Render and cache (uses the key 'llms-txt' by default)
$content = LlmsTxt::create()->title('SchaeferSoft')->getCached();

// Custom cache key
$content = LlmsTxt::create()->title('SchaeferSoft')->getCached('my-llms-cache-key');

// Flush the cache
LlmsTxt::create()->flushCache('my-llms-cache-key');

Output format

llms.txt

# Site Title

> Site description/tagline

## Section Name
- [Entry Title](https://url.com): Entry description

## Another Section
- [Entry Title](https://url.com): Entry description

llms-full.txt

Same as llms.txt, but the fetched content of each URL is appended below its entry line.

Testing

composer test

Changelog

Please see CHANGELOG for recent changes.

Contributing

Please see CONTRIBUTING for guidelines.

License

The MIT License (MIT). Please see License File for more information.

schaefersoft / laravel-llms-txt

Maintainers

Package info

Statistics

Security

README

What is llms.txt?

Requirements

Installation

Configuration

Usage

Binding your LlmsTxt definition

Extracting the binding into a dedicated service provider

Static file generation

Programmatic usage

Localization

Single binding, all locales

Built-in locale-prefixed routes

Using with mcamara/laravel-localization

Advanced: Closure-based fields

Writing locale-specific static files

llms-full.txt

Caching

Output format

llms.txt

llms-full.txt

Testing

Changelog

Contributing

License