Installation

Require the runtime package with Composer, then run ui:install. The installer detects your Laravel version, Tailwind, Vite, Alpine, and Livewire setup, writes the asset entrypoints and configuration files into your project, and prints manual steps only when an automatic edit would be unsafe.

Requirements

• Laravel — any supported version; the installer reads app()->version() and reports it at setup time.
• Tailwind CSS v4 — detected via package.json dependencies, tailwind.config.js / tailwind.config.ts, or the string tailwindcss anywhere in your CSS entrypoint (e.g. @import 'tailwindcss').
• Vite — detected via vite.config.js / vite.config.ts or a vite entry in package.json. The installer wires imports automatically when a standard entrypoint is found.
• Alpine.js (optional) — detected via package.json; reported at install time and recorded in ui.json.
• Livewire (optional) — detected via composer.lock or composer.json; recorded in ui.json.

Quick start

composer require jml/brok

php artisan ui:install

php artisan ui:add button

php artisan ui:doctor

Pre-launch install

Because jml/brok is not on Packagist yet, point your app's composer.json at the package directory in this repo with a local path repository (this is exactly how apps/sandbox consumes it), then require it by name:

{
    "require": {
        "jml/brok": "^0.1"
    },
    "repositories": {
        "brok": {
            "type": "path",
            "url": "../../packages/ui",
            "options": { "versions": { "jml/brok": "0.1.0" } }
        }
    }
}

Adjust url to the relative or absolute path to packages/ui from your app, then install and run the CLI:

composer require jml/brok:^0.1
php artisan ui:install

The hosted registry is not live yet, so set BROK_REGISTRY_URL to a reachable endpoint (for example a locally built apps/docs-registry serving /r/open) before browsing or adding items:

BROK_REGISTRY_URL=http://localhost:8080/r/open

Once the package is published and the default registry URL resolves, the path repository and BROK_REGISTRY_URL override are no longer needed — the install collapses to the composer require jml/brok quick-start above.

Prerequisite details

• Tailwind CSS v4+ is required. Brok ships v4-only design-token CSS. Tailwind v3 (or an unconfirmable version) renders copied components unstyled. ui:install and ui:doctor warn loudly when v4 cannot be confirmed — see the Tailwind upgrade guide. ui:doctor is advisory on a fresh project and fails once components are actually installed against a non-v4 Tailwind.
• Alpine.js is required for interactive components. Anything with an x-data="uiX(...)" (e.g. dialog, dropdown, tabs) needs Alpine; Blade-only components work without it. If Alpine isn't installed or your JS entrypoint never calls Alpine.start(), ui:install warns and can wire the bootstrap for you:
  terminal Copy Copied!

  npm install alpinejs
  php artisan ui:install --alpine

  Or add the three bootstrap lines yourself if you prefer to control your entrypoint:
  resources/js/app.js JS Copy Copied!

  import Alpine from 'alpinejs';
  window.Alpine = Alpine;
  Alpine.start();

What ui:install generates

Every file is written only if it does not already exist, so rerunning the command is always safe. Files that differ from the package template are flagged with a warning rather than overwritten.