README

The Laravel language server provides framework-aware editor features for Laravel applications. It runs over stdio using the Language Server Protocol and powers completions, hovers, diagnostics, document links, definitions, and quick fixes for Laravel and Blade code.

Requirements

• PHP 8.2+
• Composer
• Laravel application - the server indexes framework data from the project root
• LSP-compatible editor or client - such as Sublime Text, Neovim, Cursor, or OpenCode

Installation

Install Laravel LSP globally with Composer:

composer global require laravel/lsp

Make sure Composer's global vendor bin directory is on your PATH, then run the server with:

laravel-lsp

From Source

Clone the repository and install dependencies:

gh repo clone laravel/lsp
cd lsp
composer install

You can run the server from source with:

php server

Setup Alias

To use the laravel-lsp command from anywhere, add an alias to your shell configuration:

For Zsh (macOS default):

echo 'alias laravel-lsp="php '$(pwd)'/server"' >> ~/.zshrc
source ~/.zshrc

For Bash:

echo 'alias laravel-lsp="php '$(pwd)'/server"' >> ~/.bashrc
source ~/.bashrc

Or manually add the alias to your ~/.zshrc or ~/.bashrc file:

alias laravel-lsp="php /path/to/lsp/server"

If you are using a downloaded standalone binary, make it executable and put it on your PATH instead:

chmod +x /path/to/server-vX.Y.Z-arm64-darwin
mv /path/to/server-vX.Y.Z-arm64-darwin /usr/local/bin/laravel-lsp

Quick Start

Configure - Point your editor or LSP client at the server command:

laravel-lsp

Open Laravel - Open a Laravel project root in your editor so the server can index routes, views, translations, config, and other project data.

Editor Usage

The server communicates over stdio. Configure your editor to launch the command from the Laravel project root whenever possible.

Sublime Text

Install the LSP package, then add a client configuration in Preferences: LSP Settings:

{
    "clients": {
        "laravel-lsp": {
            "enabled": true,
            "command": ["laravel-lsp"],
            "selector": "embedding.php | text.html.blade"
        }
    }
}

Neovim

Neovim 0.11+ is required. Add a custom LSP configuration:

vim.lsp.config("laravel_lsp", {
    cmd = { "laravel-lsp" },
    filetypes = { "php", "blade" },
    root_markers = { "artisan", "composer.json", ".git" },
})

vim.lsp.enable("laravel_lsp")

Cursor

Cursor supports VS Code extensions, so the simplest setup is to install the Laravel extension that bundles or configures Laravel LSP.

For local development against this repository, use a VS Code-compatible custom LSP extension or client and point it at:

laravel-lsp

OpenCode

Enable LSP support in opencode.json and add Laravel LSP as a custom server:

{
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
        "laravel-lsp": {
            "command": ["laravel-lsp"],
            "extensions": [".php", ".blade.php"]
        }
    }
}

Features

Configuration

Editor clients pass configuration through LSP initializationOptions.

The phpEnvironment option controls which PHP command is used when the server runs project data scripts. It accepts these values:

If detection fails, or an unknown value is provided, the server falls back to php.

Most feature providers can be enabled or disabled individually by passing boolean initialization options. For example:

{
    "routeCompletion": true,
    "routeDiagnostics": true,
    "viewDiagnostics": false,
    "translationHover": true
}

Common feature option suffixes are Completion, Diagnostics, Hover, and Link, such as routeCompletion, configDiagnostics, envHover, or bladeComponentLink.

Links

• Laravel
• Laravel LSP source